УРОК · Паттерны без лишних абстракций

Паттерн как ответ на проблему

Опубликовано Автор: Соловьёва Мария Андреевна

После Workflow3 notes-php уже ищет и сохраняет заметки. Сначала найдём повторяющуюся работу в реальных файлах и решим, какое разделение ей нужно.

Разберём по шагам

В public/index.php и add-note.php отдельно записан один и тот же INSERT INTO notes; change-note.php меняет запись напрямую. Это причина проверить границу работы с данными. Сейчас источник один — SQLite, поэтому небольшой функции для общего INSERT достаточно. Класс Repository с множеством методов и Service с проверкой владельца пока добавили бы обещания, которых приложение не выполняет: входа и владельца здесь нет. Сначала запишем наблюдение и критерий выбора, в следующем уроке вынесем только нужные операции.

Слова, которые пригодятся

Паттерн
Повторяемый способ организовать решение определённой проблемы. Например, общий доступ к данным может скрыть одинаковый SQL от двух входов приложения.
Причина изменения
Событие, из-за которого приходится править код. Если меняется структура записи заметки, два одинаковых INSERT сейчас пришлось бы менять по отдельности.
Граница
Место разделения задач кода. Функция проверки названия не открывает базу, а будущие функции хранения не должны формировать HTML-ответ.

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

src/note-rules.php проверяет только название, а src/db.php открывает PDO. Ни один из них не является готовым Repository или Service. Запись в pattern-decision.md не меняет поведение приложения; она связывает будущую правку с наблюдаемой причиной.

Рабочий пример

git status --short
Select-String -Path public/index.php,add-note.php,change-note.php -Pattern 'INSERT INTO notes','UPDATE notes','SELECT id, title'
php -r 'require "src/note-rules.php"; echo isValidTitle("Заметка") ? "true" : "false", PHP_EOL;'

Практика

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

  1. В Visual Studio Code откройте существующий notes-php после Workflow3 через Файл → Открыть папку. В Терминал → Создать терминал из корня выполните git status --short: после прошлого урока ожидайте пустой вывод. Затем выполните строку Select-String из примера. Найдите два INSERT INTO notes, в public/index.php и add-note.php, а также UPDATE в change-note.php.
  2. В том же терминале выполните php -r из примера: ожидайте true без обращения к базе. Откройте src/note-rules.php и убедитесь, что isValidTitle не требует PDO. Это уже существующий удачный пример простой функции: она решает одну задачу без класса.
  3. В панели файлов Visual Studio Code создайте в корне notes-php файл pattern-decision.md рядом с README.md. Запишите четыре строки: «Факт: два INSERT в HTTP и CLI»; «Меняется: место SQL, если изменится запись»; «Остаётся: проверка title и HTTP-ответ»; «Сейчас: две функции доступа к SQLite; класс и Service пока не нужны». Допишите условие пересмотра: второй способ хранения или несколько сценариев с общими правилами. Сохраните Ctrl+S и выполните git status --short: новый документ должен быть виден как ?? pattern-decision.md.

Как проверить себя

В pattern-decision.md названы реальные файлы и повторение; команда находит два INSERT, а проверка isValidTitle работает без PDO. Выбор функции обоснован текущим объёмом задачи.

Если не получилось
  • Select-String не нашёл SQL? Проверьте Get-Location: терминал должен быть в корне notes-php после Workflow3, а не в public.
  • php -r сообщает об отсутствии mb_strlen? Проверьте php -m и включение mbstring из PHP1.
  • В git status --short уже есть чужие изменения? Не смешивайте их с упражнением; сначала разберите статус по правилам Workflow1.