Перейти к содержимому
Документация · Интеграции

Yii3

Интеграция с Yii3 через goaop/goaop-yii3-bridge 1.0: подключение через yiisoft/config, behavior classes по тегу и ./yii aop:warmup.

Перевод с английского. Эталоном считается английская версия страницы. Читать оригинал

Мост (bridge) goaop/goaop-yii3-bridge 1.0 подключается к yiisoft/config. Ваши behavior classes (классы поведений) — обычные сервисы контейнера Yii, и движок получает каждый из них, только когда впервые выполняется один из его behaviors (поведений).

  • PHP 8.4 или новее
  • Пакеты Yii3: yiisoft/config, yiisoft/di, yiisoft/aliases (как в шаблоне приложения)
  • goaop/framework ^4.0 (behaviors объявляются атрибутами)
Окно терминала
composer require goaop/goaop-yii3-bridge

Плагин yiisoft/config подхватывает конфигурацию моста. Если вы установили мост с выключенным плагином, выполните composer yii-config-rebuild.

public/index.php
use App\Environment;
use Go\Yii3\GoAopBridge\AopBootstrap;
use Yiisoft\Yii\Runner\Http\HttpApplicationRunner;
// ...
$runner = new HttpApplicationRunner(
rootPath: dirname(__DIR__),
debug: Environment::appDebug(),
checkEvents: Environment::appDebug(),
environment: Environment::appEnv(),
);
AopBootstrap::init($runner->getConfig(), rootPath: dirname(__DIR__));
$runner->run();

Добавьте строку AopBootstrap::init() в каждый входной скрипт, между созданием runner и его запуском: public/index.php, yii (с его ConsoleApplicationRunner и rootPath: __DIR__) и bootstrap ваших функциональных тестов. Она читает параметры моста и алиасы из конфигурации runner. Runner сохраняет эту конфигурацию, поэтому параметры не собираются дважды.

Compile step (этап компиляции) применяется только к классам, загруженным после старта ядра (kernel), а runner Yii автозагружает классы, пока строит контейнер. Если пропустить эту строку, ядро всё равно запустит группа конфигурации bootstrap моста, но поздно: классы, загруженные во время построения контейнера, не будут скомпилированы. В режиме отладки это все классы с определениями в виде массива, так что приложение вело бы себя по-разному при разработке и в продакшене.

<?php
declare(strict_types=1);
namespace App\Aspect;
use Go\Aop\Aspect;
use Go\Aop\Intercept\MethodInvocation;
use Go\Lang\Attribute\Around;
use Go\Lang\Attribute\Before;
use Psr\Log\LoggerInterface;
final readonly class LoggingAspect implements Aspect
{
public function __construct(private LoggerInterface $logger) {}
#[Before('execution(public App\Service\**->*(*))')]
public function logCall(MethodInvocation $invocation): void
{
$this->logger->debug('Calling {method}', ['method' => $invocation->getMethod()->getName()]);
}
#[Around('execution(public App\Service\PaymentService->charge(*))')]
public function measureCharge(MethodInvocation $invocation): mixed
{
$start = hrtime(true);
try {
return $invocation->proceed();
} finally {
$this->logger->info('charge() took {ms}ms', ['ms' => (hrtime(true) - $start) / 1e6]);
}
}
}

Перечислите behavior classes в параметре aspects:

config/common/params.php
'goaop/goaop-yii3-bridge' => [
'aspects' => [
App\Aspect\LoggingAspect::class,
App\Aspect\AuditAspect::class,
],
],

Аргументы конструктора, которые нельзя получить автовайрингом, задаются определением в контейнере, как для любого другого сервиса:

use App\Aspect\AuditAspect;
use Yiisoft\Definitions\Reference;
return [
AuditAspect::class => [
'__construct()' => [
'logger' => Reference::to('auditLogger'),
'level' => $params['app']['auditLevel'],
],
],
];

Как получается behavior class:

  1. При старте ядра ничего не автозагружается: имена классов проверяются только синтаксически.
  2. Когда компилятору нужны behaviors какого-то класса, он читает их из класса через рефлексию. Объект behavior class — это нативный ленивый прокси, и он пока не создан.
  3. При первом вызове одного из его behaviors прокси инициализируется через $container->get(AspectClass::class) — общий экземпляр из контейнера Yii.

Behavior class, который зависит от подключения к базе данных или HTTP-клиента, не создаёт их в запросах, которые так и не доходят до метода с behavior. В режиме отладки мост проверяет, что каждый перечисленный класс существует и реализует Go\Aop\Aspect.

Пакет может добавлять behavior classes из собственного config/params.php. Группа params объединяется рекурсивно, списки дополняются, а дубликаты регистрируются один раз:

config/params.php
return [
'goaop/goaop-yii3-bridge' => [
'aspects' => [
Vendor\Package\Aspect\CacheAspect::class,
],
],
];

Задайте 'aspectTag' => 'goaop.aspect'. Затем пометьте тегом определения в общей группе конфигурации di ('tags' => ['goaop.aspect']) или перечислите их в общей карте тегов di-tags (['goaop.aspect' => [LoggingAspect::class]]). Сервисы с тегом должны быть зарегистрированы под именем своего класса.

По умолчанию этот поиск выключен из-за его цены. Мост читает объявления тегов из файлов конфигурации до старта ядра, поэтому каждый класс, на который ссылаются эти файлы (например, через константу класса или вариант перечисления), загружается в этот момент и скомпилирован уже быть не может. Читаются только общие группы. Теги определений di-web/di-console, карты di-tags-web/di-tags-console и сервис-провайдеры не учитываются.

