Python 访问者 - Code Recipes

设计模式 / 行为型模式

from abc import ABC, abstractmethod

class Element(ABC):
    @abstractmethod
    def accept(self, v):
        pass

# ConcreteElement
class Engine(Element):
    def accept(self, v):
        v.visit_engine(self)

# ConcreteElement
class Wheel(Element):
    def __init__(self, number):
        self.number = number

    def accept(self, v):
        v.visit_wheel(self)

# ConcreteElement
class Car(Element):
    def __init__(self):
        self.items = [
            Engine(),
            Wheel(1), Wheel(2),
            Wheel(3), Wheel(4)]

    def accept(self, v):
        for e in self.items:
            e.accept(v)
        v.visit_car(self)

# Visitor
class CarVisitor(ABC):
    @abstractmethod
    def visit_engine(self, engine):
        pass

    @abstractmethod
    def visit_wheel(self, wheel):
        pass

    @abstractmethod
    def visit_car(self, car):
        pass

# ConcreteVisitor
class TestCarVisitor(CarVisitor):
    def visit_engine(self, engine):
        print("test engine")

    def visit_wheel(self, wheel):
        print("test wheel #" +
              str(wheel.number))

    def visit_car(self, car):
        print("test car")

# ConcreteVisitor
class RepairCarVisitor(CarVisitor):

    def visit_engine(self, engine):
        print("repair engine")

    def visit_wheel(self, wheel):
        print("repair wheel #" +
              str(wheel.number))

    def visit_car(self, car):
        print("repair car")

# Client
car = Car()
v1 = TestCarVisitor()
v2 = RepairCarVisitor()

car.accept(v1)
car.accept(v2)

Represent an operation to be performed on the elements of an object structure. Visitor lets you define a new operation without changing the classes of the elements on which it operates.

问题。一份文档由段落、图片和表格组成。程序必须能导出文档、统计字数并检查拼写。如果把每个操作都作为方法加到每一种组成部分上，每增加一个操作，这些部分的类就膨胀一次。而且一个操作的代码还会分散在许多类中。

思路。每个操作都变成一个单独的对象，称为访问者。访问者为每一种元素各准备一个方法。每个元素有一个方法，它接收一个访问者，并调用访问者中对应自己种类的方法。这样，每一对元素和操作都会运行正确的代码，无需检查类型。要增加一个新操作，只需编写一个新的访问者；元素类保持不变。

如何阅读示例。元素分为几种。每个具体访问者是一个操作，为每一种元素各有一个单独的方法。客户端代码把访问者交给元素，每个元素再把它送到对应自己种类的方法。在大多数示例中，一个元素包含其他元素，并把访问者交给自己的每个组成部分。随后两个访问者依次经过同样的这些部分，各自执行自己的操作。在某些语言中，元素是带有类型标签的普通数据，访问者是一个函数，为每一种元素各有一个版本。

何时使用。当元素类的集合保持稳定、而针对它们的新操作经常出现时，使用访问者模式。经常增加新的元素种类时不要使用它：每增加一种元素，每个访问者都需要一个新方法。

常见错误。在一个通用的访问者方法内部用条件判断检查元素的类型。这样，新的元素种类会在毫无警告的情况下被遗漏。应为每一种元素提供它自己的方法。