Посетитель на C#

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

using System;

//Client
var car = new Car();
var v1 = new TestCarVisitor();
var v2 = new RepairCarVisitor();

car.Accept(v1);
car.Accept(v2);

interface IElement {
    void Accept(ICarVisitor v);
}

//ConcreteElement
class Engine: IElement {
    public void Accept(ICarVisitor v) {
        v.Visit(this);
    }
}

//ConcreteElement
class Wheel: IElement {
    readonly int _number;

    public Wheel(int number) {
        _number = number;
    }

    public int GetNumber() {
        return _number;
    }

    public void Accept(ICarVisitor v) {
        v.Visit(this);
    }
}

//ConcreteElement
class Car: IElement {
    readonly IElement[] _items = {
        new Engine(),
        new Wheel(1), new Wheel(2),
        new Wheel(3), new Wheel(4)};

    public void Accept(ICarVisitor v) {
        foreach (var e in _items) {
            e.Accept(v);
        }
        v.Visit(this);
    }
}

//Visitor
interface ICarVisitor {
    void Visit(Engine engine);
    void Visit(Wheel wheel);
    void Visit(Car car);
}

//ConcreteVisitor
class TestCarVisitor: ICarVisitor {
    public void Visit(Engine engine) {
        Console.WriteLine("test engine");
    }

    public void Visit(Wheel wheel) {
        Console.WriteLine("test wheel #" +
            wheel.GetNumber());
    }

    public void Visit(Car car) {
        Console.WriteLine("test car");
    }
}

//ConcreteVisitor
class RepairCarVisitor: ICarVisitor {
    public void Visit(Engine engine) {
        Console.WriteLine("repair engine");
    }

    public void Visit(Wheel wheel) {
        Console.WriteLine("repair wheel #" +
            wheel.GetNumber());
    }

    public void Visit(Car car) {
        Console.WriteLine("repair car");
    }
}

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

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

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

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

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

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