Посетитель на Delphi

Паттерны проектирования / Поведенческие паттерны

type
  TCircle = class;
  TSquare = class;

  //visitor adds operations without
  //changing the element classes
  IVisitor = interface
    procedure VisitCircle(C: TCircle);
    procedure VisitSquare(S: TSquare);
  end;

  TShape = class
  public
    procedure Accept(
      const V: IVisitor); virtual; abstract;
  end;

  TCircle = class(TShape)
  public
    procedure Accept(
      const V: IVisitor); override;
  end;

  TSquare = class(TShape)
  public
    procedure Accept(
      const V: IVisitor); override;
  end;

  TAreaVisitor = class(TInterfacedObject,
    IVisitor)
    procedure VisitCircle(C: TCircle);
    procedure VisitSquare(S: TSquare);
  end;

procedure TCircle.Accept(const V: IVisitor);
begin
  V.VisitCircle(Self);
end;

procedure TSquare.Accept(const V: IVisitor);
begin
  V.VisitSquare(Self);
end;

procedure TAreaVisitor.VisitCircle(
  C: TCircle);
begin
  WriteLn('circle area');
end;

procedure TAreaVisitor.VisitSquare(
  S: TSquare);
begin
  WriteLn('square area');
end;

var
Shapes: TArray<TShape>;
Shape: TShape;
Visitor: IVisitor;
begin
Shapes := [TCircle.Create,
    TSquare.Create];
Visitor := TAreaVisitor.Create;

  for Shape in Shapes do
    Shape.Accept(Visitor);
  //circle area
  //square area
end.

Представляет операцию, которую надо выполнить над элементами объекта. Позволяет определить новую операцию, не меняя классы элементов, к которым он применяется.

Задача. Документ состоит из абзацев, картинок и таблиц. Программа должна выгружать его, считать в нём слова и проверять орфографию. Если каждую операцию добавлять методом в каждый вид части, классы частей растут с каждой новой операцией. К тому же код одной операции расползается по многим классам.

Идея. Каждая операция становится отдельным объектом - посетителем. У посетителя по методу на каждый вид элемента. У каждого элемента есть один метод, который принимает посетителя и вызывает его метод для своего вида. Так для каждой пары «элемент и операция» выполняется нужный код, без проверок типа. Чтобы добавить новую операцию, пишут нового посетителя, а классы элементов не меняются.

Как читать пример. Элементы бывают нескольких видов. Каждый конкретный посетитель - одна операция, с отдельным методом на каждый вид элемента. Клиентский код отдаёт посетителя элементам, и каждый элемент направляет его в метод для своего вида. В большинстве примеров один элемент содержит остальные и отдаёт посетителя каждой своей части. Затем два посетителя проходят по одним и тем же частям, каждый со своей операцией. В некоторых языках элементы - обычные данные с меткой типа, а посетитель - одна функция с вариантом для каждого вида.

Когда применять. Посетитель нужен, когда набор классов элементов устойчив, а новые операции над ними появляются часто. Если часто добавляются новые виды элементов, он не годится: каждый новый вид требует нового метода в каждом посетителе.

Частая ошибка. Проверять тип элемента условиями внутри одного общего метода посетителя. Тогда новый вид элемента пропускается без всякого предупреждения. У каждого вида должен быть свой метод.