Посетитель

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

interface Element {
    void accept(CarVisitor v);
}

//ConcreteElement
class Engine implements Element {
    public void accept(CarVisitor v) {
        v.visit(this);
    }
}

//ConcreteElement
class Wheel implements Element {
    private int number;

    public Wheel(int number) {
        this.number = number;
    }

    public int getNumber() {
        return number;
    }

    public void accept(CarVisitor v) {
        v.visit(this);
    }
}

//ConcreteElement
class Car implements Element {
    private Element[] items = { 
        new Engine(), 
        new Wheel(1), new Wheel(2), 
        new Wheel(3), new Wheel(4)};

    public void accept(CarVisitor v) {
        for (Element e : items) {
            e.accept(v);
        }
        v.visit(this);
    }
}

//Visitor
interface CarVisitor {
    void visit(Engine engine);
    void visit(Wheel wheel);
    void visit(Car car);
}

//ConcreteVisitor
class TestCarVisitor implements CarVisitor {
    public void visit(Engine engine) {
        System.out.println("test engine");
    }

    public void visit(Wheel wheel) {
        System.out.println("test wheel #" + 
            wheel.getNumber());
    }

    public void visit(Car car) {
        System.out.println("test car");     
    }
}

//ConcreteVisitor
class RepairCarVisitor implements CarVisitor {
    public void visit(Engine engine) {
        System.out.println("repair engine");
    }

    public void visit(Wheel wheel) {
        System.out.println("repair wheel #" + 
            wheel.getNumber());
    }

    public void visit(Car car) {
        System.out.println("repair car");       
    }
}

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

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


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

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

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

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

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

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