Значения по умолчанию находятся в группе params моста. Переопределяйте их в config/common/params.php или для отдельного окружения в config/environments/<env>/params.php.

Параметр По умолчанию Назначение
debug null Перекомпиляция при изменении исходников или behavior classes. null берёт значение из GOAOP_DEBUG, затем из APP_DEBUG. В продакшене держите выключенным.
appDir '@root' Корень приложения; компилируются только файлы внутри него.
cacheDir null Скомпилированные исходники, прокси и кеши advisors. null берёт значение из GOAOP_CACHE_DIR (можно алиас), затем '@runtime/aop'.
cacheFileMode null Права файлов кеша: целое число (0770) или восьмеричные цифры ('770'). null означает 0770 за вычетом umask.
features 0 Битовая маска флагов Go\Aop\Features: PREBUILT_CACHE, PARTIAL_REFLECTION, INTERCEPT_INCLUDES.
includePaths ['@src'] Компилируются только эти каталоги. Держите список узким.
excludePaths [] Не компилируются никогда. Каталог кеша и сам фреймворк исключаются всегда.
parsedFilesLimit null Сколько разобранных файлов хранится в памяти при компиляции; также значение по умолчанию для aop:warmup --cached-files. null означает значение ядра по умолчанию (100).
aspects [] Behavior classes, которые лениво получаются из контейнера Yii.
aspectTag null Необязательный тег контейнера, регистрирующий behavior classes, например 'goaop.aspect'.

Неверно заданный параметр сразу приводит к ошибке с сообщением, в котором он назван. Ядро доступно в контейнере как Go\Core\AspectKernel (и Go\Yii3\GoAopBridge\Kernel\AspectYii3Kernel), его контейнер — как Go\Core\AspectContainer. После выполнения колбэка bootstrap контейнер ядра делегирует неизвестные id контейнеру Yii.

Если установлен yiisoft/yii-console, мост добавляет в ./yii следующие команды:

Команда Назначение
./yii aop:warmup Компилирует в кеш каждый класс внутри include paths. --fail-fast, --workers=N, --cache-dir=DIR, --preload[=FILE], --cached-files=N.
./yii aop:opcache После aop:warmup прогревает файловый кеш OPcache кешем фреймворка, приложением и его конфигурацией.
./yii aop:debug:aspect Выводит behavior classes с их matching rules (правилами выбора) и advisors (--aspect=... для одного класса).
./yii aop:debug:advisor Выводит advisors или то, что выбирает один advisor (--advisor=...).
./yii aop:debug:weaving Компилирует дважды и сообщает о различающихся прокси, что выявляет циклические зависимости между behavior classes и скомпилированными классами.

Это собственные команды фреймворка, зарегистрированные в пространстве имён aop. Они работают с ядром, которое инициализировала строка во входном скрипте, поэтому их необязательный аргумент loader не указывается. Воркеры --workers=N снова запускают ./yii, и им нужна эта строка. Если ядро запустил резервный путь через bootstrap, команда компилирует в своём собственном процессе и сообщает об этом.

Окно терминала
./yii aop:warmup --workers=4

В продакшене выключите debug и собирайте кеш при деплое. --cache-dir=DIR собирает кеш в другом каталоге, пока ядро продолжает использовать свой. Файлы кеша не зависят от расположения, поэтому каталог можно переместить на место.

Dockerfile
ENV GOAOP_CACHE_DIR=/app/aop
RUN ./yii aop:warmup --workers=4 --preload

На файловых системах только для чтения добавьте Features::PREBUILT_CACHE в features. Тогда движок полностью доверяет кешу и никогда в него не пишет, поэтому пересобирайте кеш при каждом деплое. Класс внутри include paths, о котором кеш не знает, приводит к Go\Aop\Exception\WeavingException. На сам процесс aop:warmup это не распространяется, чтобы он мог скомпилировать такие классы в кеш.

С OPcache ./yii aop:warmup --preload записывает _preload.php в каталог кеша для opcache.preload, а ./yii aop:opcache прогревает файловый кеш в финальном образе:

Окно терминала
mkdir -p /var/cache/opcache && php -d opcache.enable_cli=1 -d opcache.file_cache_only=1 \
-d opcache.file_cache=/var/cache/opcache \
./yii aop:opcache --file-cache=/var/cache/opcache
  • Компилируются только классы внутри appDir и includePaths. Код из vendor не компилируется.
  • Классы, загруженные до AopBootstrap::init(), например App\Environment, скомпилировать нельзя. Как и классы, которые загружает конфигурация, пока её читает строка во входном скрипте.
  • Сами behavior classes компилировать не нужно: исключите их каталог, например 'excludePaths' => ['@src/Aspect'].
  • Если при создании behavior class выполняется один из его собственных behaviors, этот behavior завершается с Go\Aop\Exception\AspectCircularReferenceException. Внедрите эту зависимость лениво (замыканием или через Psr\Container\ContainerInterface) или сузьте matching rule.
  • Ядро глобально для процесса. Долгоживущие воркеры (RoadRunner, Swoole, FrankenPHP) инициализируют его один раз на воркер. Сбрасывайте behavior classes, хранящие состояние отдельного запроса, как любой другой общий сервис.

© 2026 Alexander Lisachenko