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

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

interface Element {
    fun accept(v: CarVisitor)
}

//ConcreteElement
class Engine: Element {
    override fun accept(v: CarVisitor) {
        v.visit(this)
    }
}

//ConcreteElement
class Wheel(private val number: Int): Element {

    fun getNumber(): Int {
        return number
    }

    override fun accept(v: CarVisitor) {
        v.visit(this)
    }
}

//ConcreteElement
class Car: Element {
    private val items = arrayOf(
        Engine(),
        Wheel(1), Wheel(2),
        Wheel(3), Wheel(4)
    )

    override fun accept(v: CarVisitor) {
        for (e in items) {
            e.accept(v)
        }
        v.visit(this)
    }
}

//Visitor
interface CarVisitor {
    fun visit(engine: Engine)
    fun visit(wheel: Wheel)
    fun visit(car: Car)
}

//ConcreteVisitor
class TestCarVisitor: CarVisitor {
    override fun visit(engine: Engine) {
        println("test engine")
    }

    override fun visit(wheel: Wheel) {
        println("test wheel #" +
            wheel.getNumber())
    }

    override fun visit(car: Car) {
        println("test car")
    }
}

//ConcreteVisitor
class RepairCarVisitor: CarVisitor {
    override fun visit(engine: Engine) {
        println("repair engine")
    }

    override fun visit(wheel: Wheel) {
        println("repair wheel #" +
            wheel.getNumber())
    }

    override fun visit(car: Car) {
        println("repair car")
    }
}

//Client
val car = Car()
val v1 = TestCarVisitor()
val v2 = RepairCarVisitor()

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

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

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

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

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

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

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