Pythonデザインパターン

PythonのProxyパターン

このレッスンでは、Proxyパターンを使って、作るのにコストのかかるオブジェクトの生成を、本当に必要になるまで遅らせます。

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

はじめに

どんな問題を解決するか

大きなレポートやリモート接続のように作るのが高くつき、必要にならないかもしれないオブジェクトがあります。使う前に権限を確認するなど、保護が必要なものもあります。プロキシは本物のオブジェクトの前に立ち、いつ、使うかどうかを決めます。

身近なたとえ

プロキシは、書類一覧に載っている報告書のタイトルのようなものです。タイトルは軽く、いつでもそこにあって、重いファイルの代わりを務めます。ファイルそのものは最初に開いたときに初めて読み込まれ、その後は開いたままなので、何度見てもすぐに表示されます。

書類一覧からコードへ
ReportProxy()📄 一覧のタイトル: 軽くて、いつでも使える
if self._report is None:🤔 ファイルはもう読み込んだ?
self._report = Report()📥 本物の報告書を読み込む(1回だけ)
self._report.display()📖 本物の報告書の中身を表示する
プロキシは同じメソッドを持ち、本物のオブジェクトへのアクセスを制御します。
ひと言でいうと

Proxy パターンは、本物のオブジェクトの前に同じインターフェースを持つ代役のオブジェクトを置き、そのアクセスを制御します。

重要なポイント

  1. ReportProxy は Report と同じ display() メソッドを持ちます。
  2. self._report は最初 None なので、高くつくレポートはまだ作られません。
  3. 最初の display() 呼び出しで "Loading report" と表示し、本物の Report を作ります。
  4. その後の呼び出しは読み込み直さずに self._report を再利用します。

どんな場面で使う?

  • 大きなファイルや画像など、高くつくオブジェクトの遅延読み込み。
  • オブジェクトの前でのアクセス制御、ログ、キャッシュ。
  • リモートサービスの手元の代役。

使わなくてよいとき

  • 本物のオブジェクトが安く、常に必要な場合:プロキシは層を増やすだけです。
  • Python の functools.cached_property で、1つの属性の遅延読み込みはすでにできます。

サンプルコード

コードを実行 →
main.py
class Report:
    # Proxy: stand in for another object and control access to it.
    def display(self): return "Quarterly report"


class ReportProxy:
    def __init__(self): self._report = None

    def display(self):
        # Delay construction until the object is actually needed.
        if self._report is None:
            print("Loading report")
            self._report = Report()
        return self._report.display()


proxy = ReportProxy()
print(proxy.display())
この例の実行ボタンを作成

実行結果

Loading report
Quarterly report

コードの解説

ReportProxyは、作られた時点ではReportオブジェクトを作りません。display()が初めて呼ばれたときにだけ、Loading reportと表示してReportを作り、次回以降のために保存します。これで、リソースを多く使うオブジェクトを本当に必要なときだけ作れます。

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

発展問題

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

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

よくある間違い

コンストラクターで本物のオブジェクトを作る

それでは遅延読み込みの利点がなくなります。

問題
def __init__(self):
    self._report = Report()
修正
def __init__(self):
    self._report = None

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

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