モジュール性を高めるテクニック: 戻り値を通じた実装の詳細の漏洩を防ぐ

コードの可読性と保守性を向上させるためには、モジュール性を高めることが重要です。
そのために、実装の詳細を隠蔽し、適切な抽象化レイヤーを維持します。
その際、メソッドの戻り値を通じて実装の詳細が漏洩することに注意が必要です。

本記事では、戻り値から実装の詳細が漏洩することによる問題点と、その解決策について解説します。
サンプルコードを交えながら、抽象化レイヤーを維持するための戻り値の設計について見ていきましょう。

この記事を通じて、より保守性の高いコードを書くための具体的な手法を学びます。

戻り値からの実装の詳細の漏洩による問題

以下のコードは、ユーザーの連絡先情報を取得するための get_user_contact メソッドの例です。

def get_user_contact(self, user_id):
    query = f"SELECT * FROM contacts WHERE user_id = {user_id}"
    result = self.database.execute_query(query)
    if result:
        return result[0]
    else:
        return None

この例では、get_user_contact メソッドは、データベースクエリの結果を直接返しています。
result[0] という表現は、result がリスト又はタプルであり、その最初の要素を返していることを示唆しています。

このコードの問題点は以下の通りです。

戻り値の型が不明確
result[0] が何を表しているのか、呼び出し側のコードからは明確ではありません。
リストやタプルの構造に依存しているため、実装の変更に脆弱です。

データベース固有の型に依存
result は、データベースクエリの結果であり、データベース固有の型（例えば、sqlite3.Row）である可能性があります。
呼び出し側のコードが、このようなデータベース固有の型に依存してしまうと、実装の変更が難しくなります。

エラーハンドリングが不十分
result が空の場合、result[0] はエラーを発生させます。
適切なエラーハンドリングが行われていないため、呼び出し側のコードがクラッシュする可能性があります。

これらの問題は、戻り値を通じて実装の詳細が漏洩することによって引き起こされています。
モジュール間の結合度が高くなり、保守性が低下します。

解決策: 抽象化レイヤーに適した戻り値の設計

上記の問題を解決するために、以下のように戻り値の設計を改善することができます。

from dataclasses import dataclass
from typing import Optional

@dataclass
class Contact:
    phone: str
    email: str
    address: str

class ContactRepository:
    def __init__(self, database):
        self.database = database
    
    def get_by_user_id(self, user_id: int) -> Optional[dict]:
        query = "SELECT phone, email, address FROM contacts WHERE user_id = %s"
        result = self.database.execute_query(query, (user_id,))
        if result:
            return result[0]
        return None

この ContactRepository クラスでは、データベースアクセスの詳細が隠蔽されています。
get_by_user_id メソッドはデータベースクエリを実行し、その結果を返す形です。

そして、呼び出し側はデータベースの具体的な型に依存しません。
次に、ContactService クラスで、Contact データクラスを使用して戻り値をラップします。

この ContactRepository クラスでは、データベースアクセスの詳細が隠蔽されています。
get_by_user_id メソッドはデータベースクエリを実行し、その結果を返す形です。

そして、呼び出し側はデータベースの具体的な型に依存しません。
次に、ContactService クラスで、Contact データクラスを使用して戻り値をラップします。

この ContactService クラスでは、ContactRepository を利用してデータを取得し、Contact データクラスのインスタンスを返します。
これにより、戻り値の型が明確になり、呼び出し側のコードは Contact オブジェクトの属性を直接利用できます。

以下は、これらのクラスを使用してユーザーの連絡先情報を取得する例です。

database = ...  # 具体的なデータベース接続の初期化コード
contact_repository = ContactRepository(database)
contact_service = ContactService(contact_repository)

user_contact = contact_service.get_user_contact(123)
if user_contact:
    print(f"Phone: {user_contact.phone}, Email: {user_contact.email}, Address: {user_contact.address}")
else:
    print("User contact not found")

この改善された例では、以下のような利点があります。

戻り値の型が明確
Contact データクラスを使用することで、戻り値の型が明確になります。
データクラスは、電話番号、メールアドレス、住所のフィールドを持ち、呼び出し側はこれらのフィールドを直接利用できます。

データベース固有の型に依存しない
ContactRepository を介してデータを取得することで、データベース固有の型に依存しなくなります。
ContactRepository はデータベースアクセスの詳細を隠蔽し、データベースクエリを実行して結果を取得します。

エラーハンドリングが適切
get_by_user_id メソッドは、データが見つからない場合に None を返します。
呼び出し側は None チェックを行い、適切な処理を行うことができます。
例えば、ユーザーが見つからない場合のエラーメッセージを表示したり、デフォルトの連絡先情報を使用したりすることが可能です。

型ヒントの使用
Optional を使用して、戻り値が None である可能性を明示しています。
これにより、コードの可読性が向上し、IDEによる補完やエラーチェックが可能になります。

これらの改善により、以下のような利点が得られます。