Архитектура приложения на Yii2. Часть 1. MVC, точки входа и конфиги
У публичной части сайта и админки часто одна база и общие бизнес-правила, но разные маршруты, сессии и права доступа. Для небольшого или среднего проекта на Yii2 это удобно реализовать двумя веб-приложениями в одном репозитории. Разберём, как провести границы между ними и собрать конфигурацию без дублирования.
1. Что оставить в MVC, а что вынести в сервисы
MVC разделяет обработку запроса, работу с данными и представление результата. В Yii2 слово «модель» охватывает и модель формы с правилами валидации, и Active Record, связанный с таблицей. Когда действие затрагивает несколько записей или повторяется в админке и консольной команде, у операции появляется собственное место — сервис приложения.
- Контроллер проверяет доступ, загружает входные данные в форму, вызывает сценарий и выбирает HTTP-ответ. Например, после публикации статьи перенаправляет редактора в список материалов.
- Модель формы проверяет поля запроса и возвращает ошибки, которые можно показать пользователю. Для разных экранов можно использовать разные формы, даже если они меняют одну таблицу.
- Модель данных описывает запись, связи и запросы, относящиеся к этой записи. Повторяющиеся выборки удобно оформлять методами класса
ActiveQuery. - Сервис приложения выполняет операцию целиком. Например, меняет статус статьи и записывает событие аудита в одной транзакции.
- Представление форматирует подготовленные данные. В HTML-шаблоне пользовательский текст экранируют через
Html::encode(), а JSON-ответ формируют средствами Yii.
Простой каталог может читать данные через Active Record прямо в действии контроллера. Сервис стоит вводить, когда нужно назвать самостоятельную операцию, сохранить согласованность нескольких изменений или вызвать один сценарий из разных точек входа. Интерфейс репозитория для каждой таблицы на старте только увеличит число файлов.
2. Структура проекта с frontend и backend
Для двух веб-приложений удобно взять Yii2 Advanced Project Template. Он задаёт отдельные пространства имён и точки входа, оставляя общие модели и сервисы доступными обоим приложениям. Следующая схема показывает только каталоги, важные для этой архитектуры.
| Каталог | Что в нём хранить |
|---|---|
frontend/web/, backend/web/ | Входные index.php, публичные файлы и опубликованные ресурсы Yii. |
frontend/, backend/ | Контроллеры, формы, шаблоны, ресурсы и конфигурация конкретного приложения. |
common/models/, common/services/ | Модели данных и сценарии, которые используются в нескольких приложениях. |
common/config/ | Подключение к БД, общие параметры и настройки, применимые ко всем точкам входа. |
console/, vendor/ | Консольные команды с миграциями и зависимости Composer соответственно. |
Для публичного сайта укажите корнем веб-сервера frontend/web, для админки — backend/web. Так исходники, зависимости, локальные конфиги и журналы остаются за пределами обоих веб-корней. Разные хосты упрощают изоляцию cookie и позволяют ограничить доступ к админке на уровне сети. Если административных экранов мало и им нужна общая сессия с сайтом, часто достаточно модуля с проверками прав на его маршрутах.
3. Как устроена точка входа
Входной скрипт задаёт окружение, подключает Composer и Yii, загружает файлы и запускает приложение. Ниже — frontend/web/index.php для уже инициализированного Advanced-шаблона со стандартными файлами bootstrap.php и main-local.php. Для админки скрипт лежит в backend/web, поэтому те же относительные пути автоматически ведут к её конфигам.
<?php
declare(strict_types=1);
// Режим разработки включается только настройкой окружения.
$isDev = getenv('APP_ENV') === 'dev';
define('YII_ENV', $isDev ? 'dev' : 'prod');
define('YII_DEBUG', $isDev);
$root = dirname(__DIR__, 2);
$app = dirname(__DIR__);
require $root . '/vendor/autoload.php';
require $root . '/vendor/yiisoft/yii2/Yii.php';
require $root . '/common/config/bootstrap.php';
require $app . '/config/bootstrap.php';
// Справа находятся настройки с более высоким приоритетом.
$config = \yii\helpers\ArrayHelper::merge(
require $root . '/common/config/main.php',
require $root . '/common/config/main-local.php',
require $app . '/config/main.php',
require $app . '/config/main-local.php',
);
(new \yii\web\Application($config))->run();Окружение задаёт процесс запуска PHP. У консольной точки входа должны быть согласованные настройки среды и доступа к базе, особенно если миграции запускаются при деплое. Для PHP 8.3–8.5 проверьте совместимость зафиксированных версий Yii2, расширений и Composer-пакетов с фактической версией PHP на сервере. Команда composer check-platform-reqs проверяет требования установленных пакетов к PHP и расширениям.
4. Что положить в общий конфиг и как его переопределять
Общий main.php подходит для настроек, которые действительно совпадают. Например, кодировки подключения к БД и часового пояса приложения. Пространство имён контроллеров, маршруты, обработчик ошибок и настройки сессии выбирают в frontend/config/main.php и backend/config/main.php. В Advanced-шаблоне прикладные параметры из params.php и params-local.php подключаются отдельно через ключ params. Сохраните эту сборку при редактировании штатных файлов.
Ниже — пример common/config/main-local.php для проекта с MySQL. Он получает реквизиты подключения из окружения. Если в вашем проекте файл уже содержит другие настройки, добавьте этот компонент в существующий массив.
<?php
declare(strict_types=1);
// Пустой обязательный параметр считаем ошибкой конфигурации.
$required = static function (string $name): string {
$value = getenv($name);
if ($value === false || $value === '') {
throw new \RuntimeException('Не задана переменная ' . $name);
}
return $value;
};
return [
'components' => [
'db' => [
'class' => \yii\db\Connection::class,
'dsn' => $required('APP_DB_DSN'),
'username' => $required('APP_DB_USER'),
'password' => $required('APP_DB_PASSWORD'),
'charset' => 'utf8mb4',
],
],
];Значения передавайте из конфигурации среды выполнения или хранилища секретов. Локальные файлы можно генерировать при развёртывании. Если конфиг требует переменную, её отсутствие лучше обнаруживать проверкой при деплое: исключение при чтении файла возникает ещё до запуска обработчика ошибок Yii.
ArrayHelper::merge() объединяет вложенные массивы. Значение по строковому ключу из позднего слоя перекрывает раннее, а элементы с числовыми ключами добавляются в список. Например, пустой массив в позднем конфиге не очистит унаследованный список правил. Если наборы маршрутов у сайта и админки разные, задавайте их целиком в соответствующих приложениях. Приоритет правил важен: общий шаблон маршрута может перехватить запрос раньше точного.
5. Изоляция админки и общие сценарии
Для двух веб-приложений задайте разные имена cookie сессии и cookie идентификации, если включён автоматический вход. Разведите имена CSRF-параметров и CSRF-cookie, если они используются. Каждому приложению задайте свой секрет request.cookieValidationKey. При отдельных хостах оставьте cookie привязанными к хосту, если общая авторизация не предусмотрена. В рабочем окружении обслуживайте админку по HTTPS и включите secure и httpOnly для cookie сессии.
Общая таблица пользователей позволяет переиспользовать учётные записи. Доступ к административным действиям проверяйте отдельно через AccessControl или RBAC, а для изменения конкретного объекта проверяйте права на него. Смену статуса оформляйте запросом с подходящим HTTP-методом и CSRF-защитой для браузерной формы. Debug и Gii подключайте только в окружении разработки.
Граница общего сервиса проходит по данным операции. Например, при публикации статьи контроллер передаёт идентификатор статьи и редактора. Сервис проверяет допустимость перехода статуса и меняет запись вместе с аудитом в транзакции. Он получает подключение к БД или другой нужный компонент через конструктор. Тогда консольная команда вызывает ту же операцию без веб-запроса и получает тот же результат. Если статью могут публиковать одновременно из нескольких мест, проверку исходного статуса включите в условие обновления и проверьте число изменённых строк.
Типизируйте параметры и возвращаемые значения сервисов. declare(strict_types=1) действует на вызовы из файла с этой директивой. Данные из запроса всё равно нужно валидировать и приводить к ожидаемым типам перед вызовом. Например, идентификатор сначала проверяют правилом целого числа, а затем передают в метод с параметром int.
6. Чек-лист перед первым развёртыванием
- Проверьте, что оба хоста направлены в свои каталоги
web, а конфиги, журналы и файлы Composer лежат за их пределами. - Запустите обе веб-точки входа и консоль с настройками целевой среды. Убедитесь, что все три получают ожидаемую БД и что в рабочем окружении выключен
YII_DEBUG. - Проверьте по одному точному и параметризованному маршруту в каждом приложении, страницу ошибки и отдачу статических файлов.
- Войдите на сайт и в админку в одном браузере. Проверьте сессии, выход и отправку формы с CSRF-защитой. Откройте административный маршрут под обычным пользователем и убедитесь, что доступ запрещён.
- Возьмите одну операцию, которая меняет несколько записей. Проверьте успешное выполнение и откат при ошибке, затем убедитесь, что второй вызывающий код может переиспользовать тот же сервис.
Частые вопросы
Обязательно ли использовать Yii2 Advanced для сайта с админкой?
Для небольшой админки с общей сессией обычно хватает модуля. Advanced удобен, когда публичная и административная части требуют отдельных точек входа, веб-корней, настроек сессии или правил доступа.
Могут ли frontend и backend в Yii2 использовать одну базу данных?
Да. Подключение и модели данных можно вынести в common. Если нужны разные права на уровне БД, каждое приложение может использовать собственные реквизиты, подключаясь к той же базе.
Почему пустой массив в локальном конфиге не удаляет правила маршрутизации?
ArrayHelper::merge() рекурсивно объединяет вложенные массивы, а числовые элементы добавляет в список. Чтобы получить отдельный набор правил, задайте его только в конфиге нужного приложения или присвойте весь список после слияния.