Share
Embed
2022年度新卒技術研修「良いコードの書き方」講義
良いコードの定義を「読みやすいこと、拡張しやすいこと、安全なこと」の3つにしぼって解説したコーディングに関する講義です。
Transcript
48 slides
-
原則 Keep It Simple! Stupid. (KISS) コードを書くとき最優先の価値を「単純性」「簡潔性」に置きます。 - 新しく覚えた技術を使いたい -
将来の必要に備えたい(YAGNI) - 勝手に用件を加えてしまう といったことを避けましょう。 機能が同じであれば, 余計なコードを含まないコードの方が優れています。 7 -
原則 Don’t Repeat Yourself. (DRY) 同じ知識(コード)を重複して書いてはいけません。 重複はコード量を増やし, 理解を妨げ, 変更の難易度をあげます。 知識(コード)を抽象化しましょう。
単にコードをそのまま説明しているコメントも重複です。 オブジェクト指向や設計, デザインパターンといった技術はコードの重複の排除を目的の 1つにしています。 8 -
原則 You Aren’t Going to Need It. (YAGNI) コードは「多分必要になるだろう」で書いてはいけません。 色々な事態に備えてコードを盛り込んでおいても使われないことがほとんどです。逆に
時間が経つとなぜ使われないコードがあるのかわからなくなります。 汎用性よりも単純性を考え, コードは「今」必要なものに留めましょう。 仮に要件が増えて拡張することになっても, 単純なコードを変更する方が, 汎用的で複雑 なコードを変更するよりも簡単です。 9 -
原則 Open Closed Principle (OCP) コードの振る舞いを拡張してもその他のコード(クラスやモジュール)には全く影響を受け ないようにしましょう。 ソフトウェアの寿命は想定よりも長くなる傾向にあります。柔らかい設計を意識しましょ う。 そのためにはポリモーフィズムが重要です。
オブジェクト指向と手続き型の違いはここへの対処と言い切ってる書籍もあるくらいで す。(Robert C. Martin著, 角 征典・高木 正弘訳, Clean Archetecture 達人に学ぶソフトウェアの構造と設計, 株式会社ドワンゴ, 2018) 10 -
思想 テスト容易性 コードはテストをしやすいように書きましょう。 ポイントはモジュール間の依存関係の排除です。 テストのしやすさを意識することで - 他クラスへの影響が減り - 責務がわかりやすく -
呼び出し側が使いやすい コードになります。 11 -
視点 結合度 目指すべきモジュールの状態は, 他モジュールの改修によって影響を与えられることな く, また他モジュールにロジックを知られていない状況です。 これによって, 変更の影響を大きくしない効果が生まれます。 以下のことに気をつけましょう。 -
public宣言したデータの参照 - 使う側がロジックを知っているような実装 - 不必要なデータを含むパラメータ 14 -
視点 冪等性 何度同じ処理をしても同じ状態を保つべきということです。 例えばコードは次のようなことを満たすべきでしょう。 - 途中で落ちたプログラムを再実行しても正常終了の場合と同等の結果になる - 何度APIへ同じリクエストをしても同じリソース状態となる - 同じバッチを何度実行してもDBやS3は同一の状態に保たれる
これによって安全性が上がります。安全なコードは気軽に実行できます。 気軽に実行できるとリファクタリングがしやすくなり, コードは綺麗に保てます。 15 -
まとめ 今回紹介したプリンシプルを簡単に意訳すると - シンプルにする - 重複させない - 将来の予測をしない - 他へ追加変更の影響を及ぼさないようインターフェースを使う
- 処理を分岐させない - テストしやすいように書く - クラスは機能単位でまとめて各機能は他機能を参照しない - どのタイミングで何度実行しても同じ状態となるようにする 16 -
命名 意識すべきこと 変数, 関数, クラス名は次の大命題に応える必要があります。 - なぜそれをするのか - 何をするのか -
どのように使用するのか もし名前に解説が必要なら, その名前は意図が明確とは言えません。 20 -
命名 ニュアンス ニュアンスや意味に気を遣いましょ う。 「取得する」だけでも, get, find, factory, popなど複数の言い回しが あります。
DataやInfoなど意味のない語彙は避 けましょう。 22 -
命名 長い名前 推奨はされませんが, あやふやな短い名前よりも優れています。 名前が長くなってしまう時は以下を見直してみましょう。 - 処理を名前にしていないか?-> 抽象的な名前をつけましょう。 - コンテキストは適切か?->名前空間やクラス名を見直しましょう。
- 多くのことを関数が行っていないか?-> 関数を分割してみましょう。 24 -
コメント Docコメントの無くし方 29 /** * idのユーザーを DBから取得する * * @access
public * @params int $id 検索用のユニークな ID * @return User $user ユーザーオブジェクト **/ public function get($id) { } public function findById(UserId $user_id) : User { } -
コメント インラインコメントの無くし方 30 // 名前は20文字以内であるべき if (length($name) <= 20) {
return false; } // 生年月日の月は 1~12のうちのいずれかであるべき if ($month >= 1 && $month < 12) { return false; } if (isInvalidNameLenght($name)) { return false; } if (isInvalidMonth($month)) { return false; } -
コメント 許されるコメント 以下のようなコメントは許されます。 - 意図を示す - なぜそう書かなければならなかったのかを示す - 警告する というのは英語圏の書籍の主張です。
基本的には賛成ですが, 英語のコードを読むのは基本的に辛いです。 コメントすることで理解の負担や時間を減らせるのであればヨシです。 31 -
条件分岐 条件の関数化 if ($user.type === 'child') { } if ($user.isChild())
{ } 33 まずは条件を関数化してみましょう。 例として大人と子供という区分を作って関数化してみます。 これはuser.typeをprivateにすることで防げるという見方もできます。 カプセル化を緩めるとこのように外部にロジックが漏れる危険性があります。 ※とは言え, getterを全く持たないことも不可能です。 -
条件分岐 早期リターン else句はコードを複雑にします。早期リターンを使って無くしましょう。 大人と子供の料金を返す関数を例としてみます。 private function fee(User $user) : int
{ if ($user.isChild()) { return 100; } else { return 200; } } private function fee(User $user) : int { if ($user.isChild()) { return 100; } return 200; } 34 -
条件分岐 ポリモーフィズム interfaceを使ってif文を無くします。 これで線形原理が実現できました。 interface User { public function fee()
: int; } class Child implements User { public function fee() : int { return 100; } } class Adult implements User { public function fee() : int { return 200; } } 35 private function fee(User $user) : int { if ($user.isChild()) { return 100; } return 200; } $user.fee(); -
条件分岐 ポリモーフィズム ポリモーフィズムを使えば新しい区分の追加もクラスの追加のみです。 ちなみに, 生成はFactoryクラスで分岐させるようにします。 これはOCPも満たしています。 36 class Baby implements
User { public function fee(): int { return 0; } } public static function factory(string $type) : User { $types = [ 'baby' => new Baby(), 'child' => new Child(), 'adult' => new Adult(), ]; return $types[$type]; } 生成してもらう -
関数 小さくする 関数に関してはこれが全てです。 そのためには - 関数内では1つのことを行う - switch文をなるべく避ける - 引数は0もしくは1,
最高でも3つまで - フラグ引数を避ける 39 -
オブジェクト指向 ポリモーフィズム ポリモーフィズムとは条件分岐部分でみたように, 様々な区分を同じ型で扱え, 同一型で の関数の存在を保証したものです。 インターフェースを使うことで実現できます。 これはOCPと線形原理を可能にすることを説明しました。 もう一つ, ポリモーフィズムはテスト容易性にも深く関わっています。
これを説明するには依存とDIを説明しないといけないのですが, それはClean Architectureの講義でやると思うのでこのスライドではパスします。 44 -
参考文献 [1] Dustin Boswell Trevor Foucher著 角 征典訳, リーダブルコード より良いコードを書くためのシンプルで実践的なテクニック
, O’REILLY, 2012 [2] Robert C. Martin著 花井 志生訳, Clean Code アジャイルソフトウェア達人の技 , ASCII DWANGO, 2017 [3] 上田 勲, The Principles Of Programming 3年目までに身につけたい一生役立つ 101原理原則, 秀和システム, 2016 [4] 増田 亨, 現場で役立つシステム設計の原則 変更を楽で安全にするオブジェクト指向の原則技法 , 技術評論社, 2017 48