Посетитель

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

;; Visitor folds into a multimethod dispatching on the node type: a new
;; visitor is a new defmulti, and the elements are never touched

;; Elements - plain maps tagged with their type
(def car
  [{:type :engine}
   {:type :wheel :number 1} {:type :wheel :number 2}
   {:type :wheel :number 3} {:type :wheel :number 4}
   {:type :car}])

;; ConcreteVisitor
(defmulti test-car :type)
(defmethod test-car :engine [_] (println "test engine"))
(defmethod test-car :wheel  [w] (println (str "test wheel #" (:number w))))
(defmethod test-car :car    [_] (println "test car"))

;; ConcreteVisitor
(defmulti repair :type)
(defmethod repair :engine [_] (println "repair engine"))
(defmethod repair :wheel  [w] (println (str "repair wheel #" (:number w))))
(defmethod repair :car    [_] (println "repair car"))

;; Client - accept() is just run!
(run! test-car car)
(run! repair car)


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

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

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

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

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

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