Python中級

中級 Pythonで学ぶクリーンアーキテクチャ｜アンチパターン編

 

導入

クリーンアーキテクチャは、ソフトウェア開発における構造的なアプローチを提供し、保守性や拡張性を高めるための重要な手法です。しかし、実際のプロジェクトでは、理想的な実装から逸脱しがちなアンチパターンに遭遇することが多いです。このセクションでは、特に中級のPythonエンジニアが直面する可能性のある具体的なシチュエーションを通じて、クリーンアーキテクチャにおけるアンチパターンを探求します。

教科書レベルの解説（クリーンアーキテクチャ）

重要な概念の整理

クリーンアーキテクチャは、依存関係の逆転を通じて、ビジネスロジックとインフラストラクチャを分離することを目指します。これにより、アプリケーションの各層は独立して変更可能となり、テストやメンテナンスが容易になります。一般的に、アーキテクチャは内側から外側に向かって、エンティティ、ユースケース、インターフェースアダプター、フレームワークといった層で構成されます。

コード例（Python）


class User:
    def __init__(self, user_id, name):
        self.user_id = user_id
        self.name = name

class UserRepository:
    def __init__(self):
        self.users = {}

    def add_user(self, user):
        self.users[user.user_id] = user

    def get_user(self, user_id):
        return self.users.get(user_id)

class UserService:
    def __init__(self, user_repository):
        self.user_repository = user_repository

    def create_user(self, user_id, name):
        user = User(user_id, name)
        self.user_repository.add_user(user)

    def find_user(self, user_id):
        return self.user_repository.get_user(user_id)

コードの行ごとの解説

  1. クラスUserは、ユーザー情報を保持するシンプルなデータモデルです。
  2. UserRepositoryは、ユーザーの追加と取得を行うリポジトリパターンを実装しています。
  3. UserServiceは、ユーザーの作成や検索を行うビジネスロジックを管理します。
  4. この構造により、データアクセスのロジックがサービス層から分離されています。

アンチパターン編

クリーンアーキテクチャの実装において、よく見られるアンチパターンの一つは「リポジトリの過剰な責任」です。例えば、リポジトリがデータベース接続の管理や、ビジネスロジックの一部を含む場合、リポジトリの役割があいまいになり、コードの可読性や保守性が低下します。

以下は、リポジトリがビジネスロジックを持ってしまった例です。


class UserRepository:
    def __init__(self):
        self.users = {}

    def add_user(self, user):
        if self.user_exists(user.user_id):
            raise ValueError("User already exists")
        self.users[user.user_id] = user

    def user_exists(self, user_id):
        return user_id in self.users

上記のコードでは、ユーザーの存在確認がリポジトリ内に実装されていますが、これはリポジトリの責任を超えています。このような場合、ビジネスロジックは別のサービス層に移動させるべきです。これにより、リポジトリはデータの保存と取得に専念でき、コードの整理が進みます。

まとめ

  • クリーンアーキテクチャでは、各層の責任を明確に分けることが重要です。
  • リポジトリにビジネスロジックを持たせることは避け、役割を明確にすることで、コードの可読性と保守性が向上します。
  • このようなアンチパターンを認識し、適切に対処することで、クリーンアーキテクチャの恩恵を最大限に引き出せます。
RELATED POST