Шаблоны проектирования для новичков

Внимание! Материал был обновлён и разделён на три части. Предлагаем вам ознакомиться с ним по следующим ссылкам:

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

Что такое шаблоны проектирования?

Шаблоны проектирования — это проверенные и готовые к использованию решения часто возникающих в повседневном программировании задач. Это не класс и не библиотека, которую можно подключить к проекту, это нечто большее. Шаблон проектирования, подходящий под задачу, реализуется в каждом конкретном случае. Кроме того, он не зависит от языка программирования. Хороший шаблон легко реализуется в большинстве, если не во всех языках, в зависимости от выразительных средств языка. Следует, однако, помнить, что такой шаблон, будучи примененным неправильно или к неподходящей задаче, может принести немало проблем. Тем не менее, правильно примененный шаблон поможет решить задачу легко и просто.

Существует три типа шаблонов:

  • структурные;
  • порождающие;
  • поведенческие.

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

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

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

Зачем нужны шаблоны проектирования?

Шаблон проектирования, по своей сути, это продуманное решение той или иной задачи. Если вы столкнулись с известной задачей, почему бы не использовать готовое решение, проверенное опытом?

Пример

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

class StrategyAndAdapterExampleClass {
        private $_class_one;
        private $_class_two;
        private $_context;

        public function __construct( $context ) {
                        $this->_context = $context;
        }

        public function operation1() {
                if( $this->_context == "context_for_class_one" ) {
                        $this->_class_one->operation1_in_class_one_context();
                } else ( $this->_context == "context_for_class_two" ) {
                        $this->_class_two->operation1_in_class_two_context();
                }
        }
}

Просто, не правда ли? Давайте посмотрим поближе на шаблон «Стратегия».

Шаблон «Стратегия»

strategyintro

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

В примере выше выбор стратегии основан на значении переменной $context, которое было в момент создания объекта. Если значение было "context_for_class_one", программа будет использовать класс class_one. И наоборот.

Хорошо, но где это можно использовать?

strategy

Представьте, что вы разрабатываете класс, который может создать или обновить запись в базе данных. В обоих случаях входные параметры будут одни и те же (имя, адрес, номер телефона и т. п.), но, в зависимости от ситуации, он будет должен использовать различные функции для обновления и создания записи. Можно каждый раз переписывать условие if/else, а можно создать один метод, который будет принимать контекст:

class User {

        public function CreateOrUpdate($name, $address, $mobile, $userid = null)
        {
                if( is_null($userid) ) {
                        // пользователя не существует, создаем запись
                } else {
                        // запись есть, обновляем ее
                }
        }
}

Обычно шаблон «Стратегия» подразумевает инкапсуляцию алгоритмов в классы, но в данном случае это излишне. Помните, что вы не обязаны следовать шаблону слово в слово. Любые варианты допустимы, если они решают задачу и соответствуют концепции.

Шаблон «Адаптер»

adapterintro

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

Также он позволяет изменить некоторые входные данные для совместимости с интерфейсом внутреннего класса.

Как его использовать?

adapter

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

Сравните два примера.

