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

Repository и Service

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

Два входа записывают заметку одинаковым SQL. Вынесем этот SQL в маленький файл и сохраним прежние HTTP-ответы.

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

Repository называют границу, за которой находятся операции хранения. Здесь достаточно двух функций listNotes и insertNote в src/note-store.php: они принимают готовое подключение PDO и не знают о форме или редиректе. public/index.php продолжает проверять ввод и отвечать 303/HTML. add-note.php будет пользоваться теми же функциями и src/db.php, поэтому локальная переменная NOTES_DB_PATH действует и для CLI. Отдельный Service сейчас не вводим: входа, владельца и нескольких общих сценариев с правами ещё нет.

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

Repository
Роль кода, который скрывает детали хранения за операциями над данными. Здесь эту роль пока выполняют две функции listNotes и insertNote, а не готовый класс.
Service
Роль кода, который координирует шаги сценария и его правила. Отдельного Service в текущем каталоге нет: веб-обработчик пока сам проверяет ввод и вызывает сохранение.
PDO
Объект PHP для работы с базой через запросы. src/db.php открывает SQLite и передаёт PDO функциям хранения.

listNotes и insertNote выполняют роль небольшого слоя доступа к данным, который иногда называют Repository. Сложный класс ради двух операций не нужен. Функции не проверяют название: это правило остаётся в src/note-rules.php и вызывается веб-формой. Учебный change-note.php всё ещё делает UPDATE напрямую и может обойти правило; не объявляйте инвариант уже обеспеченным для всех входов.

Service был бы местом сценария с несколькими общими правилами, например проверкой владельца перед изменением. У этого каталога нет входа, user_id и удаления через HTTP, поэтому пример с $note->ownerId был бы выдумкой. Когда появится настоящий сценарий, сначала опишите его вход, ошибку и проверку, затем решайте, нужен ли отдельный Service.

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

<?php
// Полный новый файл notes-php/src/note-store.php
declare(strict_types=1);
function listNotes(PDO $pdo): array
{
    return $pdo->query('SELECT id, title, body FROM notes ORDER BY id DESC')
        ->fetchAll(PDO::FETCH_ASSOC);
}
function insertNote(PDO $pdo, string $title, string $body): string
{
    $stmt = $pdo->prepare('INSERT INTO notes (title, body) VALUES (:title, :body)');
    $stmt->execute([':title' => $title, ':body' => $body]);
    return $pdo->lastInsertId();
}

Практика

Уберите два одинаковых INSERT и используйте один доступ к SQLite из веб-формы и CLI. Разделение будет полезно при изменении способа записи, без нового класса и прав доступа, которых пока нет.

  1. В Visual Studio Code в папке notes-php/src создайте note-store.php рядом с db.php и note-rules.php, вставьте весь пример и сохраните Ctrl+S. Из корня выполните php -l src/note-store.php. Создайте отдельную базу Copy-Item -LiteralPath data/notes.sqlite -Destination data/pattern-test.sqlite, затем в этом терминале PowerShell задайте $env:NOTES_DB_PATH = (Resolve-Path -LiteralPath data/pattern-test.sqlite).Path. Вызовите php -r 'require "src/note-store.php"; $p = require "src/db.php"; $before = count(listNotes($p)); $id = insertNote($p, "Pattern", "Check"); echo $before, "+1=", count(listNotes($p)), " id=", $id, PHP_EOL;': ожидайте рост числа строк ровно на один и числовой id.
  2. В public/index.php сразу после строки подключения note-rules.php добавьте require_once dirname(__DIR__) . '/src/note-store.php';. В POST-ветке замените только два вызова $pdo->prepare(...) и $stmt->execute(...) одной строкой insertNote($pdo, $title, $body);; строку header('Location: /', true, 303); оставьте. Строку $notes = $pdo->query(...)->fetchAll(PDO::FETCH_ASSOC); замените на $notes = listNotes($pdo);. Код поиска ниже оставьте без изменений. Сохраните и выполните php -l public/index.php.
  3. В add-note.php замените блок от $database = ... до $stmt->execute([...]); тремя строками require_once __DIR__ . '/src/note-store.php';, $pdo = require __DIR__ . '/src/db.php';, $id = insertNote($pdo, "Заметка О'Брайена", 'Текст заметки');. В следующей строке замените $pdo->lastInsertId() на $id, а в foreach замените $pdo->query('SELECT id, title FROM notes ORDER BY id') на array_reverse(listNotes($pdo)). Остальной вывод оставьте, сохраните Ctrl+S; выполните php -l add-note.php и php add-note.php. Последняя команда должна добавить одну строку в тестовую базу, выбранную NOTES_DB_PATH, и напечатать новый id.
  4. Из того же терминала с NOTES_DB_PATH запустите php -S localhost:8000 -t public; во втором терминале PowerShell выполните curl.exe -i --data "title=FromWeb&body=Check" http://localhost:8000/: ожидайте 303 и Location: /. Затем curl.exe -i http://localhost:8000/ должен показать FromWeb. Пустой title через curl.exe -i --data "title=&body=" http://localhost:8000/ даёт HTML-ошибку без новой строки. Остановите сервер Ctrl+C, выполните Remove-Item Env:NOTES_DB_PATH; обычная data/notes.sqlite не должна содержать Pattern и FromWeb. Выполните git diff --check и git status --short: изменены только названные PHP-файлы и документ прошлого урока.

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

src/note-store.php проходит синтаксическую проверку; тестовая SQLite получает записи через функцию, CLI и HTTP. Допустимый POST по-прежнему даёт 303, ошибочный не добавляет строку, рабочая база не затронута.

Если не получилось
  • undefined function insertNote? Проверьте require_once в public/index.php и add-note.php, а также имя src/note-store.php.
  • no such table: notes? Переменная NOTES_DB_PATH должна указывать на существующую копию после setup.php; проверьте путь через Resolve-Path и расширение pdo_sqlite через php -m.
  • Рабочая база неожиданно выросла? CLI или сервер был запущен без NOTES_DB_PATH. Сверьте переменную в том же терминале и повторите опыт только на отдельной копии.