YAGNIのお話

9/26 php勉強会@東京

Transcript

1. YAGNIのお話 9/26 PHP勉強会@東京 前田 和人
2. PHPConference2018 スピーカー募 集中です！
3. 自己紹介 ▪ 前田 和人 ▪ @chiroruxxxx ▪ 弁護士ドットコム株式会社
4. みなさんYAGNI知っていますか？
5. YAGNI実践してますか？
6. 今回の内容 ▪ 私は、なるべくYAGNIを心がけていますが・・・ ▪ 結構むずかしい！ ▪ 実際に開発していて、自分でハマりかけたYAGNIポイントを2つお伝えしてい きます！ ▪ 熟練者の皆様はマサカリの準備をお願いいたします
7. ちなみにYAGNIとは ▪ “You ain’t gonna need it” ▪ (どうせ要らないって！) ▪ 機能は実際に必要になるまで追加しないほうが良い ということ – 後で使う予定の機能の90%は実際に使用されない
8. 実例
9. 実例 ▪ CSVのダウンロード機能を新規に実装したい ▪ 別データのCSVダウンロード機能はすでに2つ存在している – しかも別々の実装で！ ▪ ⇒CSVダウンロードの機能を1つにまとめ、かつ新規の機能も実装する
10. とりあえず共通化 class CsvBuilder{ public function build($items, array $header): string { $stream = fopen('php://temp', 'w'); fputcsv($stream, $header); foreach ($items as $item) { fputcsv($stream, $item->toCsvRow()); } rewind($stream); return stream_get_contents($stream); } }
11. エンコーディング
12. エンコーディング ▪ 既存のCSVダウンロードの機能はUTF-8で出力している ▪ 新規に作るものは Shift-JISで出力してほしいらしい ▪ ⇒引数でエンコーディングをとればいんじゃね。汎用性ありそうだし ▪ 本日のYAGNIポイントその1 public function build( $items, array $header, string $to = 'SJIS’, string $from = ‘UTF-8’ ): string{/* … */}
13. YAGNIポイント1 ▪ そもそもデフォルトの文字コードがUTF-8から外れるようなシステムではない ▪ エンコーディング先もShift-JISにするか、そのままのどちらかしか現状は考え られない ▪ 考えることがいっぱいありそう – fromとtoが同じ場合でもmb_convert_encoding走らせるの？ – 不正な文字コードが来た場合は？ ▪ ⇒今回のケースでは、「エンコードを変換するか？」だけ指定できれば良かっ たことに気づく
14. YAGNIポイント1 public function build($items, array $header, bool $convert = false): string { $stream = fopen('php://temp', 'w'); fputcsv($stream, $header); foreach ($items as $item) { fputcsv($stream, $item->toCsvRow()); } rewind($stream); $contents = stream_get_contents($stream); if ($convert) { return mb_convert_encoding($contents, 'SJIS', 'UTF-8'); } return $contents; }
15. ヘッダー
16. ヘッダー ▪ 今回は人がエクセルで読むようなCSVを作る ▪ 機械が読む場合、ヘッダー(タイトル)行は不要な場合は多い ▪ どちらにも対応できるように、ヘッダーは設定なしにできるほうがいいのか？ public function build($items, array $header = [], bool $convert = false): string { // ... if (count($header) > 0) { fputcsv($stream, $header); } // ... }
17. YAGNIポイント2 ▪ 作ったところでいったいいつ使われるのか・・・ ▪ 保守性が下がる – 「機械が読めるように処理が工夫されている」 – ⇒「このCSVで外部連携されてる可能性が高い」 – ⇒「変更するなら調査せねば」 – ⇒「・・・外部連携されてないじゃないか！」 ▪ 今回のケースでは、コードの修正なし
18. まとめ
19. YAGNIとは ▪ “You ain’t gonna need it” ▪ (どうせ要らないって！) ▪ つまり、実装のコスト支払いをできる限り遅らせる取り組み ▪ XPのスローガンの「なんとか動いて、最も無駄のないものを作れ」を支えるプ ラクティスのひとつ
20. YAGNIをするとどうなるか ▪ 無駄な抽象度がなくなる – コードが限定的になり読みやすくなる ▪ ユニットテストがシンプルになる ▪ コード量が無駄に増えない – “コードをできるだけ小さく軽量に維持すること”(リーダブルコード)
21. YAGNIポイント ▪ 以下のようなものを作ろうとしたときには「本当に必要？」と自問しよう – フレームワーク – 再利用可能なコンポーネント – フレキシブルな設計 ▪ エンジニアはキラキラした言葉に踊らされやすい ▪ パターンが使えるときも注意 – 必要ないのにコンストラクタインジェクションしてるコードはよく見かけ る ▪ ⇒本当に価値のあるものを作ろう