访问者模式详解与示例

意图与它要解决的问题

意图：表示一个作用于某对象结构中各元素的操作。访问者让你可以在不改变各元素的类的前提下，定义作用于这些元素的新操作。它是《设计模式》（Gang of Four，GoF）一书中的行为型模式之一。

假设一个绘图程序有三个形状类：Circle、Rectangle 和 Group。随着时间推移，你需要对它们做很多操作：计算总面积、导出为 SVG、导出为 JSON、统计形状数量、检查重叠。如果每个操作都变成每个形状类上的方法，形状类就会塞满与“作为形状”毫无关系的代码，而且每增加一个操作都要改动所有这些类。

使用访问者模式时，每个操作成为一个类（面积访问者、SVG 访问者），其中包含针对每种形状类型的代码。形状只需要一个通用方法 accept。添加操作就是写一个新访问者；形状类保持不变。

结构与参与者

为什么需要 accept：在 TypeScript、Java 和 C# 中，方法调用根据被调用对象的类型来选择实现（单分派）。accept 调用依据元素类型分派，而其内部的调用，例如 visitor.visitCircle(this)，则依据访问者类型分派。两者合起来就是双分派。

TypeScript 实现

访问者接口的返回类型是泛型，因此一个访问者可以计算数字，另一个可以生成字符串。

interface ShapeVisitor<R> {
  visitCircle(c: Circle): R;
  visitRectangle(r: Rectangle): R;
  visitGroup(g: Group): R;
}
interface Shape {
  accept<R>(visitor: ShapeVisitor<R>): R;
}

class Circle implements Shape {
  constructor(readonly radius: number) {}
  accept<R>(v: ShapeVisitor<R>) { return v.visitCircle(this); }
}
class Rectangle implements Shape {
  constructor(readonly width: number, readonly height: number) {}
  accept<R>(v: ShapeVisitor<R>) { return v.visitRectangle(this); }
}
class Group implements Shape {
  constructor(readonly children: Shape[]) {}
  accept<R>(v: ShapeVisitor<R>) { return v.visitGroup(this); }
}

class AreaVisitor implements ShapeVisitor<number> {
  visitCircle(c: Circle) { return Math.PI * c.radius ** 2; }
  visitRectangle(r: Rectangle) { return r.width * r.height; }
  visitGroup(g: Group): number {
    return g.children.reduce((sum, child) => sum + child.accept(this), 0);
  }
}

class SvgVisitor implements ShapeVisitor<string> {
  visitCircle(c: Circle) { return '<circle r="' + c.radius + '"/>'; }
  visitRectangle(r: Rectangle) { return '<rect width="' + r.width + '" height="' + r.height + '"/>'; }
  visitGroup(g: Group): string { return "<g>" + g.children.map((c) => c.accept(this)).join("") + "</g>"; }
}

const drawing = new Group([new Circle(1), new Rectangle(2, 3), new Group([new Rectangle(1, 1)])]);
console.log(drawing.accept(new AreaVisitor()).toFixed(2)); // 10.14
console.log(drawing.accept(new SvgVisitor()));
// <g><circle r="1"/><rect width="2" height="3"/><g><rect width="1" height="1"/></g></g>

第三个操作，例如统计形状数量，只需新增一个实现 ShapeVisitor<number> 的类。所有形状类都不用改。

TypeScript 的替代方案：联合类型加 switch

在 TypeScript 中，可辨识联合类型（discriminated union）加上穷尽的 switch，用更少的代码就能获得许多同样的好处。缺少分支时编译器会报错，这取代了访问者接口所提供的安全性：

type Shape =
  | { kind: "circle"; radius: number }
  | { kind: "rect"; width: number; height: number }
  | { kind: "group"; children: Shape[] };

function area(s: Shape): number {
  switch (s.kind) {
    case "circle": return Math.PI * s.radius ** 2;
    case "rect": return s.width * s.height;
    case "group": return s.children.reduce((sum, c) => sum + area(c), 0);
    default: {
      const unreachable: never = s; // compile error if a kind is not handled
      return unreachable;
    }
  }
}

console.log(area({ kind: "group", children: [{ kind: "rect", width: 2, height: 3 }] })); // 6

每个新操作就是一个新函数。这种风格适合 JSON 或语法树这类纯数据，也是许多 TypeScript 代码库用来取代基于类的访问者的做法。

何时使用，何时不用

• 当元素类有一个稳定的集合，而你需要对它们做许多互不相关的操作时使用，例如对语法树做求值、打印、类型检查和优化。
• 用来把操作代码放在一起：全部 SVG 导出都在一个访问者里，而不是散落在许多类中。
• 当访问者需要在遍历结构时累积状态时使用，例如符号表或累计总数。
• 元素类型经常变化时不要使用；每次变化都会波及所有访问者。
• 元素很少而操作很简单时不要使用。类上的方法，或带 switch 的函数，更容易阅读。
• 要注意，访问者通常需要访问元素的数据，这可能迫使你把字段设为公开。

实际应用

• Babel 插件就是访问者：一个对象，其方法以节点类型命名，如 Identifier 或 CallExpression，@babel/traverse 在遍历语法树时调用它们。
• ESLint 规则返回一个以节点类型为键的访问者方法对象，ESLint 在遍历期间调用这些方法。
• Python 的 ast.NodeVisitor 和 ast.NodeTransformer 类会调用以节点类名命名的 visit_ 方法，例如 visit_Name。
• Java 的 java.nio.file.FileVisitor 与 Files.walkFileTree 配合使用，会为文件树中的每个目录和文件接收回调。

相关模式