Посетитель

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

<?php

interface Element {
    function accept(CarVisitor $v);
}

//ConcreteElement
class Engine implements Element {
    function accept(CarVisitor $v) {
        $v->visitEngine($this);
    }
}

//ConcreteElement
class Wheel implements Element {
    private $number = 0;

    function __construct(int $number) {
        $this->number = $number;
    }

    function getNumber(): int {
        return $this->number;
    }

    function accept(CarVisitor $v) {
        $v->visitWheel($this);
    }
}

//ConcreteElement
class Car implements Element {
    public $items = [];

    function __construct(){
        $this->items = [new Engine(), 
            new Wheel(1), new Wheel(2), 
            new Wheel(3), new Wheel(4)];
    }

    function accept(CarVisitor $v) {
        foreach ($this->items as $e) {
            $e->accept($v);
        }
        $v->visitCar($this);
    }
}

//Visitor
interface CarVisitor {
    function visitEngine(Engine $engine);
    function visitWheel(Wheel $wheel);
    function visitCar(Car $car);
}

//ConcreteVisitor
class TestCarVisitor implements CarVisitor {
    function visitEngine(Engine $engine) {
        echo "test engine", "\n";
    }

    function visitWheel(Wheel $wheel) {
        echo "test wheel #", $wheel->getNumber(), "\n";
    }

    function visitCar(Car $car) {
        echo "test car", "\n";        
    }
}

//ConcreteVisitor
class RepairCarVisitor implements CarVisitor {
    function visitEngine(Engine $engine) {
        echo "repair engine", "\n";
    }

    function visitWheel(Wheel $wheel) {
        echo "repair wheel #", $wheel->getNumber(), "\n";
    }

    function visitCar(Car $car) {
        echo "repair car", "\n";        
    }
}

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

$car->accept($v1);
$car->accept($v2);


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

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

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

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

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

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