Что такое паттерн Посетитель и когда его использовать?

🧠 Что такое паттерн Посетитель (Visitor Pattern)?

Паттерн Посетитель — это поведенческий шаблон проектирования, который позволяет добавлять новые операции к объектам без изменения их классов. Он реализует принцип открытости/закрытости (Open/Closed Principle) — классы открыты для расширения, но закрыты для модификации.

Суть паттерна заключается в выделении алгоритмов из структуры объектов в отдельные классы-посетители. Каждый посетитель может выполнять определённую операцию над элементами сложной структуры объектов.

🛠️ Как работает паттерн Посетитель?

Ключевые компоненты:

1. Visitor — интерфейс с методами visit для каждого типа элемента.
2. ConcreteVisitor — конкретная реализация посетителя, инкапсулирующая определённую операцию.
3. Element — интерфейс элементов, принимающих посетителя (метод accept).
4. ConcreteElement — конкретные элементы, реализующие метод accept.
5. ObjectStructure — коллекция элементов, которая может обходить структуру.

Базовый пример на PHP:

<?php

// Интерфейс элемента
interface DocumentElement {
    public function accept(DocumentVisitor $visitor): void;
}

// Конкретные элементы
class TextElement implements DocumentElement {
    public function __construct(private string $content) {}
    
    public function accept(DocumentVisitor $visitor): void {
        $visitor->visitText($this);
    }
    
    public function getContent(): string {
        return $this->content;
    }
}

class ImageElement implements DocumentElement {
    public function __construct(private string $src, private string $alt) {}
    
    public function accept(DocumentVisitor $visitor): void {
        $visitor->visitImage($this);
    }
    
    public function getSrc(): string {
        return $this->src;
    }
    
    public function getAlt(): string {
        return $this->alt;
    }
}

// Интерфейс посетителя
interface DocumentVisitor {
    public function visitText(TextElement $element): void;
    public function visitImage(ImageElement $element): void;
}

// Конкретные посетители
class WordCountVisitor implements DocumentVisitor {
    private int $wordCount = 0;
    
    public function visitText(TextElement $element): void {
        $this->wordCount += str_word_count($element->getContent());
    }
    
    public function visitImage(ImageElement $element): void {
        // Изображения не добавляют слова
    }
    
    public function getWordCount(): int {
        return $this->wordCount;
    }
}

class HTMLExportVisitor implements DocumentVisitor {
    private string $html = '';
    
    public function visitText(TextElement $element): void {
        $this->html .= '<p>' . htmlspecialchars($element->getContent()) . '</p>';
    }
    
    public function visitImage(ImageElement $element): void {
        $this->html .= sprintf(
            '<img src="%s" alt="%s">',
            htmlspecialchars($element->getSrc()),
            htmlspecialchars($element->getAlt())
        );
    }
    
    public function getHTML(): string {
        return $this->html;
    }
}

// Использование
$document = [
    new TextElement("Hello, this is a sample text."),
    new ImageElement("image.jpg", "Sample image"),
    new TextElement("Another paragraph here.")
];

$wordCounter = new WordCountVisitor();
$htmlExporter = new HTMLExportVisitor();

foreach ($document as $element) {
    $element->accept($wordCounter);
    $element->accept($htmlExporter);
}

echo "Words: " . $wordCounter->getWordCount() . PHP_EOL;
echo "HTML: " . $htmlExporter->getHTML() . PHP_EOL;
?>

📊 Когда использовать паттерн Посетитель?

Идеальные сценарии применения:

1. Когда нужно выполнить операцию над всеми элементами сложной структуры объектов

   • Например, обход AST (Abstract Syntax Tree) в компиляторах
   • Обработка DOM-дерева в парсерах

2. Когда операции должны выполняться над объектами разных классов с разными интерфейсами

   • Посетитель позволяет работать с гетерогенными коллекциями

3. Когда нужно добавлять новые операции без изменения классов элементов

   • Особенно важно при работе с legacy-кодом или библиотечными классами

4. Когда операции связаны с элементом, но не являются его основной ответственностью

   • Например, экспорт, сериализация, валидация, логирование

5. Когда в структуре много несвязанных операций

   • Паттерн группирует родственные операции в одном классе

⚖️ Преимущества и недостатки

✅ Преимущества:

• Принцип открытости/закрытости — новые операции добавляются через новые посетители
• Принцип единственной ответственности — операции вынесены в отдельные классы
• Упрощение добавления операций для сложных структур объектов
• Накопление состояния — посетитель может собирать информацию при обходе

❌ Недостатки:

• Нарушение инкапсуляции — посетитель часто требует публичного доступа к внутреннему состоянию элементов
• Сложность добавления новых типов элементов — нужно обновлять всех посетителей
• Избыточность для простых операций — добавляет сложности там, где можно обойтись простым полиморфизмом
• Зависимость от стабильности иерархии элементов — плохо подходит для часто меняющихся структур

🔍 Практические примеры использования в PHP Backend:

1. Обработка AST в шаблонизаторах (Twig, Blade)
2. Валидация форм с разными типами полей
3. Экспорт данных в различные форматы (JSON, XML, CSV)
4. Генерация отчетов из разнородных данных
5. Применение бизнес-правил к элементам заказа
6. Калькуляция стоимости в корзине покупок с разными типами товаров

Паттерн Посетитель особенно мощён в комбинации с другими паттернами, например, с Компоновщиком (Composite) для обработки древовидных структур. Однако его стоит применять осознанно, учитывая компромисс между гибкостью добавления операций и сложностью добавления новых типов элементов в систему.