Посетитель на TypeScript

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

interface IElement {
    accept(v: ICarVisitor): void
}

//ConcreteElement
class Engine {
    accept(v: ICarVisitor) {
        v.visitEngine(this)
    }
}

//ConcreteElement
class Wheel {
    private number: number

    constructor(number: number) {
        this.number = number
    }

    getNumber() {
        return this.number;
    }

    accept(v: ICarVisitor) {
        v.visitWheel(this)
    }
}

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

    accept(v: ICarVisitor) {
        for (let i in this.items) {
            if (this.items.hasOwnProperty(i)) {
                this.items[i].accept(v)
            }
        }
        v.visitCar(this)
    }
}

//Visitor
interface ICarVisitor {
    visitEngine(engine: Engine): void
    visitWheel(wheel: Wheel): void
    visitCar(car: Car): void
}

//ConcreteVisitor
class TestCarVisitor implements ICarVisitor {
    visitEngine(engine: Engine) {
        console.log("test engine")
    }

    visitWheel(wheel: Wheel) {
        console.log("test wheel #" +
            wheel.getNumber())
    }

    visitCar(car: Car) {
        console.log("test car")
    }
}

//ConcreteVisitor
class RepairCarVisitor implements ICarVisitor {
    visitEngine(engine: Engine) {
        console.log("repair engine")
    }

    visitWheel(wheel: Wheel) {
        console.log("repair wheel #" +
            wheel.getNumber())
    }

    visitCar(car: Car) {
        console.log("repair car")
    }
}

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

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

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

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

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

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

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

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