Паттерн проектирования Visitor в Python
В этом уроке вы с помощью паттерна Visitor добавите новые операции группе объектов, не меняя их классы.
Введение
Какую задачу это решает
У вас есть устойчивый набор классов, например фигуры или товары, и вы постоянно добавляете новые операции: общая цена, налог, экспорт в JSON. Если добавлять каждую операцию методом в каждый класс, одна функция расползается по многим файлам.
Пример из жизни
Шаблон Visitor похож на налогового инспектора, который посещает разные магазины. Каждый магазин просто впускает инспектора и говорит, что это за магазин. Инспектор носит с собой правила для каждого вида магазинов, поэтому новые правила - это новый инспектор, а не изменения в каждом магазине.
item.accept(visitor)🚪 Магазин впускает инспектораvisitor.visit_book(self)🏷️ Он говорит, что это за магазинPriceVisitor🧾 Инспектор с правилами15💰 Сумма за книгу и фильмШаблон Visitor выносит операцию из группы классов элементов в отдельный объект-посетитель; каждый элемент вызывает метод посетителя, соответствующий его собственному типу.
Главное
Book.acceptвызываетvisitor.visit_book(self);Movie.acceptвызываетvisitor.visit_movie(self).PriceVisitorхранит правила цен для обоих типов.sum(item.accept(visitor) for item in [Book(), Movie()])складывает 10 и 5.- Новая операция, например налог, стала бы новым классом-посетителем без изменения
BookилиMovie.
Когда это нужно?
- Много операций над устойчивым набором типов: цены, экспорт, рисование.
- Обход структур, например синтаксических деревьев в компиляторах.
- Код одной функции в одном месте.
Когда это не нужно
- Новые типы элементов добавляются часто: тогда нужно обновлять каждого посетителя.
- Код на Python, где проще словарь функций по типам или
functools.singledispatch.
Пример кода
class Book:
# Visitor: move new operations outside stable element classes.
def accept(self, visitor): return visitor.visit_book(self)
class Movie:
def accept(self, visitor): return visitor.visit_movie(self)
class PriceVisitor:
def visit_book(self, book): return 10
def visit_movie(self, movie): return 5
# Each element dispatches to the matching visitor method.
visitor = PriceVisitor()
print(sum(item.accept(visitor) for item in [Book(), Movie()]))
Результат выполнения
15
Разбор кода
У каждого элемента есть метод accept(), который вызывает соответствующий метод посетителя: Book вызывает visit_book(), а Movie вызывает visit_movie(). Вся логика цен находится в PriceVisitor, поэтому классам Book и Movie ничего не нужно знать о ценах. Итог 10 + 5 = 15.
Измените значения и запустите программу в онлайн-компиляторе Python CodeUtility без локальной установки Python.
Упражнения для практики
Попробуйте изменить код по подсказкам ниже. Если менять код и смотреть на результат, урок запомнится гораздо лучше, чем при простом чтении.
- Замените предметную область примера, сохранив структуру паттерна.
- Сравните паттерн с более простой реализацией и объясните компромиссы.
- Напишите тесты для каждого участника перед добавлением новой реализации.
Частые ошибки
Вызов не того метода посетителя
Элемент должен вызывать метод для своего типа, иначе он получит не те правила.
class Movie:
def accept(self, visitor): return visitor.visit_book(self)
class Movie:
def accept(self, visitor): return visitor.visit_movie(self)
Закончили этот урок?
Отметьте его как изученный, чтобы следить за прогрессом.