社内勉強会のライトニングトークで用いた資料です。 プログラマ一年生を対象にしています。

1. 10分で分かるReadability & SoC
もっと早く知りたかった
プログラミング技法9選
Bizer株式会社 秋山雅之 2019/5/31
Twitter @aki202

2. ● 秋山 雅之
● 1990/05/23
● コンピュータ
計算機科学
StarWars
自己紹介

3. - Readability 可読性
- SoC 関心の分離

4. Readability - 可読性

5. // Good
function f(a, b) {
if (!a) return false
if (!b) return false
return true
}
// Bad
function f(a, b) {
if (a) {
if (b) {
return true
}
}
return false
}
#1 Guard Clause Readability

6. // Good
const price = 100
function orderProduct() {
Request.send({
price
})
}
const result = orderProduct()
let shouldSendEmail = true
let sendSilently = true
let usersAreLoaded = false
// Bad
const number = 100
function submit() {
Request.send({
price: number
})
}
const r = submit()
let sendEmail = true
let sendSilent = true
let loadUsers = false
#2 表現的命名 Readability

7. // Bad
const sho = {
familyName: 'Sato',
firstName: 'Sho',
hobby: 'Reading'
}
// Good
const sho = {
familyName: 'Sato',
firstName: 'Sho',
hobby: 'Reading'
}
#3 インデント Readability

8. // Bad
if (params['u'].split(/:/)[0] == 'admin') {
// This is admin user
}
#4 説明変数 Readability
// Good
const username = params['u'].split(/:/)[0]
if (username == 'admin') {
// This is admin user
}

9. SoC - 関心の分離
Separation of concerns

10. ● 「１つのことをうまくやれ」
● UNIXでは個々のプログラムを分解不可能な
粒度まで小さくしている。複雑な処理を行な
うときは、それら小さいプログラムをパイプ
（｜）で連結し実現する。
#5 Do one thing well SoC

11. ● 例：CDの.jsonファイルの個数を出力
$ ls -l | grep '.json$' | wc -l
4
● ls -l … カレントディレクトリのファイル一覧表示
● grep '.json$' … 拡張子が.jsonのファイルを抽出
● wc -l … 行数（ファイル数）を計算
#5 Do one thing well SoC

12. ● Unixだけの話ではなく、多くのソフトウェア設
計に適用できるアイデア
● 手続き型→オブジェクト指向型もこのアイデア
● Monolithic kernelが死んでMicro kernelが生き残
った理由もこのアイデア
● Node Package, GEM, Single page application,
Micro services, Docker, Atomic designも全てこの
アイデア
#5 Do one thing well SoC

13. #6 Fat model, skinny controller
● Model層にビジネスロジックを集め、
Controller層は薄く保つ
● ControllerはModelやService(後述)のメソッド
を叩き、自身にビジネスロジックを持たない
SoC

14. #6 Fat model, skinny controller SoC
# Good(users_controller.rb)
def create
user = User.create!(params)
user.sendmail
end
# Bad(users_controller.rb)
def create
user = User.create!(params)
mailer = Mailer.new
mailer.to = …
if (user.admin?) then
mailer.subject = …
else
mailer.subject = …
end
mailer.send
end

15. #7 mix-in
● クラス内のメソッドを外部module化する
● Rubocopのデフォルト設定では100行を超え
るクラス定義にWarningが出る
● RailsではActiveSupport::Concernを継承した
moduleをincludeしてmix-in可能
SoC

16. # Bad
class Issue < ApplicationRecord
validates :title, presence: true
validates :code, presence: true
def notify_to_workers; # 通知の実装 end
end
#7 mix-in SoC
# Good
class Issue < ApplicationRecord
include Issues::Validatable
include Issues::ForWorkersNotificable
...
end

17. #8 修飾子 SoC
● カプセル化 = 閉じたプログラムの外からは、
必要最低限のデータや操作にだけアクセスを
許可すること（隠蔽化）
● クラスの場合、外からは必要最低限のメソッ
ドしかコールさせたくない
● メソッドに適切な修飾子をつけることで簡易
的にカプセル化できる

18. # Bad
class UserInviter
def add(new_user)
add_to_db(new_user)
notify(new_user)
...
end
def add_to_db; end
def notify; end
end
# Good
class UserInviter
def add(new_user)
add_to_db(new_user)
notify(new_user)
...
end
private
def add_to_db; end
def notify; end
end
#8 修飾子 SoC

19. ● MVCのいずれのLayerにも該当しないビジネ
スロジックは独立したクラスとして実装した
方が「テスト容易性」「再利用性」「カプセ
ル性」の面で良いときがある
● あるいは複数のModelが相互作用するような
ビジネスロジックのとき
#9 Service layer SoC

20. # Bad 送金処理（models/concerns/users/payable.rb）
receiver = User.find(params[:target_id])
sender = User.find(params[:sender_id])
sender.bank.minus(params[:price])
receiver.bank.add(params[:price])
Log.create!(receiver, sender, params[:price])
#9 Service layer
# Good 送金処理（models/concerns/users/payable.rb）
transfer = Transfer.new(params[:target_id],
params[:sender_id], params[:price])
result = transfer.do
SoC

21. ● Readable, SoCに属する属さないに関わらず
Better Programmingのための概念は色々ある
● DRY(Don't repeat yourself)原則
● SOLID原則 - OOPの底流にある5つの原則
● YAGNI(You ain't gonna need it)
● GoFのデザインパターン
● etc...
#10 他にも色々...