DDDでレガシーコードに立ち向かうリアル / Reality of confronting legacy code with DDD

by コドモン開発チーム

Slide 1

Slide 1 text

DDDでレガシーコードに立ち向かうリアル〜躓きと学び〜 2024年3月24日 Object-Oriented Conference 2024 株式会社コドモン中田義人

Slide 2

Slide 2 text

2 経歴プロダクト開発チームにて請求・決済関連機能のアプリケーション開発に携わる。整理整頓が好き。最近の趣味はガンプラ。自己紹介中田義人なかたよしと 2009.04 前職のSIerに新卒入社 2022.11 コドモンに開発エンジニアとして入社

Slide 3

Slide 3 text

3 Mission

Slide 4

Slide 4 text

4 すべての先生に子どもと向き合う時間と心のゆとりをこんなプロダクトを開発していますメインプロダクトは、保育・教育施設向けWebアプリケーション。保護者と施設のやり取りを支えるモバイルアプリケーションや、施設職員向けモバイル版アプリケーション、外部サービスと連携するAPIなども開発しています。

Slide 5

Slide 5 text

5 はじめに

Slide 6

Slide 6 text

6 レガシーコードにDDDの考え方を取り入れたいけどどこからどう手をつけたらよいかわからない

Slide 7

Slide 7 text

7 DDDを取り入れてはみたがいろいろな概念や設計パターンをちゃんと理解して、上手く使えているか、自信がない

Slide 8

Slide 8 text

8 そんなあなたの背中を押したい！

Slide 9

Slide 9 text

9 コドモンではどんな感じなのか赤裸々にお伝えします

Slide 10

Slide 10 text

10 今日話すことコドモンのレガシーコードの現状 DDDの実践と躓き得られた学びとこれから 1 2 3

Slide 11

Slide 11 text

11 ● DDDを組織にどのように導入したか ● DDDの概念や設計パターンの詳細説明今日話さないこと

Slide 12

Slide 12 text

12 今日話すことコドモンのレガシーコードの現状 DDDの実践と躓き得た学びとこれから 1 2 3

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

15 CONFIDENTIAL - © 2022 CoDMON Inc. 15 Domain Usecase Presentation Infrastructure Tests E2E/IT 1. コドモンのレガシーコードの現状 File File File File Class Class Class Class Class Class Class API API API API API API API API ● API Endpointごとに 1ファイルにほぼ全処理が書かれている ● 手動テスト（E2Eのみ） gauge gauge gauge gauge ほぼ手動モノリス（バックエンド）はモジュラーモノリスを目指す ● コンテキスト × レイヤーでモジュールを分割 ● 自動テスト（E2E/IT/UT） gauge gauge Class Bounded Context A Bounded Context B リファクタ前の領域リファクタ後の領域

Slide 16

Slide 16 text

16 CONFIDENTIAL - © 2022 CoDMON Inc. 16 Domain Usecase Presentation Infrastructure Tests E2E/IT 1. コドモンのレガシーコードの現状 File File File File Class Class Class Class Class Class Class API API API API API API API API ● API Endpointごとに 1ファイルにほぼ全処理が書かれている ● 手動テスト（E2Eのみ） gauge gauge gauge gauge ほぼ手動モノリス（バックエンド）はモジュラーモノリスを目指す ● コンテキスト × レイヤーでモジュールを分割 ● 自動テスト（E2E/IT/UT） gauge gauge Class Bounded Context A Bounded Context B リファクタ前の領域リファクタ後の領域改修する部分から順次リファクタして移す

Slide 17

Slide 17 text

Slide 18

Slide 18 text

18 今日話すことコドモンのレガシーコードの現状 DDDの実践と躓き得た学びとこれから 1 2 3

Slide 19

Slide 19 text

19 今日話すことコドモンのレガシーコードの現状 DDDの実践と躓き得た学びとこれから 1 2 3

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

28 CONFIDENTIAL - © 2022 CoDMON Inc. 28 2. DDDの実践と躓きリファクタガイドラインの概要既存APIのコード（リファクタ前） Controller Test Test UseCase Controller UseCase Repositories Models Controller UseCase Repositories Models ドメインロジックを移す Step 1 Step 2 Step 3 Step 4 Step 5

Slide 29

Slide 29 text

29 CONFIDENTIAL - © 2022 CoDMON Inc. 29 2. DDDの実践と躓きリファクタガイドラインの概要既存APIのコード（リファクタ前） Controller Test Test UseCase Controller UseCase Repositories Models Controller UseCase Repositories Models Controller UseCase Repositories Models req/res検証・変換や認証を移す Step 1 Step 2 Step 3 Step 4 Step 5

Slide 30

Slide 30 text

