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

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

-- Elements: plain tables, kind names the type
local car = {kind = "car", items = {
  {kind = "engine"},
  {kind = "wheel", number = 1},
  {kind = "wheel", number = 2},
}}

-- ConcreteVisitor: a function for each kind
local test_car_visitor = {
engine = function()
    print("test engine")
  end,
wheel = function(wheel)
    print("test wheel #" .. wheel.number)
  end,
car = function()
    print("test car")
  end,
}

-- ConcreteVisitor: new work for the same
-- elements, the elements stay untouched
local repair_car_visitor = {
engine = function()
    print("repair engine")
  end,
wheel = function(wheel)
    print("repair wheel #" .. wheel.number)
  end,
car = function()
    print("repair car")
  end,
}

-- accept: the parts first, then the element;
-- its kind picks the function of the visitor
local function accept(element, visitor)
  for _, item in ipairs(element.items or {}) do
    accept(item, visitor)
  end
visitor[element.kind](element)
end

-- Client
accept(car, test_car_visitor)
accept(car, repair_car_visitor)

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

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

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

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

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

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