vasiljevalentin

Чаще всего под шаблонами проектирования понимают некую часть программы, которая должна выполнить часто повторяющуюся задачу. Для таких частых, стандартных задач были написаны алгоритмы и, даже, специальная книга "Design Patterns".

Вот об этих шаблонах или паттернах, описанных в книге, и поговорим.

В статье на Википедии предлагают следующую классификацию шаблонов:

• Основные

• Порождающие шаблоны (Creational)

• Структурные шаблоны (Structural)

• Поведенческие шаблоны (Behavioral)

Мне кажется, что самый простой и популярный шаблон, который можно разобрать в первой статье - это Порождающий шаблон "Фабричный метод". Основная идея его в том, что наша программа будет создавать разные классы в зависимости от некоторых условий. Причем, во время разработки программы, мы не будем знать какой класс нам будет необходим. И программа должна будет определить и создать класс сама. Да, объяснить без примеров это не просто, поэтому посмотрим на код.

Фреймворк

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

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

А бот можно найти в телеграме, написать ему сообщение и проверить работу нашего Фабричного метода.

Код проекта

Идея программы очень простая - вы пишите сообщение телеграм боту. Бот отправляет callback сообщение на бекэнд нашего приложения. И в зависимости от текста этого сообщения, код на бекэнде определяет какое сообщение отправить боту обратно, чтобы вывести его в телеграм клиенте.

Сообщение от телеграма приходит на роут, который мы указали при создании бота в BotFather. А во фреймворке создали этот роут в "\project\config\routes.php"

use \Core\Route;

return [

new Route('/telegram/:var1/', 'telegram', 'index'), // роут для telegram bot

];

Роут находит Telegram Controller и выполняет метод index. В этом методе мы выполняем ряд проверок. И если сообщение пришло от нашего телеграм бота, передаем сообщение в Фабричный метод, чтобы создать нужный объект и получить обратное сообщение для бота.

$ms = new MessageFactory($params);

$msObject = $ms->create();

В классе MessageFactory есть два метода. В конструкторе мы разбираем параметры сообщения и пытаемся получить текст сообщения от телеграма и id чата от которого сообщение пришло.

А в методе create мы проверяем существует ли класс для конкретного сообщения и если существует создаем объект этого класса и возвращаем его в контроллер. Если же класса нет, значит мы должны создать дефолтный класс.

public function __construct(array $params)

{

$this->command = preg_replace('/\//', '_', $params['message']['text']??'sdsfsdf');

$this->params['chatId'] = $params['message']['chat']['id']??0;

}

public function create()

{

$className = ucfirst($this->command);

$messageFile = $_SERVER['DOCUMENT_ROOT'] . DIRECTORY_SEPARATOR . "project/classes/messagefactory/messages/Message$className.php";

$messageClass = $this->namespace."Message$className";

if(file_exists($messageFile) && class_exists($messageClass)){

return new $messageClass($this->params);

} else {

return new MessageDefault($this->params);

}

}

Для каждого конкретного сообщения, которое мы хотим обработать на бекэнде по уникальному сценарию, мы должны создать класс реализации. Например, класс "\project\classes\messagefactory\messages\MessageTest.php"

Этот класс расширяет абстрактный класс MessageAbstract и реализует интерфейс IMessage. class MessageTest extends MessageAbstract implements IMessage {}

У него есть только конструктор, в котором мы вызываем конструктор родителя и заполняем свойство $message = 'Test Message'. Соответственно, если мы напишем в телеграм бот сообщение 'test', то наш Фактори метод создаст класс MessageTest, в свойстве $message у него будет строка 'Test Message' и контроллер отправит эту строку обратно в телеграм бот.

Что если

Что если бы мы не использовали все эти модные паттерны, классы и ооп. Конечно, такую программу можно реализовать и без ооп, возможно это даже проще. Но тогда описать обработку каждого сообщения придется в блоках if/else или switch/case. На первом этапе это будет не трудно. Просто напишем нужную строку для каждого case. Но, что если логика реакции на каждое сообщение будет сложной. Если при сообщении '/start' мы захотим зарегистрировать пользователя в системе и добавить его в базу данных. А при дефолтном сообщении создать еще несколько вариантов сценариев. Тогда наш контроллер будет огромного размера и поддерживать такую программу станет слишком сложно.

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

Вместо заключения. Это первый шаблон проектирования ПО который мы рассмотрели. Впереди еще много работы и полезных штук, поэтому... Спасибо всем, кто смог дочитать этот пост до конца несмотря на ужасное оформление, примеры на php и общую безграмотность. Отдельное спасибо всем, кто заходит и подписывается на ютуб канал. Я начинаю готовить видео на тему Шаблонов проектирования. Может быть примеры кода на видео будут более понятны.

Инкапсуляция

Как совершенно справедливо заметили в комментах, я не смог объяснить что такое ооп в первом посте. Ну это и не мудрено. Попробую приоткрыть пользу этого подхода опять.

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

<?php

class Text {

private $text;

public function __construct($text){

$this->text = $text;

}

public function printText() {

echo $this->text;

}

}

$hello = new Text("Hello, "); // создаем объект hello

$world = new Text("World!"); // создаем объект world

$hello->printText(); // вызываем метод print объекта hello

$world->printText(); // вызываем метод print объекта world

echo PHP_EOL.get_class($hello); // проверяем класс

echo PHP_EOL.get_class($world); // проверяем класс

?>

Здесь я добавил конструктор класса. С его помощью я передаю параметр с текстом. Этот параметр записывается в свойство text. Перед объявлением свойства text я использовал ключевое слово private, которое запрещает доступ к свойству извне класса. Функция get_class возвращает имя класса. Здесь я проверю, что класс двух объектов совпадает, почему это важно? Узнаем в следующих постах.

Определение возможности доступа к свойствам и методам класса (public, private, protected) - это сокрытие.

Таким образом получилось, что класс Text работает с параметром, который я передал через конструктор и методами, которые я описал в классе. Такое объединение данных и методов работы с ними + сокрытие - это инкапсуляция.

Наследование

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

<?php

class Text {

protected $text;

public function __construct($text){

$this->text = $text;

}

public function printText() {

return $this->text;

}

}

class Header extends Text {

public function printText() {

return strtoupper($this->text);

}

}

class Sentence extends Text {

public function printText() {

return ucfirst(strtolower($this->text));

}

}

$header = new Header("hello, world!");

$sentence = new Sentence("hello, WORLD!");

echo $header->printText();

echo PHP_EOL;

echo $sentence->printText();

?>

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

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

Вместо заключения. Я, конечно, не ожидал такого отклика на первую статью. Тем более удивительно, что рейтинг на аккаунте стал немного больше, а не наоборот. Значит, все не зря. Более того, 63 человека стали подписчиками. Это уже совсем удивительно, ведь судя по комментариям, про ооп все уже все знают. Наверное, вы подписались из-за искрометных мемчиков вначале постов. В общем, всем спасибо! И отдельное спасибо новым подписчикам на ютубе :)