30 CONFIDENTIAL - © 2022 CoDMON Inc. 30 2. DDDの実践と躓きリファクタガイドラインの概要既存APIのコード（リファクタ前） Controller Test Test UseCase Controller UseCase Repositories Models Controller UseCase Repositories Models Controller UseCase Repositories Models Step 1 Step 2 Step 3 Step 4 Step 5 繰り返し拡充

Slide 31

Slide 31 text

31 CONFIDENTIAL - © 2022 CoDMON Inc. 31 2. DDDの実践と躓きリファクタガイドラインの概要既存APIのコード（リファクタ前） Controller Test Test UseCase Controller UseCase Repositories Models Controller UseCase Repositories Models Controller UseCase Repositories Models Step 1 Step 2 Step 3 Step 4 Step 5 どのステップまでやるか、どの部分を切り出すか見積の際にチームで認識を合わせる

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

34 CONFIDENTIAL - © 2022 CoDMON Inc. 34 インボイス対応で扱ったドメインモデルの概要 2. DDDの実践と躓き 2024年3月の山田太郎（園児）さん分の請求園児ごと月単位の「請求情報」項目名単価数量価格税種別税率月極保育料 15,000 1 15,000 非課税延長保育料 2,000 1 2,000 非課税教材費 500 1 500 税抜 10% バス送迎 1,000 1 1,000 税抜 10% 「請求情報」は「請求明細」を複数もつ請求額(消費税)の計算単位

Slide 35

Slide 35 text

35 CONFIDENTIAL - © 2022 CoDMON Inc. 35 2. DDDの実践と躓き項目名税抜金額消費税額税率月極保育料 40,000 - 非課税延長保育料 10,000 - 非課税バス送迎 3,105 311 10% 教材費 645 65 10% 非課税計 50,000 - 10%対象計 3,750 376 項目名税抜金額消費税額税率月極保育料 40,000 - 非課税延長保育料 10,000 - 非課税バス送迎 3,105 - 10% 教材費 645 - 10% 非課税計 50,000 - 10%対象計 3,750 375 ×0.1 ×0.1 合算合算 ×0.1 請求額請求額 ¥54,126 ¥54,125 認められない計算例（変更前）認められる計算例（変更後） ※上記は計算例を示したものです。適格請求書の要件は他にもあります。 1 2 1 2 消費税計算ロジックの変更点

Slide 36

Slide 36 text

Slide 37

Slide 37 text

Slide 38

Slide 38 text

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

41 CONFIDENTIAL - © 2022 CoDMON Inc. 41 既存コードがやっていたこと園児テーブルクラステーブル請求情報テーブル・・・ JOIN 対象園児の絞り込み入園前・卒園後所属クラス当月の請求状態 etc 請求額（消費税）の計算いろんなテーブルを一度にJOINして取得してから、いろいろ処理しているリポジトリ経由に変えたいところドメインモデルに変えたいところ参照・更新の単位がまちまち

Slide 42

Slide 42 text

Slide 43

Slide 43 text

43 CONFIDENTIAL - © 2022 CoDMON Inc. 43 どうしたか園児テーブルクラステーブル請求情報テーブル・・・ JOIN 対象園児の絞り込み請求額（消費税）の計算既存のテーブル取得処理は残しつつ、別途リポジトリからモデルを取得するリポジトリ経由で取得園児IDリストを引数として渡す請求額（消費税）の計算テーブルアクセスが冗長だが高負荷処理ではないので妥協参照・更新の単位がまちまち

Slide 44

Slide 44 text

44 CONFIDENTIAL - © 2022 CoDMON Inc. 44 id child_id target_date confirm_flag price tax_percentage item_name … 11111113 2000 2023-12-01 0 500 8 おやつ 11111112 2000 2023-12-01 0 3000 10 送迎バス 11111111 2000 2023-11-01 1 2000 0 一時保育 11111110 3000 2023-11-01 1 1000 0 延長保育料請求情報請求情報テーブルを確認したらレコードの単位は「請求明細」（正規化されていない）明細明細既存コードは「請求明細」単位で取得・更新している😕 参照・更新の単位がまちまち

Slide 45

Slide 45 text

Slide 46

Slide 46 text

Slide 47

Slide 47 text

47 CONFIDENTIAL - © 2022 CoDMON Inc. 47 請求情報の更新はどうする？参照・更新の単位がまちまち請求情報テーブルフロントエンドのコードまで見ると更新API 全ての請求明細を取得請求情報のまとまり請求明細 1 請求明細 2 請求明細 3 参照API フロントエンド全ての請求明細を送信請求情報単位でチェック・処理請求情報のまとまり請求明細 1 請求明細 2 請求明細 3 受け取った請求明細のみチェック

