Pythonデザインパターン

PythonのAdapterパターン

このレッスンでは、Adapterパターンを使って、別のインターフェースを持つ古いクラスを、新しいインターフェースを必要とするコードにつなぎます。

  • 上級
  • 約2分で読めます
  • 実行できるサンプル 1 件

はじめに

どんな問題を解決するか

古い決済システムやサードパーティーのライブラリなど、変更できないコードを使わなければならないことがよくあります。ところが、そのメソッドがプログラムのほかの部分の想定と合わないことがあります。呼び出し側をすべて書き直すのは危険です。そこで、アダプターが両者の間に入って変換します。

身近なたとえ

アダプターは旅行用の変換プラグのようなものです。ノートパソコンのプラグは自宅のコンセントに合いますが、ホテルのコンセントは形が違います。変換プラグが間に入るので、ノートパソコンにも壁のコンセントにも手を加える必要がありません。

旅行用プラグからコードへ
gateway.pay(25)🔌 手持ちのプラグ:ドルで支払う
PaymentAdapter🔁 間に入る変換プラグ
round(dollars * 100)💱 ドルをセントに変換する
make_payment(cents)🧱 古いコンセント:セントしか受け付けない
アダプターが呼び出しを変換し、どちらの側も変わりません。
ひと言でいうと

Adapter パターンは、インターフェースが合わないオブジェクトを別のクラスで包むパターンです。包むクラスは呼び出し側が期待するインターフェースを用意し、呼び出しを1つずつ変換します。

重要なポイント

  1. LegacyGateway は make_payment(cents) しか持っていません。
  2. PaymentAdapter は、プログラムのほかの部分が呼びたいメソッド pay(dollars) を提供します。
  3. round(dollars * 100) は make_payment を呼ぶ前にドルをセントに変換します。
  4. gateway.pay(25) は LegacyGateway を一切変えずに動きます。

どんな場面で使う?

  • 古いコードやサードパーティーのコードを、プログラムが期待するインターフェース越しに使う。
  • 決済やメールのサービスなど、呼び出し側を変えずに提供元を切り替える。
  • システムの境界で単位やデータ形式を変換する。

使わなくてよいとき

  • 両側とも自分で変更できるコードで、どちらかの名前や中身を直せば済む場合。
  • インターフェースの違いが大きく、ロジックのほとんどがアダプターに入ってしまう場合:境界を設計し直します。

サンプルコード

コードを実行 →
main.py
class LegacyGateway:
    # Adapter: wrap an incompatible API with the expected interface.
    def make_payment(self, cents):
        return f"PAY {cents / 100:.2f}"


class PaymentAdapter:
    def __init__(self, gateway):
        self.gateway = gateway

    def pay(self, dollars):
        # Translate both the method name and amount format.
        return self.gateway.make_payment(round(dollars * 100))


gateway = PaymentAdapter(LegacyGateway())
print(gateway.pay(25))
この例の実行ボタンを作成

実行結果

PAY 25.00

コードの解説

クラスLegacyGatewayには、金額をセント単位で受け取るmake_payment()メソッドしかありませんが、新しいコードはpay()を呼びたいと考えています。クラスPaymentAdapterはLegacyGatewayを包み込み、pay()の呼び出しを適切な単位のmake_payment()に変換するので、結果はPAY 25.00になります。

値を変更し、PythonをインストールせずにCodeUtilityオンラインPythonコンパイラで実行できます。

発展問題

下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。

  1. パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
  2. パターンをより単純な実装と比較し、トレードオフを説明してください。
  3. 別の実装を追加する前に、各参加要素のテストを書いてください。
Pythonコンパイラで実行 →

よくある間違い

値の変換を忘れる

メソッド名を変えただけでは、セントが必要な所にドルを送ってしまいます。

問題
def pay(self, dollars):
    return self.gateway.make_payment(dollars)
修正
def pay(self, dollars):
    return self.gateway.make_payment(round(dollars * 100))

このレッスンを終えましたか?

学習済みにすると進み具合を記録できます。

チャレンジで練習する

このレッスンの内容を使って実際の問題を解きましょう。各チャレンジはブラウザで動き、すぐにテストされ、AI のレビューも受けられます。

すべてのチャレンジ