Команда di
При старте фреймворк обходит проект и находит классы — это самая дорогая часть
запуска. di управляет кешем этого обхода: собирает его заранее,
показывает содержимое и удаляет. Он же собирает прокси для #[Async] и
атрибутов кеша.
Зачем
Обход проекта читает каждый .php и подключает те, где объявлен класс. На среднем
проекте это десятки миллисекунд и лишние мегабайты в памяти процесса приложения — из
которого потом форкаются все воркеры.
di build делает эту работу один раз, заранее, и складывает результат в файл.
Приложение при старте читает готовый список вместо обхода диска.
Действия
| Действие | Что делает |
|---|---|
build |
Обходит проект один раз: пишет кеш, генерирует прокси, проверяет корректность и имена кешей |
clean |
Удаляет кеш и все сгенерированные прокси |
show [шаблон] |
Печатает классы из кеша; шаблон фильтрует по подстроке FQCN |
proxies [шаблон] |
Печатает методы #[Async] и методы с кешем, и собран ли для них прокси; async — старое имя того же действия |
php call di build
php call di clean
php call di show
php call di show Repository # только содержащие "Repository"
php call di proxiesbuild перед запуском
Основной сценарий — прогрев в контейнере, до старта приложения. Именно так запускает
приложение образ flytachi/winter, на
котором собирается cfg docker:
if ! php /app/call di build; then
echo "winter-entrypoint: 'call di build' failed — refusing to start" >&2
exit 1
fi
exec php /app/call application start`build` — ещё и проверка
Команда не просто складывает список: она разбирает каждый метод #[Async] и каждый
метод с атрибутом кеша и генерирует для них прокси. Метод, который так проксировать
нельзя, роняет сборку — здесь, с понятным сообщением и кодом выхода 1, а не в
проде на первом вызове. С #[EnableCaching] она же проверяет, что каждое имя кеша в
атрибутах объявлено в CacheConfigurer.
Поэтому её и ставят в entrypoint перед запуском: сломанное приложение даёт одну
внятную строку в docker logs вместо контейнера, падающего по кругу.
Сборка останавливается и тогда, когда в .winter/ нельзя писать — например, папка проекта
принадлежит другому пользователю (root) и смонтирована в образ, который работает от имени
winter (uid 1000). Сообщение называет папку и пользователя:
The framework cannot write /app/.winter as this user (winter, uid 1000): it keeps its process records, locks and caches there. Give the user the project folder (chown -R), or create .winter/ owned by it.Отдайте пользователю папку проекта (chown -R) или создайте .winter/, принадлежащую ему.
Запуск приложения в этом случае останавливается с тем же сообщением.
Дополнительно build предупреждает, когда класс с такими методами создаётся через
new — прокси тогда не применится. Проверка текстовая, new $class и фабрики
она не видит, поэтому это именно предупреждение: сборку оно не роняет.
Где лежит кеш
В служебной папке проекта, .winter/build:
.winter/build/di.php список классов
.winter/build/proxy.php список классов с прокси
.winter/build/proxy/ прокси #[Async] и #[Cacheable]Точный путь печатает сама сборка:
| [=================================== Di ===================================]
| di cache .................................................... [BUILT (21 classes)]
| [i] /app/.winter/build/di.php
| proxies ..................................................... [DISABLED (no #[EnableAsync] or #[EnableCaching])]
| [=================================== Di ===================================]Папку можно удалить в любой момент — call di clean делает именно это, — следующий старт
с DEBUG=false или call di build соберёт её заново. В git и в образ она не идёт: строка
/.winter в .gitignore и .dockerignore.
При `DEBUG=true` кеш не используется вовсе
В режиме разработки приложение обходит проект на каждом старте, чтобы новый класс
подхватывался без ручной пересборки. Собранный di build в этом режиме просто
игнорируется.
Если после di build изменения «не видны» — первым делом проверьте DEBUG.
show без кеша
Если кеша нет, show не падает: он выполняет живой обход, печатает результат и
предупреждает, что показанное на диск не записано. Так команда остаётся полезной и
в разработке.
proxies
php call di proxiesПоказывает все методы с #[Async] и с атрибутами кеша, к какой возможности относится
каждый и собран ли для него прокси. Это способ ответить на вопрос «почему метод
выполняется синхронно» или «почему кеш не срабатывает»: если прокси не собран, вызов
идёт напрямую.
| [ Proxied methods (1 classes) ]
| Main\Service\ProductService ................................. [BUILT]
| find() → ?Main\Entity\Product [cache]
| reindex() → void [async]Дальше
- Внедрение зависимостей — что попадает в контейнер
- Асинхронные вызовы —
#[Async]и его прокси - Кеширование методов — атрибуты кеша и проверка имён
- cfg docker — где
di buildстоит в запуске контейнера - Консоль — обзор — все команды