Посетитель

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

trait Element {
    fn accept(&self, v: &Box<dyn CarVisitor>);
}

//ConcreteElement
struct Engine {}
impl Element for Engine {
    fn accept(&self, v: &Box<dyn CarVisitor>) {
        v.visit_engine(self);
    }
}

//ConcreteElement
struct Wheel {
    number: i8
}
impl Element for Wheel {
    fn accept(&self, v: &Box<dyn CarVisitor>) {
        v.visit_wheel(self);
    }
}

//ConcreteElement
struct Car {
    items: Vec<Box<dyn Element>>
}
impl Car {
    fn new() -> Car {
        Car {
            items: vec![ Box::new(Engine{}),
                Box::new(Wheel{ number: 1 }),
                Box::new(Wheel{ number: 2 }),
                Box::new(Wheel{ number: 3 }),
                Box::new(Wheel{ number: 4 })]
        }
    }
}
impl Element for Car {
    fn accept(&self, v: &Box<dyn CarVisitor>) {
        v.visit_car(self);
        for e in &self.items {
            e.accept(v);
        }
    }
}

//Visitor
trait CarVisitor {
    fn visit_engine(&self, engine: &Engine);
    fn visit_wheel(&self, wheel: &Wheel);
    fn visit_car(&self, car: &Car);
}

//ConcreteVisitor
struct TestCarVisitor {}
impl CarVisitor for TestCarVisitor {
    fn visit_engine(&self, _engine: &Engine) {
        println!("- test engine");
    }

    fn visit_wheel(&self, wheel: &Wheel) {
        println!("- test wheel #{}", wheel.number);
    }

    fn visit_car(&self, _car: &Car) {
        println!("test car:");
    }    
}

//ConcreteVisitor
struct RepairCarVisitor {}
impl CarVisitor for RepairCarVisitor {
    fn visit_engine(&self, _engine: &Engine) {
        println!("- repair engine");
    }

    fn visit_wheel(&self, wheel: &Wheel) {
        println!("- repair wheel #{}", wheel.number);
    }

    fn visit_car(&self, _car: &Car) {
        println!("repair car:");
    }    
}

//Client
let car = Car::new();
let v1: Box<dyn CarVisitor> = Box::new(
    TestCarVisitor{});
let v2: Box<dyn CarVisitor> = Box::new(
    RepairCarVisitor{});

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


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

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

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

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

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

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