Slide 48

Slide 48 text

Slide 49

Slide 49 text

Slide 50

Slide 50 text

50 なぜこうなった？どうすればよい？

Slide 51

Slide 51 text

51 CONFIDENTIAL - © 2022 CoDMON Inc. 51 「集約」とは DDDの「集約」の考え方を取り入れてみる参照・更新の単位がまちまちエンティティと値オブジェクトを集約の中にまとめ、各集約の周囲に境界を定義すること。〜〜〜〜〜〜〜〜〜どんな状態変化においても、集約内にあるオブジェクトと集約全体に対して、不変条件をすべて強制する〜〜〜「エリック・エヴァンスのドメイン駆動設計」より抜粋

Slide 52

Slide 52 text

Slide 53

Slide 53 text

Slide 54

Slide 54 text

Slide 55

Slide 55 text

Slide 56

Slide 56 text

Slide 57

Slide 57 text

Slide 58

Slide 58 text

58 CONFIDENTIAL - © 2022 CoDMON Inc. 58 １つのAPIの責務が大きい請求情報を変更・確定確定した請求情報を保存保存した請求情報を再取得請求情報を受信請求額（消費税）を計算請求額を入金管理に登録処理の流れ billsテーブルのrecordデータ作成 UPDATE bills SELECT FROM bills APIリクエストbody $bill->price * $bill->tax_percentage INSERT INTO payments 既存コード

Slide 59

Slide 59 text

59 CONFIDENTIAL - © 2022 CoDMON Inc. 59 １つのAPIの責務が大きい請求情報を変更・確定確定した請求情報を保存保存した請求情報を再取得請求情報を受信請求額（消費税）を計算請求額を入金管理に登録処理の流れ billsテーブルのrecordデータ作成 UPDATE bills SELECT FROM bills APIリクエストbody $bill->price * $bill->tax_percentage INSERT INTO payments 既存コード修正イメージ $bills = BillRepository->findByChildIds() $bill->priceTotal() リポジトリ取得にするモデルに計算させる

Slide 60

Slide 60 text

Slide 61

Slide 61 text

61 CONFIDENTIAL - © 2022 CoDMON Inc. 61 １つのAPIの責務が大きい請求情報を変更・確定確定した請求情報を保存保存した請求情報を再取得請求情報を受信請求額（消費税）を計算請求額を入金管理に登録テストが、ローカル環境だと通るのに、検証環境だと通らない billsテーブルのrecordデータ作成 UPDATE bills SELECT FROM bills APIリクエストbody $bill->price * $bill->tax_percentage INSERT INTO payments 既存コード修正イメージ $bills = BillRepository->findByChildIds() $bill->priceTotal() 請求額の変更が反映されない！変更・確定の保存は成功している

Slide 62

Slide 62 text

62 CONFIDENTIAL - © 2022 CoDMON Inc. 62 １つのAPIの責務が大きい請求情報を変更・確定確定した請求情報を保存保存した請求情報を再取得請求情報を受信請求額（消費税）を計算請求額を入金管理に登録原因 billsテーブルのrecordデータ作成 UPDATE bills SELECT FROM bills APIリクエストbody $bill->price * $bill->tax_percentage INSERT INTO payments 既存コード修正イメージ $bills = BillRepository->findByChildIds() $bill->priceTotal() 全体が１トランザクション WriterDBに接続 SELECTクエリの場合は自動でReaderDBに接続トランザクションの途中なので再取得結果（ReaderDB）には変更が反映されていない

Slide 63

Slide 63 text

63 CONFIDENTIAL - © 2022 CoDMON Inc. 63 ● 既存コードとリポジトリ実装で、トランザクション（DBClientインスタンス）が別になっていた →同一のトランザクションを使うように修正した ● ローカル環境はDBとReader/Writerが同一コンテナだった →ローカル環境もReader/Writeを分けて不具合を検出可能とした１つのAPIの責務が大きいどうしたか

Slide 64

Slide 64 text

64 なぜこうなった？どうすればよい？

Slide 65

Slide 65 text

65 CONFIDENTIAL - © 2022 CoDMON Inc. 65 １つのAPIの責務が大きいなぜバグを作り込んでしまったのか？ ● トランザクション範囲の確認不足？ ● フレームワークの仕様の確認不足？それはそう　でも、そもそも ● トランザクション範囲が広すぎでは？ ● １API、１ユースケースの責務が大きすぎでは？ ※ここで言う「ユースケース」は、実装文脈の「アプリケーションサービス」

Slide 66

Slide 66 text

Slide 67

Slide 67 text

Slide 68

Slide 68 text