Без адаптера
$user = new User();
$user->CreateOrUpdate( // параметры );

$profile = new Profile();
$profile->CreateOrUpdate( // параметры );

Если нам придется использовать такой код повторно, мы будем вынуждены переписывать все это заново.

С использованием адаптера

Мы можем создать класс-обертку Account:

class Account()
{
        public function NewAccount( // параметры )
        {
                $user = new User();
                $user->CreateOrUpdate( // часть параметров );

                $profile = new Profile();
                $profile->CreateOrUpdate( // часть параметров );
        }
}
$account_domain = new Account();
$account_domain->NewAccount( // параметры );

Теперь мы можем использовать класс Account каждый раз и, кроме того, мы можем добавить в него дополнительные функции.

Шаблон «Метод-фабрика»

factoryintro

Фабрика — порождающий шаблон, который представляет собой класс с методом для создания различных объектов.

Основная цель этого шаблона — инкапсулировать процедуру создания различных классов в одной функции, которая в зависимости от переданного ей контекста возвращает необходимый объект.

Как его использовать?

factory

Фабрика обычно используется для создания различных вариантов базового класса. Допустим, у вас есть класс кнопки — Button — и три варианта — ImageButton, InputButton и FlashButton. С помощью фабрики вы можете создавать различные варианты кнопок в зависимости от ситуации.

Сначала создадим три класса:

abstract class Button {
        protected $_html;

        public function getHtml()
        {
                return $this->_html;
        }
}

class ImageButton extends Button {
        protected $_html = "..."; // HTML-код кнопки-картинки
}

class InputButton extends Button {
        protected $_html = "..."; // HTML-код обычной кнопки (<input type="button">);
}

class FlashButton extends Button {
        protected $_html = "..."; // HTML-код Flash-кнопки
}

Теперь мы можем написать нашу фабрику:

class ButtonFactory
{
    public static function createButton($type)
    {
        $baseClass = 'Button';
        $targetClass = ucfirst($type).$baseClass;

        if (class_exists($targetClass) && is_subclass_of($targetClass, $baseClass)) {
            return new $targetClass;
        } else {
            throw new Exception("The button type '$type' is not recognized.");
        }
    }
}

и использовать ее:

$buttons = array('image','input','flash');
foreach($buttons as $b) {
    echo ButtonFactory::createButton($b)->getHtml()
}

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

Шаблон «Декоратор»

decoratorintro

Декоратор — это структурный шаблон, который позволяет добавить новое поведение объекту в процессе выполнения программы в зависимости от ситуации.

Цель — в расширении поведения конкретного объекта без необходимости изменять поведение базового класса. Это позволит использовать несколько декораторов одновременно. Этот шаблон — альтернатива наследованию. В отличие от наследования, декоратор добавляет поведение в процессе выполнения программы.

Для реализации декоратора нам понадобится:

  1. Унаследовать класс-декоратор от базового.
  2. Добавить поле со ссылкой на базовый класс в декоратор.
  3. Передать ссылку на декорируемый объект в конструктор декоратора.
  4. Перенаправить методы из декоратора на декорируемый объект.
  5. Переопределить методы в декораторе, поведение которых необходимо изменить.

Как его использовать?

decorator

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

Сначала определимся, какие «декорации» нам нужны:

  • Если мы на заглавной странице и вошли в аккаунт, ссылка должна быть в h2-теге.
  • Если мы на любой другой странице и вошли в аккаунт, ссылка должна быть подчеркнутой.
  • Если мы вошли в аккаунт, ссылка должна быть в strong-теге.

Теперь мы можем написать сами декораторы:

class HtmlLinks {
        // методы для работы с любой HTML-ссылкой
}
 
class LogoutLink extends HtmlLinks {
        protected $_html;
        public function __construct() {
                $this->_html = "<a href="\" data-mce-href="\">Logout</a>";
        }
 
        public function setHtml($html) {
                $this->_html = $html;
        }
 
        public function render() {
                echo $this->_html;
        }
}
 
class LogoutLinkH2Decorator extends HtmlLinks {
        protected $_logout_link;
 
        public function __construct( $logout_link ) {
                $this->_logout_link = $logout_link;
                $this->setHtml("" . $this->_html . "");
        }         
        public function __call( $name, $args ) {         
                $this->_logout_link->$name($args[0]);         
        } 
} 

class LogoutLinkUnderlineDecorator extends HtmlLinks {         
        protected $_logout_link;         
        public function __construct( $logout_link ) {                 
                $this->_logout_link = $logout_link;                 
                $this->setHtml("" . $this->_html . "");         
        }         
        public function __call( $name, $args ) {                 
                $this->_logout_link->$name($args[0]);         
        } 
} 

class LogoutLinkStrongDecorator extends HtmlLinks {         
        protected $_logout_link;         
        public function __construct( $logout_link ) {                 
                $this->_logout_link = $logout_link;                 
                $this->setHtml("" . $this->_html . "");         
        }         
        public function __call( $name, $args ) {                 
                $this->_logout_link->$name($args[0]);         
        } 
}

Теперь мы можем использовать их так:

$logout_link = new LogoutLink();

if( $is_logged_in ) {
        $logout_link = new LogoutLinkStrongDecorator($logout_link);
}

if( $in_home_page ) {
        $logout_link = new LogoutLinkH2Decorator($logout_link);
} else {
        $logout_link = new LogoutLinkUnderlineDecorator($logout_link);
}
$logout_link->render();

Обратите внимание, как можно использовать несколько декораторов на одном объекте. Все они используют функцию __call для вызова оригинального метода. Если мы войдем в аккаунт и перейдем на заглавную страницу, результат будет такой:

<strong> </strong>
<h2><a href="logout.php">Logout</a></h2>

Шаблон «Одиночка»

singletonintro

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

Его можно использовать как точку «координации» для других объектов, поскольку поля «Одиночки» будут одинаковы для всех, кто его вызывает.

Как его использовать?

singleton

Если вам необходимо передавать определенный экземпляр из класса в класс, вы можете передавать его каждый раз через конструктор или использовать «Одиночку». Допустим, у вас есть класс Session, который содержит данные о текущей сессии. Поскольку сессия инициализируется только один раз, мы можем реализовать его так:

class Session
{
        private static $instance;

        public static function getInstance()
        {
                if( is_null(self::$instance) ) {
                        self::$instance = new self();
                }
                return self::$instance;
        }

        private function __construct() { }

        private function __clone() { }

        //  прочие методы сессии
        ...
        ...
        ...
}

// get a session instance
$session = Session::getInstance();

Теперь мы можем получить доступ к сессии из различных участков кода, даже из других классов. Метод getInstance всегда будет возвращать одну и ту же сессию.

Заключение

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

И последнее: при использовании того или иного шаблона убедитесь, что вы решаете задачу правильным способом. Как уже упоминалось, при неправильном использовании шаблоны проектирования могут доставить больше проблем, чем решить. Но при правильном — их пользу нельзя переоценить.

Перевод статьи «A Beginner’s Guide to Design Patterns?»