Share
Embed
『改訂新版 良いコード/悪いコードで学ぶ設計入門』活用方法−爆速でスキルアップする!効果的な学習アプローチ / effective-learning-of-good-code
MinoDriven
January 17, 2025
Transcript
54 slides
-
© DMM © DMM 『改訂新版 良いコード/ 悪いコードで学ぶ設計入門』 活用方法 爆速でスキルアップする! 効果的な学習アプローチ
2025/01/17(金) 合同会社DMM.com ミノ駆動 -
© DMM 自己紹介 ミノ駆動 ( @MinoDriven ) 合同会社DMM.com プラットフォーム開発本部 第3開発部
DeveloperProductivityGroup DMMプラットフォームの設計を改善し 開発生産性向上を図るのがミッション 2 -
© DMM もうちょっと具体的な仕事の内訳 サービス全体で共通利用されるDMMプラットフォーム (アカウント管理、不正対策、決済、DMMポイント etc..) の設計品質改善 • 設計ガイドライン策定 •
チームへの設計指導 • プラットフォーム所属のエンジニア(約120人!)に対する設計勉強会 ワークショップ形式の実践講習(←本日説明する内容です) • リファクタリング体制整備 3 -
© DMM 7つのリニューアル! 1. 【変更】凝集度、結合度からカプセル化、関心の分離へ 2. 【加筆】インターフェースと実装の分離 3. 【変更】interfaceの解説を改善 4.
【加筆】インターフェースと実装の分離にもとづいたinterface設計 5. 【加筆】アンカリング効果 6. 【加筆】ジョシュアツリーの法則 7. 【加筆】説明による設計スキルアップ 7 -
© DMM 凝集度が高くても変更容易性が低いケース 9 class Util { // このaddメソッドは機能的凝集の構造 //
しかしMoneyクラスに定義されていないので変更容易性は低い static Money add(Money money1, Money money2) { if (!money1.currency.equals(money2.currency)) { throw new IllegalArgumentException("通貨単位が違います。"); } Money added = new Money(); added.amount = money1.amount + money2.amount; added.currency = money1.currency; return added; } } // 金額を表現するクラス class Money { int amount; // 金額値 Currency currency; // 通貨単位 } -
© DMM どんな学習方法? 実際にコードを書くワークショップ形式の勉強会。 『改訂新版 良いコード/悪いコードで学ぶ設計入門』 をテキストとして使います。 普段開発で扱っているソースコードを使います。 • 問題のあるコードを探す •
変更容易性の高い構造へ再設計し、実装する • 何が問題で、設計でどう解決したかを説明する(←ココ超重要) という学習方法です。 20 -
© DMM 23 https://career-ed-lab.mynavi.jp/career-column/707/ より引用 講義や読書は学習定着率が低く、 非効率。 自転車の乗り方を本で読んでも乗れ ません。実際に自転車に乗り、バラン スの取り方を身体で覚える必要があ
ります。 設計も同様に、実際に手とクチを動か し試行錯誤することで、実践レベルの スキルを効率よく獲得できます。 だからワークショップ形式の勉強会を 採用しています。 -
© DMM 実践レベルのスキル習得 変更容易性の、実践的な基礎スキルが身につきます。 何をもって「身についた」と言えるのか • 変更容易性に問題のあるコードを認識できている (スキルが未熟だと問題コードを目にしても問題だと認識できない) • 泥臭く複雑なプロダクションコードを改善できている
• 変更容易性の高い構造の要件を満たしている • 何が問題で、設計でどう解決したのかについて、 筋道の通った説明ができている 26 -
© DMM 短時間で高効率なスキルアップ 弊社DMMのプラットフォーム開発本部では、 1チームに対し以下の学習時間をかけています。 (予習1時間 + 実習2時間) x 5回
= 15時間 たった15時間で、実践的な基礎スキルが身についています。 27 -
© DMM 学習メニュー ミノ駆動本のうち次の5項目を 特に重要な基礎スキルとして位置付けています。 1日1項目ずつ学習します。 1. カプセル化 2. 関心の分離
3. 単一責任原則 4. interface設計 5. 目的駆動名前設計 詳しくは『改訂新版 良いコード/悪いコードで学ぶ設計入門』を参照 30 -
© DMM 学習ステップ 1項目あたり、以下に示すステップで学習します。 • ステップ1:予習 • ステップ2:概要確認、目線合わせ • ステップ3:問題のあるコードを探す
• ステップ4:何が問題かをメモに起こす • ステップ5:問題コードについて説明する • ステップ6:再設計、実装 • ステップ7:どう設計したかをメモに起こす • ステップ8:成果発表 31 実習2時間 1時間 -
© DMM 【超大事な前提】技術は問題解決の手段 設計も含め、技術は問題解決の手段です。 何が問題なのか正しく把握することで、 その問題を解決する手段として的確な設計ができます。 逆に問題を正しく把握できないと設計がチグハグになります。 当然問題解決には至りません。 とかく技術は、使い方ばかり着目されがち。 解決したい問題を把握することがより重要です!
このワークショップでは、 受講者が問題をしっかり言語化できることをキモとしています。 33 -
© DMM ステップ3:問題のあるコードを探す 【所要時間】20〜25分 普段の開発で扱っているソースコードを練習題材に使います。 設計を適用できそうな、問題のあるコードを探します。 例えばカプセル化の場合、データとそのデータを操作するロジックがバラ バラに実装されいるコードを探します。 このステップからは、受講者それぞれがソロで実施します。 ペアやモブで実施すると、
人任せになってしまうことがあるためです。 それでは問題コードを認知するスキルや 設計スキルが十分に養われません。 36 -
© DMM ステップ4:何が問題かをメモに起こす 【所要時間】5分 極めて重要なステップです。 見つけた問題コードについて、 何が問題なのかをメモに起こします。 人が頭の中で考えていることは意外なほどぼんやりしています。 文字に書き起こすことで矛盾に気付いたり、新たな発見があったり、 何が問題なのかをより正確に認識できるようになります。
ここを的確に言語化することで設計の正確性が向上します。 逆に言語化が不十分だと、的外れな設計になってしまいます。 38 -
© DMM ステップ7:どう設計したかをメモに起こす 【所要時間】5分 重要なステップです。 次のステップで、再設計した内容について成果発表します。 このステップでは、発表内容を準備します。 以下を説明できるようにメモを書きます。 • 問題解決のためにどのように設計したのか
• なぜそのような設計をしたのか • 設計によって問題は解決できたか 41 -
© DMM 問題把握が不正確だと設計も不正確 上手く設計できない人がまれにいます。 共通する傾向があります。 • 何が問題かを正しく把握できていない、上手く説明できない • テーマとは別の問題を問題視してしまう •
フレームワークや実装技術ばかりを気にしている (そのため解決したい問題にまで頭が回らない) 問題把握が不正確だと、解決手段としての設計もチグハグになります。 当然問題解決できません。 テーマとなる問題に集中するようファシリする必要があります。 45 -
© DMM 47 変更容易性 現状構造 変更容易性の高い 理想構造 理想構造を知らないとギャップを 認識できない! 技術的負債を認識できない!
「このコードの一体どこが負債な んですか?これが普通でしょ?」 問題の認識には、理想構造を知る 必要があります! バグをなるべく埋め込まず 素早く正確にコード変更できる度合い -
© DMM 受講者の感想 • ミノ駆動本は以前から持っていて読了済み。 でも実際にワークショップをやってみて、 理解したつもりになっていたことに気付かされた。 • 普段の開発でしんどいと思ってた箇所を ワークショップで綺麗に再設計できたので、
そのまま開発に採り入れたい。 • 今まで認識できなかった問題コードを認識できるようになって、 ソースコードに対する見方、向き合い方が変わった。 49 -
© DMM 問題のあるコードが見つからない場合は? 実際たまにそのような状況になります。 その場合は、やむを得ないのですが 生成AIに作らせた教材用のコードを使います。 生成AIはさまざまなドメイン知識を知っているので、 なんらかのドメイン知識をベースにしたコードを作らせます。 (例:決済、スマホの料金計算、注文 etc..)
ただし、問題の度合いはプロダクションコードに及ばないので、 なるべくプロダクションコードを用いた方が良いです。 50 -
© DMM 設計の学習にミノ駆動本をすすめる理由 この学習方法では、ミノ駆動本の利用を強くオススメします。 • 何が問題なのかを分かりやすく解説しています。 そのため、問題を認識しやすくなるメリットがあります。 • 「問題のあるコードを探してください」と言われても、 慣れていない人にとっては見つけるだけで一苦労です。
ミノ駆動本では、問題のあるコードを豊富に取り揃えています。 そのため「(進研ゼミっぽいノリで)あっ、これミノ駆動本で見たやつ だ!」みたく、問題コード発見の手助けになります。 これらはミノ駆動本ならではの特徴です。 51