コードの読みやすさと保守性を高めるために、モジュール化は非常に重要です。
本記事では、依存性の注入（Dependency Injection, DI）とインターフェースを使ってコードをモジュール化する方法について解説します。
サンプルコードを交えながら、DIとインターフェースの利点と実践的な適用方法を見ていきましょう。
DIについては、次の記事で説明しています。
ハードコーディングされた依存関係の問題点
以下のコードは、ユーザー認証を行うAuthenticatorクラスの一部です。
class Authenticator:
def __init__(self):
self.user_repository = MySQLUserRepository()
def authenticate(self, username, password):
user = self.user_repository.find_by_username(username)
if user and user.password == password:
return True
return False
このAuthenticatorクラスは、ユーザー情報を取得するためにMySQLUserRepositoryクラスに依存しています。
しかし、この依存関係はAuthenticatorクラスのコンストラクタ内でハードコーディングされています。
つまり、Authenticatorクラスは常にMySQLデータベースからユーザー情報を取得することになります。
この実装には以下のような問題があります。
- 他のデータベースやデータ取得方法に切り替えることができない
- テストの際に、実際のMySQLデータベースに依存してしまう
MySQLUserRepositoryクラスの変更がAuthenticatorクラスに影響を与える
これらの問題は、クラス間の密結合によって引き起こされています。
DIとインターフェースを使った依存関係の注入
上記の問題を解決するために、DIとインターフェースを使ってUserRepositoryをAuthenticatorクラスに注入してみましょう。
from abc import ABC, abstractmethod
class UserRepository(ABC):
@abstractmethod
def find_by_username(self, username):
pass
class MySQLUserRepository(UserRepository):
def find_by_username(self, username):
# MySQLデータベースからユーザー情報を取得する処理
pass
class MongoDBUserRepository(UserRepository):
def find_by_username(self, username):
# MongoDBデータベースからユーザー情報を取得する処理
pass
class Authenticator:
def __init__(self, user_repository: UserRepository):
self.user_repository = user_repository
def authenticate(self, username, password):
user = self.user_repository.find_by_username(username)
if user and user.password == password:
return True
return False
この変更点は以下の通りです。
- UserRepositoryインターフェースを定義し、find_by_usernameメソッドを抽象メソッドとして宣言しました。
- MySQLUserRepositoryクラスとMongoDBUserRepositoryクラスは、UserRepositoryインターフェースを実装しています。
- Authenticatorクラスのコンストラクタは、UserRepositoryインスタンスを受け取るようになりました。
これにより、以下のようなメリットが得られます。
- データベースやデータ取得方法を柔軟に切り替えられる
- テストの際に、モックオブジェクトを注入できる
- UserRepositoryの実装変更がAuthenticatorクラスに影響を与えない
ファクトリ関数の活用
DIを使ったコードは、モジュール化と柔軟性が向上する一方で、クラスの構築が少し複雑になるというデメリットがあります。
この問題を軽減するために、ファクトリ関数を活用することができます。
def create_mysql_authenticator():
mysql_repo = MySQLUserRepository()
return Authenticator(mysql_repo)
def create_mongodb_authenticator():
mongodb_repo = MongoDBUserRepository()
return Authenticator(mongodb_repo)
これらのファクトリ関数を使うことで、必要な依存関係を簡単に構築できます。
authenticator = create_mysql_authenticator()
result = authenticator.authenticate("john_doe", "password123")
ファクトリ関数を使えば、依存関係の構築をカプセル化し、コードの可読性を高めることができるでしょう。
まとめ
依存性の注入（DI）とインターフェースは、コードのモジュール化と柔軟性を高めるための強力な手法です。
ハードコーディングされた依存関係を避け、インターフェースを使って依存関係を注入することで、コードの結合度を下げることができます。
また、ファクトリ関数を活用することで、依存関係の構築を簡素化し、コードの可読性を高めることができます。
DIとインターフェースを効果的に使うことで、より保守性の高いコードを書くことができるでしょう。
是非、皆さんのプロジェクトにDIとインターフェースを取り入れてみてください。
