Паттерны проектирования Python

Паттерн проектирования Proxy в Python

В этом уроке вы с помощью паттерна Proxy отложите создание дорогого объекта до момента, когда он действительно понадобится.

  • Продвинутый
  • Чтение: 2 мин
  • Примеров для запуска: 1

Введение

Какую задачу это решает

Некоторые объекты дорого создавать, например большой отчёт или удалённое соединение, и они могут даже не понадобиться. Другим нужна защита, например проверка доступа перед использованием. Proxy стоит перед настоящим объектом и решает, когда и нужно ли его использовать.

Пример из жизни

Заместитель (proxy) похож на название отчёта в списке документов. Название лёгкое и всегда под рукой, оно стоит вместо тяжёлого файла. Сам файл загружается только тогда, когда вы впервые его открываете, и потом остаётся открытым для всех следующих просмотров.

От списка документов к коду
ReportProxy()📄 Название в списке: лёгкое и всегда доступно
if self._report is None:🤔 Файл уже загружен?
self._report = Report()📥 Загрузить настоящий отчёт, только один раз
self._report.display()📖 Показать содержимое настоящего отчёта
Proxy предлагает тот же метод и управляет доступом к настоящему объекту.
Одним предложением

Шаблон Proxy ставит перед настоящим объектом объект-заместитель с тем же интерфейсом, чтобы управлять доступом к нему.

Главное

  1. ReportProxy предлагает тот же метод display(), что и Report.
  2. self._report начинается с None, поэтому дорогой отчёт ещё не создан.
  3. Первый вызов display() выводит "Loading report" и создаёт настоящий Report.
  4. Следующие вызовы используют self._report без повторной загрузки.

Когда это нужно?

  • Ленивая загрузка дорогих объектов, например больших файлов или изображений.
  • Контроль доступа, логирование или кэширование перед объектом.
  • Локальные заместители удалённых сервисов.

Когда это не нужно

  • Настоящий объект дешёвый и нужен всегда: proxy только добавляет слой.
  • functools.cached_property в Python уже даёт ленивую загрузку для одного атрибута.

Пример кода

Запустить код →
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

Закончили этот урок?

Отметьте его как изученный, чтобы следить за прогрессом.