Реализация шаблона проектирования «Наблюдатель» на PHP

При работе над проектами часто приходится решать нетривиальные задачи, когда по причине присутствия в системе большого количество объектов, находящихся в согласованном состоянии, «неосторожная» работа с ними может привести к нарушению целостности данных и корректности работы системы целиком. Во избежание подобного рода ситуаций стало необходимо отслеживать все важные манипуляции, способные спровоцировать нежелательные последствия.

Сам проект состоит из двух частей: «ядро» (системная часть) и прочие компоненты (проектная часть). Некоторые компоненты обеих частей связаны между собой, однако это требует наличие ряда нестандартных обработчиков, гарантирующих согласованность, которые не предусмотрены методами системных объектов. Первым рассматриваемым решением данной проблемы [1-3] стала доработка стандартных методов, путем редактирования фалов системы. Однако такой подход нарушает саму концепцию ядра, которое должно быть гибким и предоставляло бы инструменты для реализации различного нестандартного функционала. К тому же обновления ядра может удалить внесенные изменения в системные файлы, что может существенно нарушить работу системы. В итоге была поставлена задача создания решения, которое должно было быть «гибким», универсальным и оградило бы от нежелательного вмешательства в файлы системы.

Для окончательного решения поставленной задачи лучше всего подходит шаблон проектирования «Наблюдатель», принцип работы которого заключается в механизме асинхронного оповещения экземпляров одного класса об изменении их состояния других объектов, таким образом наблюдая за ними. Именно такой подход может гарантировать условное разделение системных и проектных объектов и в тоже время выступить в роли «моста» между ними, для обеспечения согласованности в работе. Вариантов реализации данного шаблона в интернете не мало, однако в этой статье будет представлен очень простой и эффективный вариант решения данной задачи.

В данной реализации массив обработчиков представлен в виде стека, то есть вызов обработчиков для одного и того же события происходит по очереди их добавления, удаляется последний.

В классе наблюдателя должны быть реализованы три обязательных метода:

• добавление обработчика для события;
• удаление обработчика для события;
• вызов обработчиков для события.

Данные методы описаны в интерфейсе, исходный код которого показан ниже:

        interfaceiObserver

        {static public function attach($event, $handler);

        static public function detach($event);

        static public function notify($args, $event);}

Далее был реализован класс [3,4] наблюдателя, имплементирующий данный интерфейс. Единственным свойством данного класса является массив (стек) наблюдателей:

   staticprivate $observers = [];

Метод добавления наблюдателя довольно прост. Он принимает два параметра: название события, для которого устанавливается обработчик, и безымянная функция, вызывающаяся при срабатывании события:

   static public function attach($event, $handler)

           {self::$observers[$event][] = $handler;}

Следующий метод отвечает за удаление последнего добавленного обработчика для определенного события, так как возможен сценарий, когда обработчик необходим лишь один раз в определенном месте. В качестве аргументов метод принимает лишь название события, для которого необходимо удалить последний добавленный обработчик.

        static public function detach($event)

         {foreach (self::$observers as $name => $observers)

        if($name == $event)

        array_pop(self::$observers[$name]);}

Третий и последний метод отвечает за оповещение других объектов о срабатывании события. В качестве параметров принимает массив аргументов для безымянной функции (обработчика), переданной в метод attach и название произошедшего события.

        static public function notify($args, $event)

         {foreach (self::$observers as $name => $observers)

        if($name == $event)

        foreach ($observers as $name => $function)

        {$function($args); } }

В качестве примера был создан классCar и реализованодва метода –drive и stop. Метод drive [4] отвечает за движение машины, однако до начала движения и после иногда необходимо выполнить некоторые действия. Аналогично метод stopотвечает за остановку машины. Реализация данных методов представлена ниже.

        class Car{

        public function __construct(){}

        public function drive(){

         Observer::notify(array(&$this), "beforeDrive");

        echo "<b>Машина в движении</b><br>";

        Observer::notify(array(&$this), "afterDrive"); }

        public function stop()

        { Observer::attach(array(&$this), "beforeStop");

        echo "<b>Машина остановилась</b><br>";

        Observer::attach(array(&$this), "afterStop");} }

Теперь необходимо создать несколько наблюдателей.

Первое, что необходимо перед началом движения – пристегнуть ремень безопасности и завести двигатель. Перед остановкой необходимо снизить скорость, а в конце заглушить двигатель. Однако глушить двигатель необходимо в самом конце, поэтому данный обработчик будет объявлен перед окончанием поездки. Обработчики событий будут вызываться в порядке их добавления в «стек» [5,6].

Пример создания обработчиков и их работы продемонстрирован ниже.

        Observer::attach("beforeDrive", function($args){

        echo "Пристегнуть ремень безопасности<br>";};

        Observer::attach("beforeDrive", function($args){

        echo "Завести двигатель<br>";};

        Observer::attach("beforeStop", function($args){

        echo "Снизить скорость<br>";};

        $Car->drive();

        //Поскольку нет необходимости пристегивать ремень и заводить двигатель

        //после каждой остановки эти наблюдатели временно удаляются

        Observer::detach("beforeDrive");

        Observer::detach("beforeDrive");

        $Car->stop();

        echo "<br>";

        $Car->drive();

        echo "<br>";

        Observer::attach("afterStop", function($args){

        echo "Заглушить двигатель<br>";};

        $Car->stop();

Результат работы данного кода можно увидеть на рисунке 1. Для наглядности текст из методов объекта машины выделен жирным шрифтом.

Рисунок 1. Пример работы наблюдателей

Однако данная реализация шаблона позволяет также вносить изменения в свойства самого объекта. К примеру, при ремонте машины возрастает её цена. Для этого необходимо добавить ещё одно свойство priceи метод renovation:

public function renovation($renovationPrice){

        echo "<b>Ремонтмашины</b><br>";

        Observer::notify(array(&$this, $renovationPrice), "afterRenovation");}

Создание наблюдателя, который прибавлял бы к стоимости автомобиля цену за ремонт:

Observer::attach("afterRenovation", function($args){

        $Car = $args[0];

        $renovationPrice = $args[1];

        $Car->price += $renovationPrice; };

И пример обработчика, в котором задается изначальная цена автомобиля, после чего вызывается метод renovation. Результат выполнения данного кода продемонстрирован на рисунке 2.

        $Car->price = 2000;

        echo "Изначальная стоимость машины: " . $Car->price . "<br>";

        $Car->renovation(300);

        echo "Стоимость машины после ремонта: " . $Car->price . "<br>";

Рисунок 2. Пример изменения наблюдателем свойств объекта

Данная реализация шаблона проектирования «Наблюдатель» хороша своей простотой и универсальностью. Это решение легко интегрируется в любой проект и не зависит от его структуры, функционала и прочих особенностей. Оно позволяет создавать неограниченное количество ранее непредусмотренных обработчиков, не затрагивая уже готовые компоненты системы.