PHP版レガシーコード改善に役立つ新パターン #wewlc_jp
69 likes42,210 views
9/27に行われたレガシーコード改善勉強会で発表された資料です。 http://passmarket.yahoo.co.jp/event/show/detail/01pitgwzj67m.html
PHP版レガシーコード改善に役立つ新パターン #wewlc_jp
- 1. PHP版レガシーコード改善に 役立つ新パターン ヤフー株式会社 佐藤祐司 2014/9/27 レガシーコード改善勉強会 #wewlc_jp
- 2. 自己紹介 佐藤 祐司 • 2010年新卒入社 • Webエンジニア • PHP @kuidaoring
- 3. 今日話すこと • 私の業務とレガシーコード • パターンの紹介 • これで幸せになれるのか
- 4. 今日話すこと • 私の業務とレガシーコード • パターンの紹介 → 本日のメイン • これで幸せになれるのか
- 5. 今日話すこと • レガシーコード改善の具体的な リファクタリングの具体的な方法 • 今あるコードを何とかテストで保護して、 自分が手を加える部分のテストを 書けるようにしたい
- 6. 今日話すこと • レガシーコード改善の具体的な リファクタリングの具体的な方法 • 今あるコードを何とかテストで保護して、 自分が手を加える部分のテストを 書けるようにしたい
- 7. 私の業務とレガシーコード
- 9. サービス サービス規模 • 58.3億PV / 月 • 1.4億UB / 月 出典：Yahoo! JAPAN 媒体資料 2014年6月改訂版 (PDF) http://i.yimg.jp/images/marketing/portal/paper/media_sheet_open.pdf
- 10. サービス トップページを作る部署の中の一つ PJメンバー約40名 • 開発約20名 PCスマホアプリ… ここ
- 11. 業務とレガシーコード こんなことありませんか？ • 少ない自動テスト • リリース当時の開発メンバーはゼロ • どんどん開発メンバーが増える どうしてこんなふうになったのか
- 12. 新規リリース時 まずはローンチを目指す • ローンチ、リリース優先 • ヒットするかはわからない ローンチだ！
- 13. リリース後 サービスの成長を目指す • 機能を増やす • メンバーも少しづつ増える 機能追加だ！
- 14. ある程度成熟して振り返ると • メンバーの入れ替わり • 歴史的経緯によるコード • 場当たり的な修正 とりあえず 直しました…！ 今⽇日からよろしく お願いします！
- 15. 業務とレガシーコード • その時の判断が間違いだったかは わからない • 優先順位の話 • ただしずっとそのままでいい というわけではない
- 16. 業務とレガシーコード 過去には一部似た状況になったが、 • 有志による改善活動 • 社内でもノウハウがたまってきた
- 17. ユニットテスト拡充 CI整備
- 18. 開発フロー整備
- 19. 業務とレガシーコード どうしたか • レガシーコードを地道に改善 • レガシーコードを作りにくくする 仕組みや体制を整備 地道に少しづつ改善を進めた
- 20. パターンの紹介
- 21. パターンの紹介 • レガシーコード改善の具体的な リファクタリングの具体的な方法 • 今あるコードを何とかテストで保護して、 自分が手を加える部分のテストを 書けるようにしたい
- 22. PHPって • Webに特化 • 置けば動く • HTMLに埋め込める • テンプレートエンジン • 標準関数が豊富
- 23. PHPにおけるレガシーコード • 環境に依存 • 構造を持たない • スーパーグローバル変数 • $_GET, $_POST, $_SESSION など • 不用意なexit
- 24. PHPにおけるレガシーコード サンプルコードを用いて説明 • adminユーザと一般ユーザで見せる メニューを変更する
- 26. どう対応するのか 1. テストを書けるようにする 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 27. どう対応するのか 1. テストを書けるようにする 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 28. なにが問題になるか • DBに接続する • exitでスクリプトが終了 • getパラメータが必要 • ビューとロジックの混在
- 29. DBに接続
- 30. exitで終了
- 32. ビューとロジックが 混在
- 34. • 関数オーバーライド • ラップ関数
- 35. 関数オーバーライド
- 36. 関数オーバーライド • 名前空間を使って組み込み関数などを 上書き • 実際には上書きしてない • 元ネタ PHPでネイティブ関数を含むコードのテスタビリティを上げる２つの方法 - 絶品ゆどうふのタレ http://yudoufu.hatenablog.jp/entry/20110808/1312828535 • 名前空間が接合部になる
- 37. 関数オーバーライド index.php func() 外部 リソース プロダクトコード
- 38. 関数オーバーライド index.php func() 外部 リソース プロダクトコード func() テストコード
- 39. 接合部 接合部とは、その場所を直接変更しなくて も、プログラムの振る舞いを変えることの 出来る場所である レガシーコード改善ガイドより
- 42. 名前空間 PHP5.3から導入 PHP: 名前空間 ‒ Manual http://php.net/manual/ja/language.namespaces.php 他の言語のパッケージやモジュールに相当
- 43. 名前空間 名前空間の影響を受けるもの • class • interface • trait(5.4以降) • 関数 • 定数(const)
- 44. 定義
- 45. 参照
- 46. 名前空間 • 名前空間の中であれば、 組み込み関数やグローバルな関数と 同じ名前の関数を定義できる • 同じ名前空間内であれば、 名前空間の指定を省略できる
- 49. 名前空間内の関数が 呼ばれる
- 50. 関数オーバーライド どういう時に有効か • 上書きしたい対象が関数でしか 用意されていない 外部の影響を受ける組み込み関数を そのまま使っている場合など
- 51. ラップ関数
- 53. どう対応するのか
- 54. なにが問題になるか • DBに接続する • exitでスクリプトが終了 • getパラメータが必要 • ビューとロジックの混在
- 55. どう対応するのか 1. テストを書けるようにする • 環境の分離 • スーパーグローバル変数の間接参照 • exitの検討 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 56. どう対応するのか 1. テストを書けるようにする • 環境の分離 • スーパーグローバル変数の間接参照 • exitの検討 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 57. 環境の分離 テスト実行時にもDBに接続しにいってしま う • DBに接続する関数をなんとかしたい • 関数オーバーライドを使う
- 58. 環境の分離 1. テスト対象のスクリプトに 名前空間の定義を追加 2. テストコードでテスト対象と 同じ名前で名前空間の定義を追加 3. 上書きしたい関数と同じ名前の 関数をテストコードで定義
- 59. 環境の分離 1. テスト対象のスクリプトに 名前空間の定義を追加 2. テストコードでテスト対象と 同じ名前で名前空間の定義を追加 3. 上書きしたい関数と同じ名前の 関数をテストコードで定義
- 61. 環境の分離 1. テスト対象のスクリプトに 名前空間の定義を追加 2. テストコードでテスト対象と 同じ名前で名前空間の定義を追加 3. 上書きしたい関数と同じ名前の 関数をテストコードで定義
- 64. 環境の分離 1. テスト対象のスクリプトに 名前空間の定義を追加 2. テストコードでテスト対象と 同じ名前で名前空間の定義を追加 3. 上書きしたい関数と同じ名前の 関数をテストコードで定義
- 67. 関数オーバーライド プロダクトコード index.php db_get_user() DB
- 68. 関数オーバーライド プロダクトコード index.php テストコード db_get_user() DB db_get_user()
- 70. 名前空間の定義を 追加
- 71. 参照できなくなる
- 72. 名前空間の影響 どうするか • 関数を名前空間の外に再定義
- 74. どう対応するのか 1. テストを書けるようにする • 環境の分離 • スーパーグローバル変数の間接参照 • exit, dieの検討 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 75. スーパーグローバル変数 変数なので代入して書き換えが可能 • 他のテストケースに影響してしまう • 変数を直接参照しなければいい • ラップ関数を使う
- 77. どう対応するのか 1. テストを書けるようにする • 環境の分離 • スーパーグローバル変数の参照 • exitの検討 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 78. exitの検討 exitのなにが問題になるか • スクリプトを終了 PHPUnit自体も終了する • exitは関数ではない
- 81. 実行されない
- 83. exitの検討 exitは言語構造、予約語 • 名前空間内でも「exit」という 名前の関数を定義できない • 「関数オーバーライド」が使えない
- 84. exitの検討 どうするか • returnの代わりに使ってませんか • returnに変える • exitする部分をラップ関数にする • その後に関数オーバーライドを使う
- 87. どう対応するのか 1. テストを書けるようにする 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 88. テスト • ビューとロジックが混ざっているので ロジックのみの検証はおそらく不可能 • 条件によって変わるビューを検証する • assertRegex, assertContains • HTMLであればassertTagなど
- 89. どう対応するのか 1. テストを書けるようにする 2. テストで保護する 3. リファクタリング 4. テスト、リファクタリングを繰り返す
- 90. リファクタリング まずはベタなものを適切な単位に分離 • ファイルを分離 • 関数に分離 • クラスに分離
- 91. 課題 globalが邪魔をする • グローバル変数ではなくなる ことによってうまく動作しなくなる • 「コンパイラまかせ」が使えないので 動かすまでわからない
- 92. 課題 • 関数内でグローバル変数を参照している 部分を引数に置き換えるように リファクタリングする • 地道に。。。 • 参考 テスト不能な PHP コードをリファクタリングするための戦略 http:/www.ibm.com/developerworks/jp/opensource/library/os-refactoringphp/
- 93. これで幸せになれるのか
- 94. これで幸せになれるのか これだけで根本解決はできない • とりあえずテストは書けるようになった • 適用できるケースは それほど多くない(かも) • 今回は「今」できること
- 95. レガシー 小改善 テストで 保護 リファクタ リング イケてる
- 96. これで幸せになれるのか 全体を考えて設計の変更などを 行う必要がある • フラットなPHPからフレームワークへ • 地道にテストコードを増やしていく 継続的な改善が必要
- 97. ありがとうございました