Посетитель

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

#include <vector>
#include <iostream>
#include <memory>
using namespace std;

class Engine;
class Wheel;
class Car;

//Visitor
class CarVisitor {
public:
    virtual ~CarVisitor() = default;
    virtual void visit(Engine* engine) = 0;
    virtual void visit(Wheel* wheel) = 0;
    virtual void visit(Car* car) = 0;
};

class Element {
public:
    virtual ~Element() = default;
    virtual void accept(CarVisitor* v) = 0;
};

//ConcreteElement
class Engine: public Element {
public:
    void accept(CarVisitor* v) override {
        v->visit(this);
    }
};

//ConcreteElement
class Wheel: public Element {
private:
    int number;

public:
    explicit Wheel(int number)
        : number(number) {}

    int getNumber() {
        return number;
    }

    void accept(CarVisitor* v) override {
        v->visit(this);
    }
};

//ConcreteElement
class Car: public Element {
private:
    vector<unique_ptr<Element>> items;

public:
    Car() {
        items.push_back(make_unique<Engine>());
        for (int i = 1; i <= 4; i++) {
            items.push_back(make_unique<Wheel>(i));
        }
    }

    void accept(CarVisitor* v) override {
        for (const unique_ptr<Element>& e : items) {
            e->accept(v);
        }
        v->visit(this);
    }
};

//ConcreteVisitor
class TestCarVisitor: public CarVisitor {
public:
    void visit(Engine*) override {
        cout << "test engine\n";
    }

    void visit(Wheel* wheel) override {
        cout << "test wheel #" <<
        wheel->getNumber() << "\n";
    }

    void visit(Car*) override {
        cout << "test car\n";
    }
};

//ConcreteVisitor
class RepairCarVisitor: public CarVisitor {
public:
    void visit(Engine*) override {
        cout << "repair engine\n";
    }

    void visit(Wheel* wheel) override {
        cout << "repair wheel #" <<
        wheel->getNumber() << "\n";
    }

    void visit(Car*) override {
        cout << "repair car\n";
    }
};

//Client
Car car;
TestCarVisitor v1;
RepairCarVisitor v2;

car.accept(&v1);
//printed: test engine
//         test wheel #1
//         test wheel #2
//         test wheel #3
//         test wheel #4
//         test car
car.accept(&v2);
//printed: repair engine
//         repair wheel #1
//         repair wheel #2
//         repair wheel #3
//         repair wheel #4
//         repair car


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

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

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

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

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

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