リファクタリングで実装が○○分短縮した話

【タガヤス その13】ILの日常業務から 発表資料

https://tagayas.connpass.com/event/145290/

Transcript

1. リファクタリングで実装が◦◦分短縮した話
2. 自己紹介 ・千田健太郎 ・株式会社インフィニットループ ・2019年4月入社 ・WEBシステム開発やってます ・業務系Webアプリケーションの保守開発
3. リファクタリングとは
4. リファクタリングの定義 ・振る舞いは変えずに中身だけ変えること
5. リファクタリングを行う理由 ・ソフトウェアを理解しやすくする ・より速くプログラミングできる
6. リファクタリングをいつやるべきか ・コードに「不吉なにおい」を感じ始めたら ・機能追加の時にリファクタリングする
7. リファクタリングをすることになった経緯
8. リファクタリングをすることになった経緯 新規機能追加が控えていた ・どこに追加すればいいのかわからない ・どう動作確認すればいいのかわからない
9. リファクタリングをすることになった経緯 チームでのプロジェクト振り返りで問題認識していた 　・仕様がわからない 　・動作確認がわからない 　・Unitテストがつらい 　　など
10. リファクタリングをすることになった経緯 Unitテストが特につらかったらしい 　・網羅するのが大変 　・トライ&エラーでなんとか通していた 　・修正に数日かかっていたとか
11. リファクタリングを提案
12. リファクタリングを提案 何で提案しようと思ったか？ 　・改修コストが高くなっている 　・不具合を埋め込むことが懸念された 　・単純につらい。誰も触りたがらない
13. お客様との交渉
14. お客様との交渉 すんなり工数をもらえることに 　・お客様も問題を認識していた 　・タイミングも良かった（追加機能が落ち着いたタイミング）
15. 対応方針
16. 対応方針 1.最新の動作確認項目を作成 　・リファクタ前後で振る舞いに差が無いことを確認できない 　※Unitテストは問題なく動いていた
17. 対応方針 2.Modelクラスの分割 　・サーバーサイドに焦点を絞り対応 　・処理は変えない
18. リファクタリング対象の画面
19. 1つのModelに 5つの画面！ リファクタリング対象の画面
20. 対応したこと
21. 1.最新の動作確認項目を作成 設計書をベースに作成 　→不安なところはお客様に確認してもらった 　→修正に問題がないことが確認できるようになった
22. 2.Modelクラスの分割 メソッドが扱うデータの種類で抽出 　・画面初期表示するデータ、更新対象データなど
23. 変更前
24. 変更後
25. 2.Modelクラスの分割 画面機能によって分割
 　・画面機能を5つ含むModelを、5つのクラスに分割
 　・このクラスでは基本的に共通処理を呼び出すだけにする
 　　→共通処理以外の記述が画面モード独自の処理と分かる
 
 

26. 変更前
27. 変更後
28. 変更後 画面機能毎のModelに分割
29. 2.Modelクラスの分割 分割したクラスが継承する抽象クラス作成
 　・各画面のメソッドを全て定義しておく
 　・利用する場合継承先でオーバーライドする
 　・オーバーライドせずに呼ばれたら例外を投げる
 　→実装漏れや意図していない処理が呼ばれたら検知できるようになる

30. abstract class BaseModel { public function save(array $params) { throw new Exception('Undefined function called'); } public function delete(array $params) { throw new Exception('Undefined function called'); } } （例）抽象クラス
31. class Display1Model extends BaseModel { public function save(array $params) { // 何らかの処理 } // deleteメソッドは使わないのでオーバーライドしない } （例）画面機能1クラス deleteメソッドが呼ばれたら検知できるように！
32. 2.Modelクラスの分割 画面機能を判定してインスタンスを返すFactoryクラス作成 　・画面機能の判定、インスタンス生成処理をまとめておく 　→画面機能の判定について意識しない
33. 変更前
34. 完成
35. 対応結果
36. 対応結果 ・ほぼ想定していた通りに進めた ・動作確認項目とUnitテストで確認し、問題無く完了できた
37. 対応してみて
38. 自分にとって
39. 対応してみて(自分にとって） 新規機能追加が捗った 　・設計をスムーズに行えた 　　→仕様を理解 　・実装がスムーズに行えた 　　→複雑度解消 　・Unitテストが1日かからずに直せた
40. リファクタリング前 どこを修正・・？
41. リファクタリング後 修正対象が明確に！ この2画面が対象
42. 対応してみて(自分にとって） 読みやすいコードを書こうと改めて思った ・今回みたいな機会はほぼ無い ・仕様理解のためにコードしか頼れない事がある ・自分のために
43. チームにとって
44. 対応してみて（チームにとって） ・コードを触る心理的ハードルが下がった ・プロダクトの理解が深まった ・開発、リファクタの意識向上に繋がった
45. お客様にとって
46. 対応してみて（お客様にとって） ・影響範囲が調査しやすくなった ・修正コストが減った（コード、Unitテスト）（ような気がする
47. まとめ
48. まとめ ・実装時間短縮された（はず ・実装時間短縮だけではなく、様々な改善に繋がる ・自分・チーム・お客様、つまりプロジェクト全体に良い影響がある
49. ありがとうございました。