Visitor パターンとは？例でわかりやすく解説

目的と解決する問題

目的：オブジェクト構造の要素に対して行う操作を表現することです。Visitor は、操作の対象となる要素のクラスを変更せずに、新しい操作を定義できるようにします。Gang of Four（GoF）の書籍にある振る舞いパターンの 1 つです。

描画プログラムに、Circle、Rectangle、Group の 3 つの図形クラスがあるとします。時間がたつにつれて、それらに対して多くの操作が必要になります。合計面積の計算、SVG への出力、JSON への出力、図形の数のカウント、重なりのチェックなどです。すべての操作を各図形クラスのメソッドにすると、図形クラスが、図形であることとは無関係なコードで肥大化し、新しい操作を足すたびにすべてのクラスに手を入れることになります。

Visitor を使うと、各操作が 1 つのクラス（面積の Visitor、SVG の Visitor）になり、そこにすべての図形の型に対するコードが入ります。図形に必要なのは、汎用的なメソッド accept 1 つだけです。操作を追加するには新しい Visitor を 1 つ書くだけで、図形クラスは変わりません。

構造と登場する役割

accept が必要な理由：TypeScript、Java、C# では、メソッド呼び出しは、呼び出された対象のオブジェクトの型から実装を選びます（シングルディスパッチ）。accept の呼び出しは要素の型でディスパッチし、その内側の visitor.visitCircle(this) のような呼び出しは、Visitor の型でディスパッチします。この 2 つを合わせたものがダブルディスパッチです。

TypeScript での実装

Visitor のインターフェースは戻り値の型についてジェネリックなので、ある Visitor は数値を計算し、別の Visitor は文字列を生成できます。

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>

図形の数を数えるような 3 つ目の操作は、ShapeVisitor<number> を実装する新しいクラスになります。図形クラスは何も変わりません。

TypeScript での代替案：union 型と switch

TypeScript では、判別可能な union 型と網羅的な switch を使えば、少ないコードで同じ利点の多くが得られます。case が不足していればコンパイラがエラーを報告するので、Visitor のインターフェースが提供する安全性の代わりになります。

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 のコードベースが、クラスベースの Visitor の代わりに採用しています。

使うべき場面と避けるべき場面

• 要素クラスの集合が安定していて、構文木に対する評価、出力、型チェック、最適化のように、互いに無関係な多数の操作が必要なときに使います。
• 操作のコードをまとめておきたいときに使います。SVG への出力のすべてが、多くのクラスに散らばらず、1 つの Visitor にあります。
• シンボルテーブルや累計のように、構造をたどりながら状態を蓄積する Visitor が必要なときに使います。
• 要素の型が頻繁に変わる場合は使いません。変更のたびに、すべての Visitor に影響が及びます。
• 要素が少なく、操作も単純な場合は使いません。クラスのメソッドや、switch を使った関数のほうが読みやすくなります。
• Visitor は通常、要素のデータにアクセスする必要があるため、フィールドを公開せざるを得なくなる場合がある点に注意してください。

実際の利用例

• Babel のプラグインは Visitor です。Identifier や CallExpression のようにノードの型にちなんだ名前のメソッドを持つオブジェクトで、@babel/traverse が構文木をたどりながらそれを呼び出します。
• ESLint のルールは、ノードの型をキーにした Visitor メソッドのオブジェクトを返し、ESLint が走査中にそれらを呼び出します。
• Python の ast.NodeVisitor と ast.NodeTransformer クラスは、visit_Name のようにノードのクラス名にちなんだ visit_ メソッドを呼び出します。
• Java の java.nio.file.FileVisitor は、Files.walkFileTree と一緒に使われ、ファイルツリー内の各ディレクトリとファイルについてコールバックを受け取ります。

関連するパターン