Share
Embed
Transcript
70 slides
-
本日の流れ 事前準備 クリーンアーキテクチャの基礎を理解 ソフトウェアアークテクチャとは ソフトウェアアーキテクチャの目的
DDD、ドメインモデリングとは クリーンアーキテクチャとは SOLID原則1つずつ解説 どんな原則か 悪いコードを見てみる 修正方針 Q&Aで理解を深める ぐちゃぐちゃコードをクリーンなコードにするワーク -
Speaker Profile 株式会社Digeon 2025年6月入社 氏名:萩原里菜(29) PM兼開発者
仕事で使っている言語:Go、React等 家族:双子の弟・父・母・祖母・19さいのといぷー 趣味:ボードゲーム、旅行、お笑いラジオ、映画 X(Twitter):@fjwmmlb25 Zenn:https://zenn.dev/h4gi -
ソフトウェアアーキテクチャの目的 拡張性が高い 新しい機能や要件を追加する際に、既存の構造を壊さず最小限の変更で対応できる 保守性が高い 後から変更や修正をしても壊れにくく、理解・修正・拡張がしやすい テスト容易性が高い 各モジュールが独立してテスト可能であり、テストコードが容易に記述・保守できる
可読性が高い 命名や構造、設計ルールが一貫しており、新規開発者でも短期間で理解・参加できる コードの内容や意図が容易に理解できる -
DDD、ドメインモデリングとは(シンプルに) ドメインとは ソフトウェアが解決しようとしている、業務の領域のこと DDD(ドメイン駆動設計)とは ドメインをソフトウェアの中心に添えてシステムを構築する設計手法 ドメイン駆動設計の主な目的は、ビジネスの本質(ドメイン)を深く理解し、それをソフトウェアに適切に反映させる こと
ドメインモデリングとは 業務用語やルールを整理し、エンティティや値オブジェクトに分け、関連や振る舞い(メソッド)を設計すること 基本的に、ドメインエキスパートとエンジニアが一緒に行うことを前提としており、「作ろうとしているシステムについて、ビ ジネスサイドとエンジニアサイドが、共通認識を持ち、意思疎通する」ことを可能にする -
クリーンアーキテクチャ Enterprise Business Rules ビジネスルールを表現する層 Application Business Rules
ユーザーの行動(ユースケース)を表現する層 Interface Adapters データをユースケースやエンティティで扱える形に変換する層 Frameworks and Drivers データベースやUIなど、外部の技術的な詳細を担当する層 -
クリーンアーキテクチャ ~メリット~ 最大の目的は、変更コストを最小化し長期的な開発効率を最大化すること 保守性: ビジネスルール(ドメイン)を他の層(UI・DB・外部サービスなど)から独立させることで機能を追加・修正すると きに他の部分への影響を最小限に抑えられる 再利用性・テスト容易性: 依存関係を内側(ビジネスルール)に向けることで、ドメインロジックは外部技術に依存しないため、ビジネスルー
ルだけを単体でテストできる 外部要素をモック化・差し替え可能にすることで、自動テストやリファクタリングが容易になる 開発効率: 依存関係の向きを制御できるため、コンポーネントごとにそれぞれのチームが独立して開発できる -
クリーンアーキテクチャ~採用基準~ クリーンアーキテクチャの採用基準 クリーンアーキテクチャは 中〜大規模で、長期的に保守するシステム向け の設計です。 特に以下のような場合に効果があります: UIやDBなどの外部技術が変わる可能性が高い
ビジネスロジックを長く使い続けたい・他プロジェクトでも再利用したい テストをしっかり行いたい 不向きなケース 小規模・短期開発・PoCなど -
「変更に強いソフトウェア設計」を行うコツとしてRobert C. Martin という開発者が提唱した5つの原則 単一責任の原則:Single Responsibility Principle オープン・クローズドの原則:Open-Closed
Principle リスコフの置換原則:Liskov Substitution Principle インターフェイス分離の原則:Interface Segregation Principle 依存関係逆転の原則:Dependency Inversion Principle それぞれの頭文字を一文字ずつとって、SOLID原則とよばれる SOLID原則 -
LSP:リスコフ置換原則〜どんな原則か〜 サブタイプ(子クラス)は、スーパータイプ(親クラス)として問題なく置き換えて使えるべき 事前条件を、派生型で強めることはできない。派生型では同じか弱められる。 事後条件を、派生型で弱めることはできない。派生型では同じか強められる。 不変条件は、派生型でも保護されねばならない。派生型でそのまま維持される。 基底型の例外から派生した例外を除いては、派生型で独自の例外を投げてはならない。
事前条件・・・メソッドを呼び出す前に、呼び出し側が満たしておくべき条件 事後条件・・・メソッドの実行が終わったあとに、呼び出し側に対して保証される状態 -
事前条件を、派生型で強めることはできない。派生型では同じか弱められる。 もし「支払処理サービス」が「金額がJPYで0円以上なら支払える」としているなら、 派生クラスの「クレジット決済サービス」は「金額が1,000円以上でないと支払えない」と制限してはいけない。 OKな例:クレジット決済サービスは「JPY に加えて USD も可」と許容を広げる 事後条件を、派生型で弱めることはできない。派生型では同じか強められる。
もし「ユーザー登録サービス」が「登録成功時にメールを送る」としているなら、派生クラスの「特別会員登録サービ ス」は「メールは後で送る」としてはいけない。 OKな例:特別会員登録では、登録後にメール+SMSも送ると保証を強めてもいい。 LSP:リスコフ置換原則〜例で解説〜 -
不変条件は、派生型でも保護されねばならない。派生型でそのまま維持される。 もし「人」が「年齢は常に 0 以上」 という不変条件を持っているなら、派生クラスの「ティーン」が「年齢は 13〜19 の間でなければならない」と制限を強くしてしまってはいけない。 → 不変条件(Age
≥ 0)は、派生型でもそのまま維持されなければならない。 基底型の例外から派生した例外を除いては、派生型で独自の例外を投げてはならない。 もし「ファイル読み込み処理」がFileNotFoundError だけを投げる と契約されているなら、派生クラスの「画像ファ イル読み込み処理」がImageFormatError といった 新しい例外 を投げてしまってはいけない。 → 利用側は「FileNotFoundError だけ来る」と思っているため、新しい例外が来ると正しく扱えなくなる。 LSP:リスコフ置換原則〜例で解説〜 -
本来不要なメソッドを実装・理解する義務が生まれ、コードが読みにくくなり、保守コストが増える インターフェースに手を入れるたびに、使っていない側まで影響が波及する → 破壊的変更を招きやすい モックを用意する際にも「使わないメソッド」までモックしなければならず、テストが肥大化し、意図が不明瞭にな る
無関係な責務が混ざっているため、コンポーネント単位での再利用が困難になる ISP:インターフェース分離の原則〜従わないとどうなるか〜 -
インターフェースを定義する:EmployeeRepo, LeaveRequestRepo, Notifier, Clock など →上位層(ビジネスロジック)が下位層(DB・SMTPなど)に依存している構造を解消する ユースケースがインターフェースに依存するようにする
実装側でインターフェースを実装する main.goで依存注入(コンポジションルートとして全層を組み立て) ※コンポジションルート・・・アプリケーション全体の依存関係を「組み立てる(compose)」場所のこと DIP:依存性逆転の原則 〜修正方針〜 -
下記の点を話し合ってみてください ソフトウェアアーキテクチャの目的「求められるシステムを開発・保 守するのに必要な人材を最小限にする」ということを考えた上で 汚いコードはなにがだめなのか 修正前と修正後ではなにが変わり、どんなメリットがあるのか クリーンなコードにするために業務で意識してやっていること チームで話したことで、シェアしてもいいものがあれば下記にてシェアし
てください https://docs.google.com/document/d/1FEU3grQJ0ceBuzDzlaK8Pi p2BNLB3dtFJdlcgCc15jg/edit?usp=sharing ワークタイム -
採用情報 株式会社Digeonでは現在、 一緒に働く仲間を募集しています 興味がある方は公式ウェブサイトまたはwantedly、萩原に直接 ご連絡いずれの方法でも構いませんので、一度ご連絡ください。 その他技術記事や、ブログ等も興味あれば読んでみてください。 採用ページ:https://digeon.co/jobs Wantedly:株式会社Digeonの会社情報 - Wantedly
X(Twitter):https://x.com/Digeon_inc Zenn:株式会社Digeon | Zenn Note:株式会社Digeon|note スピーカー記事:挑戦と成長を後押しする環境がここに。 萩原さん・柴田さんインタビュー|株式会社Digeon -
参考記事 ドメインモデリング https://products.sint.co.jp/ober/blog/ddd https://zenn.dev/m10maeda/articles/i-had-domain-driven-design-down-pat ヘキサゴナルアーキテクチャ https://zenn.dev/heyyou/articles/f380adb8d1fe8f https://qiita.com/cocoa-maemae/items/b08c4cf95d47e314e2dc https://www.issoh.co.jp/tech/details/2965/#i-2 オニオンアーキテクチャ https://qiita.com/cocoa-maemae/items/e3f2eabbe0877c2af8d0
https://qiita.com/GleapPost/items/d58b309315effb0e9515 [DDD]ドメイン駆動設計で実装を始めるのに一番とっつきやすいアーキテクチャは何か #Java - Qiita クリーンアーキテクチャ https://zenn.dev/sre_holdings/articles/a57f088e9ca07d https://www.geeksforgeeks.org/system-design/complete-guide-to-clean-architecture/?utm_source=chatgpt.com https://tech.anycloud.co.jp/articles/clean-architecture/ -
参考記事 SOLIDの原則 https://www.digitalocean.com/community/conceptual-articles/s-o-l-i-d-the-first-five-principles-of-object-oriented-design?utm_source=chatgpt.com https://zenn.dev/k_ichirof/articles/d79ad8153eabf7 単一責任の原則 https://www.geeksforgeeks.org/system-design/complete-guide-to-clean-architecture/?utm_source=chatgpt.com https://dev.to/the_architect/clean-architecture-for-enterprise-applications-a-practical-guide-from-the-trenches-3ii0?utm_source=chatgpt.com https://www.geeksforgeeks.org/system-design/complete-guide-to-clean-architecture/?utm_source=chatgpt.com リスコフの原則 https://qiita.com/yuki153/items/142d0d7a556cab787fad
【SOLID】リスコフの置換原則を完全に理解したい #C# - Qiita インターフェース分離の原則 https://zenn.dev/andmorefine/articles/5ae927efe2daba https://qiita.com/k2491p/items/7b4e56789964ac6328b3 依存性逆転の還俗 https://qiita.com/nozomi2025/items/39a1ab432aa7c91bd5df?utm_source=chatgpt.com https://zenn.dev/purenium/articles/clean-architecture-essence?utm_source=chatgpt.com -
レイヤードアーキテクチャ プレゼンテーション層:ユーザーとのやり取りを担当 UI、APIエンドポイント、リクエスト処理など アプリケーション層:ユースケースの制御・業務フローを管理 ユースケースサービス、トランザクション管理など ドメイン層:ビジネスロジックやルールを表現 エンティティ、値オブジェクト、ドメインサービスなど
インフラ層:永続化や外部システムとの通信を担当 DBアクセス、APIクライアントなど -
レイヤードアーキテクチャ メインの概念 システムを責務ごとに「層」に分け、上位層が下位層に依存する構造。 典型的には「プレゼンテーション層 → アプリケーション層 → ドメイン層 →
インフラ層」。 メリット 責務の分離により保守性・拡張性が高い 各層ごとにテストが容易 チーム開発時の分担がしやすい 層という一貫した共通のルールがあることで学習コストが低く済む デメリット ドメインロジックが外部技術に依存してしまう -
ヘキサゴナルアーキテクチャ (Ports & Adaptersアーキテクチャ) ドメイン(内側):変わらない本質(ビジネスルール) アプリケーション・コア(内側寄り):ユースケースの制御(フロー管理) ポート(外側):ドメインが外の世界とやり取りするためのインターフェース
多くのアプリではユーザー側のポートとDB側のポート2種類を持つ アダプタ(外側):外部をポートに合わせて変換する実装 Inbound Adapter・・・ UIやAPIなど「ドメインを呼び出す側」 Outbound Adapter・・・ DBや外部APIなど「ドメインに呼ばれる側」 -
ヘキサゴナルアーキテクチャ メリット ビジネスロジックが外部技術から 隔離 されているため、変更の影響範囲を小さくできる 内部ロジックに対して モックを使ったユニットテストが容易になる 外部技術の差し替えを容易にできる
デメリット ポート・アダプタの抽象化が過度になると、コードが冗長化したり、理解コストが上がる。 -
オニオンアーキテクチャ ドメインモデル層:アプリケーションのビジネスドメインを表現 Entity, ValueObjectなど ドメインサービス層:ビジネスロジックを記述する層 Repositoryインターフェース、ビジネスルール、ドメイン固有のロジック アプリケーションサービス層:ユースケースを表現
ドメインサービスのインターフェースを順次呼び出す インフラストラクチャー層:外部システムとの連携を担当 Repositoryの実装クラス、外部API、データベースへのアクセス プレゼンテーション層:APIのリクエスト・レスポンスに責任を持つ 入力値の検証とドメインモデルへの変換する -
オニオンアーキテクチャ メリット 保守性: 外部技術変更がビジネスロジックに影響しない テスト容易性: インターフェースによりモックが容易 拡張性: 新しい外部システムの追加が容易
デメリット 初期の学習コストが高い 短期プロジェクトにはオーバースペック