68 CONFIDENTIAL - © 2022 CoDMON Inc. 68 １つのAPIの責務が大きい DDDの「ドメインイベント」の考え方を取り入れてみる「ドメインイベント」とは「ドメインエキスパートが気にかける、何かの出来事」ドメインエキスパートの話の中に出てくるフレーズ ● 「・・・するときに、」 ● 「もしそうなったら、・・・」 ● 「・・・の場合は、私に知らせてほしい」「・・・の場合は、通知してほしい」 ● 「・・・が発生したときに」「実践ドメイン駆動設計」より抜粋

Slide 69

Slide 69 text

69 CONFIDENTIAL - © 2022 CoDMON Inc. 69 １つのAPIの責務が大きい DDDの「ドメインイベント」の考え方を取り入れてみる請求情報を変更・確定する確定請求額を入金管理に登録する < event > 請求が確定したドメインイベントを介して、２つのユースケースを繋げる ObserverパターンまたはMessaging Serviceを介してイベント連携する 1つのユースケースの責務を小さく保ちつつ、ユーザ操作やAPI呼び出しも最小限に抑えることが可能 Publish Subscribe

Slide 70

Slide 70 text

Slide 71

Slide 71 text

Slide 72

Slide 72 text

Slide 73

Slide 73 text

Slide 74

Slide 74 text

Slide 75

Slide 75 text

75 なぜこうなった？どうすればよい？

Slide 76

Slide 76 text

76 CONFIDENTIAL - © 2022 CoDMON Inc. 76 思った以上に重複が多い DDDの「汎用サブドメイン」の考え方を取り入れてみる「汎用サブドメイン」とは設計中のプロジェクトにとって動機となっていない、高凝集のサブドメインを識別すること。そうしたサブドメインから汎用的なモデルを括り出して、別のモジュールに入れること。その中に特化した要素を一切残してはならない。いったん分離したら、その部分に対して継続される開発の優先順位をコアドメインより下げ、その作業にコアとなる開発者を割り当てるのを避けること（そこから得られるドメインについての知識はほとんどないからだ）。「エリック・エヴァンスのドメイン駆動設計」より抜粋

Slide 77

Slide 77 text

Slide 78

Slide 78 text

Slide 79

Slide 79 text

Slide 80

Slide 80 text

Slide 81

Slide 81 text

81 今日話すことコドモンのレガシーコードの現状 DDDの実践と躓き得た学びとこれから 1 2 3

Slide 82

Slide 82 text

82 今日話すことコドモンのレガシーコードの現状 DDDの実践と躓き得た学びとこれから 1 2 3

Slide 83

Slide 83 text

Slide 84

Slide 84 text

Slide 85

Slide 85 text

Slide 86

Slide 86 text

Slide 87

Slide 87 text

Slide 88

Slide 88 text

88 CONFIDENTIAL - © 2022 CoDMON Inc. 88 3. 得た学びとこれから Amazon API Gateway Microservice Amazon EventBridge Event Bus Rule Rule Rule API Destination Rule API Destination API Destination Monolith UseCase Aggregate Publisher Forwarder Subscriber Controller Microservice create update delete publish event イベント駆動のモデルに適したアーキテクチャを検討中モノリスとマイクロサービスを繋ぐMessaging Serviceの案

Slide 89

Slide 89 text

Slide 90

Slide 90 text

90 CONFIDENTIAL - © 2022 CoDMON Inc. 90 3. 得た学びとこれから汎用サブドメインの対応方法「エリック・エヴァンスのドメイン駆動設計」より ● 選択肢１：既製品による解決 ● 選択肢２：公表されている設計やモデル ● 選択肢３：実装のアウトソーシング ● 選択肢４：自社での実装汎用サブドメインに力をかけずコアドメインに注力したいまずは社内で公表されたモデルのドキュメントを用意するモノリス・マイクロサービスで複数のプログラミング言語が混在

Slide 91

Slide 91 text

91 最後に

Slide 92

Slide 92 text

Slide 93

Slide 93 text

93 CONFIDENTIAL - © 2022 CoDMON Inc. 93 改めて振り返ると ● 自分たちが当事者である課題 ● 仮定でなく、現実に起きている課題 ● ビジネスとともに成長してきた複雑な課題リアルな設計課題とはレガシーコードはリアルな設計課題の宝庫 ● 解決したい課題が実感しやすい ● 設計パターンの必要性や使い所がわかる ● 設計パターンを実際に開発現場で試せる読書や演習と比べて ↓

Slide 94

Slide 94 text

Slide 95

Slide 95 text

95 楽しそうじゃないですか？

Slide 96

Slide 96 text

96 ちなみに

Slide 97

Slide 97 text

97 コドモン採用ページ開発ブログコドモンでは一緒に働きたい仲間を募集しています！