Share
Embed
クリーンアーキテクチャのリポジトリパターン - Pythonでの実装
クリーンアーキテクチャのリポジトリパターンについて解説する社内勉強会資料。
Pythonを使ってのサンプルコードも作成。
shimakaze-git
April 19, 2023
Transcript
58 slides
-
目次 1. クリーンアーキテクチャとは 2. リポジトリパターンの概要 3. インターフェースとは何か? 4. DIP(依存関係逆転の原則)について 5.
Pythonでのリポジトリパターン実装例 6. ビジネスロジックの実装 7. リポジトリパターンの利点 8. 注意点 9. 実践的なリポジトリパターンの例 10. リポジトリパターンの応用 shimakaze-soft 2 -
クリーンアーキテクチャとは ソフトウェアの保守性や拡張性を高めることを目的 とした設計原則 構造をエンティティ、ユースケース、インターフェ ースアダプタ、フレームワーク & ドライバに分割 し、各層の責務を明確にする 円状の構造で依存関係が弱くなり、内側の層が外側 の層に依存しないように設計する
高い抽象度のエンティティやユースケースを中心に 設計し、具体的な技術やフレームワークとは独立さ せることで、柔軟性と保守性を向上させる shimakaze-soft 6 -
クリーンアーキテクチャとは ドメイン駆動設計 (DDD) ビジネスロジックやビジネスルールを中心にソフトウェアを設計するアプローチ ビジネスドメインの理解を深め、ドメインモデルを設計して実装を行う ドメインエキスパートとのコミュニケーションを重視し、ユビキタス言語を作成 することで、ドメインエキスパートが理解しやすい形でドメイン知識を共有 ビジネスドメイン - 業務領域
ドメインエキスパート - 業務知識に精通している人 ユビキタス言語 - 開発者とドメインエキスパートとの共通の言語 shimakaze-soft 10 -
クリーンアーキテクチャとは ドメイン駆動設計 (DDD) 戦略的設計 と 戦術的設計 の2つがある 戦略的設計 - ドメイン全体のモデル化とサブドメイン間の関連を決定する
戦術的設計 - ドメイン内の具体的なモデルを設計して実装するための技術 shimakaze-soft 11 -
オニオンアーキテクチャと の違い ジェフリー・パルモ によって提唱された Domain Model Domain Service Application Service
Infrastructure 内側の層が外側の層に依存しないよ うに設計 shimakaze-soft 15 -
インターフェースとは何か - (1) インターフェースを実装したクラスは、インターフェースで定義されたメソッドを必ず 実装しなければならない public interface UserRepository { void
save(User user); User find(int userId); } shimakaze-soft 24 -
インターフェースとは何か - (2) インターフェースを利用することで、異なるクラス間で共通の振る舞いを定義し、 統一したAPIを提供することができる クラス間の依存関係を低減し、柔軟で保守性の高いコードを実現する public interface UserRepository {
void save(User user); User find(int userId); } UserRepository インターフェースでは、 saveメソッド と findメソッド が定義されてい る。 インターフェースを実装したクラスは、これらのメソッドを必ず実装する必要がある shimakaze-soft 25 -
Pythonにおけるインターフェースの代替手段: 抽象クラス - (2) abc モジュールの ABC クラスを継承し、 @abstractmethodデコレータ を使って抽象メソ
ッドを定義する。 from abc import ABC, abstractmethod # Pythonでの抽象クラスの例 class UserRepository(ABC): @abstractmethod def save(self, user: User): raise NotImplementedError() @abstractmethod def find(self, user_id: int) -> User: raise NotImplementedError() shimakaze-soft 28 -
DIP(依存関係逆転の原則)について DIP(Dependency Inversion Principle) とは、ソフトウェア設計において、モジュー ル間の依存関係を逆転させることで、保守性や拡張性を向上させる原則(SOLID原則 の1つ) 上位モジュールは下位モジュールに依存すべきではなく、両者は抽象に依存すべき である 抽象化に依存すべきで、詳細に依存すべきではない
リポジトリパターンでは、DIPを実現するためにインターフェースを使用 Python で Dependency Injection(DI) をやるには? shimakaze-soft 29 -
DIP(依存関係逆転の原則)について 上位モジュールは下位モジュールに依存すべきではなく、 両者は抽象に依存すべ き である ここでいう下位と上位は以下のような意味になる。 下位 ≒ 標準ライブラリやOS、プロトコル、HW側などの技術的な低水準のレイヤー 上位
≒ 技術的な詳細を実装しないビジネスロジックなどの下位を呼び出す側 shimakaze-soft 30 -
DIP(依存関係逆転の原則)について 具体的な実装から抽象(インターフェースや抽象クラス)に依存する形になり、 モジュ ールの結合度を低く保つ ことができる。 from abc import ABC, abstractmethod
# UserRepositoryの抽象クラス class UserRepository(ABC): @abstractmethod def get_user(self, user_id): raise NotImplementedError() # GetUserServiceクラス: UserRepositoryに依存 class GetUserService: def __init__(self, user_repository: UserRepository): self.user_repository = user_repository def execute(self, user_id): return self.user_repository.get_user(user_id) shimakaze-soft 31 -
DIP(依存関係逆転の原則)について 具体的な実装(詳細)が抽象に従う形で設計されることで、実装の変更や追加が容易 になり、拡張性が向上する。 from abc import ABC, abstractmethod # UserRepositoryの抽象クラス
class UserRepository(ABC): @abstractmethod def get_user(self, user_id: int): raise NotImplementedError() shimakaze-soft 33 -
DIP(依存関係逆転の原則)について 具体的な実装(詳細)が抽象に従う形で設計されることで、実装の変更や追加が容易 になり、拡張性が向上する。 # UserRepositoryの実装クラス1: SQLiteを使用 class SqliteUserRepository(UserRepository): def get_user(self,
user_id: int): """""" # SQLiteからユーザーを取得する処理 # UserRepositoryの実装クラス2: NoSQLを使用 class NoSQLUserRepository(UserRepository): def get_user(self, user_id: int): """""" # NoSQLからユーザーを取得する処理 shimakaze-soft 34 -
DIP(依存関係逆転の原則)について DIPを適用することで、以下のような利点が得られる。 柔軟性: 抽象に依存することで、モジュール間の結合度が低くなり、コードの変更 や追加が容易になります。 再利用性: 抽象に依存することで、具体的な実装を変更することなく、他の部分で 再利用が容易になります。 テスタビリティ: 抽象に依存することで、テスト時に具体的な実装をモックやスタ
ブに差し替えることが容易になります。 DIPを適用することで、上記の利点を享受しながらリポジトリパターンの実装を行うこ とができる。 shimakaze-soft 35 -
Pythonでのリポジトリパターン実装例 抽象クラスを使ってリポジトリのインターフェースを定義する。 このクラスを継承した具象クラスは、 find_by_id と save メソッドが必ず実装されて いることがわかる。 from abc
import ABC, abstractmethod class UserRepository(ABC): @abstractmethod def find_by_id(self, user_id: int): pass @abstractmethod def save(self, user: User): pass shimakaze-soft 37 -
Pythonでのリポジトリパターン実装例 具体的なリポジトリの実装を行う。 import sqlite3 from typing import Optional # ここでは、データベースとしてSQLiteを使用している。
class SqliteUserRepository(UserRepository): def __init__(self, db_path: str): self.conn = sqlite3.connect(db_path) def find_by_id(self, user_id: int) -> Optional[User]: cursor = self.conn.cursor() cursor.execute("SELECT id, name FROM users WHERE id=?", (user_id,)) result = cursor.fetchone() if result: return User(result[0], result[1]) else: return None def save(self, user: User): cursor = self.conn.cursor() cursor.execute("INSERT OR REPLACE INTO users (id, name) VALUES (?, ?)", (user.id, user.name)) self.conn.commit() shimakaze-soft 38 -
ビジネスロジックの実装 以下のコードはユーザーの登録と更新に関するビジネスロジックが実装されている。 class UserService: def __init__(self, user_repository: UserRepository): self.user_repository =
user_repository def register_user(self, user: User): existing_user = self.user_repository.find_by_id(user.id) if existing_user: raise ValueError("ユーザーIDが既に存在しています") self.user_repository.save(user) def update_user(self, user: User): existing_user = self.user_repository.find_by_id(user.id) if not existing_user: raise ValueError("ユーザーが見つかりません") self.user_repository.save(user) shimakaze-soft 41 -
ビジネスロジックの実装 UserServiceはリポジトリインターフェースを使用してデータアクセスを行っており、 データストレージの具体的な実装に依存していない。 class UserService: def __init__(self, user_repository: UserRepository): self.user_repository
= user_repository def register_user(self, user: User): existing_user = self.user_repository.find_by_id(user.id) if existing_user: raise ValueError("ユーザーIDが既に存在しています") self.user_repository.save(user) def update_user(self, user: User): existing_user = self.user_repository.find_by_id(user.id) if not existing_user: raise ValueError("ユーザーが見つかりません") self.user_repository.save(user) shimakaze-soft 42 -
ビジネスロジックの実装 先ほど作成した SqliteUserRepository という具象クラスを UserService のインスス タンス生成時に引数として渡す。 UserService はユーザーの作成・取得のためのデータストレージへのアクセス方法の 詳細については知らない。
# user_repository変数の引数には、抽象クラスでありインターフェースのUserRepositoryを使用 user_repository: UserRepository = SqliteUserRepository() service: UserService = UserService(user_repository=user_repository) これにより、ビジネスロジックはデーターアクセスとは独立してテストや保守が行い やすくなる。 shimakaze-soft 43 -
リポジトリパターンの利点 - (2) テストの容易性 リポジトリインターフェース(または抽象クラス)を使って実装を行うことで、テスト 時にリポジトリのモックやスタブを簡単に差し替えることができる。 これにより、単体テストや結合テストが容易になり、コードの品質を向上させること ができる。 拡張性 データアクセスの実装を交換することが容易になる。
例えば、データストレージの変更やデータアクセスの最適化を行いたい場合、リポジ トリの実装を追加・変更するだけで対応できる。 これにより、アプリケーションの拡張性が向上する。 shimakaze-soft 46 -
実践的なリポジトリパターンの例 - (1) キャッシュ機能を持つリポジトリのインターフェースを定義する。 from abc import ABC, abstractmethod from
typing import Optional class CachingUserRepository(ABC): @abstractmethod def find_by_id(self, user_id: int) -> Optional[User]: pass @abstractmethod def save(self, user: User): pass @abstractmethod def clear_cache(self): pass shimakaze-soft 52 -
実践的なリポジトリパターンの例 - (2) キャッシュ機能を持つリポジトリの具象クラスの実装を行う。 class InMemoryCachingUserRepository(CachingUserRepository): def __init__(self, user_repository: UserRepository):
self.user_repository = user_repository self.cache = {} def find_by_id(self, user_id: int) -> Optional[User]: if user_id in self.cache: return self.cache[user_id] else: user = self.user_repository.find_by_id(user_id) if user: self.cache[user_id] = user return user def save(self, user: User): self.user_repository.save(user) self.cache[user.id] = user def clear_cache(self): self.cache.clear() shimakaze-soft 53 -
リポジトリパターンの応用 - (2) 検索機能の追加 リポジトリパターンを用いることで、検索機能を簡単に追加することができる。 リポジトリに検索条件を受け取るメソッドを追加することで、データストレージから 条件に合ったデータを取得できる。 トランザクションの管理 リポジトリパターンを使うことで、データアクセスのトランザクション管理が容易に なる。
リポジトリにトランザクション開始やコミット、ロールバックのメソッドを追加する ことで、データストレージのトランザクションを一元管理できる。 shimakaze-soft 57