コードのモジュール性と再利用性を高めるテクニック: 適切な関数パラメーターの設計

コードのモジュール性と再利用性を向上させることは、長期的なプロジェクトの成功に不可欠です。
本記事では、適切な関数パラメーターの設計を通じて、コードの再利用性と変更への対応力を高める方法について解説します。

過剰な情報を含むパラメーターがもたらす問題

関数が必要以上の情報を含むオブジェクトをパラメーターとして受け取ると、モジュール性が低下し、コードの再利用や変更が困難になる可能性があります。
以下の例で、この問題を具体的に見ていきましょう。

class OrderDetails:
    def __init__(self, order_id, customer_name, items, total_price, shipping_address):
        self.order_id = order_id
        self.customer_name = customer_name
        self.items = items
        self.total_price = total_price
        self.shipping_address = shipping_address

class InvoiceGenerator:
    def generate_invoice(self, order: OrderDetails):
        # 請求書を生成する処理
        invoice = f"請求書 - 注文番号: {order.order_id}\n"
        invoice += f"お客様名: {order.customer_name}\n"
        invoice += f"合計金額: {order.total_price}円\n"
        return invoice

class ShippingLabelPrinter:
    def print_label(self, order: OrderDetails):
        # 配送ラベルを印刷する処理
        label = f"配送先: {order.customer_name}\n"
        label += f"住所: {order.shipping_address}\n"
        return label

この例では、InvoiceGenerator と ShippingLabelPrinter の両方が OrderDetails オブジェクト全体を受け取っています。
これにより以下の問題が生じます。

低い再利用性
これらのメソッドは常に完全な OrderDetails オブジェクトを必要とするため、他の文脈での再利用が難しくなります。

変更への脆弱性
OrderDetails クラスの構造が変更された場合、それに依存するすべてのコードに影響を与える可能性があります。

テストの複雑化
単体テストを行う際、不必要な属性を含む完全な OrderDetails オブジェクトを作成する必要があります。

解決策: 必要最小限の情報をパラメーターとして受け取る

モジュール性と再利用性を高めるために、関数が必要とする最小限の情報のみをパラメーターとして受け取るようにします。
以下は改善されたコードの例です。

class InvoiceGenerator:
    def generate_invoice(self, order_id: str, customer_name: str, total_price: float):
        invoice = f"請求書 - 注文番号: {order_id}\n"
        invoice += f"お客様名: {customer_name}\n"
        invoice += f"合計金額: {total_price}円\n"
        return invoice
class ShippingLabelPrinter:
    def print_label(self, customer_name: str, shipping_address: str):
        label = f"配送先: {customer_name}\n"
        label += f"住所: {shipping_address}\n"
        return label

# 使用例
invoice_gen = InvoiceGenerator()
shipping_printer = ShippingLabelPrinter()


# OrderDetailsオブジェクトがあると仮定
order = OrderDetails("A12345", "山田太郎", ["商品A", "商品B"], 9800, "東京都渋谷区〇〇1-2-3")
# 必要な情報のみを渡す
invoice = invoice_gen.generate_invoice(order.order_id, order.customer_name, order.total_price)
label = shipping_printer.print_label(order.customer_name, order.shipping_address)

この改善により、以下のメリットが得られます。

高い再利用性
メソッドは OrderDetails オブジェクトに依存せず、必要な情報さえあれば他の文脈でも使用できます。

変更への耐性
OrderDetails クラスの構造が変更されても、これらのメソッドへの影響は最小限に抑えられます。

テストの簡素化
単体テストを行う際、必要な情報のみを提供すれば良くなります。

明確な依存関係
各メソッドが必要とする情報が明確になり、コードの理解が容易になります。