Composer scripts事件钩子大全 生命周期脚本执行时机【文档】

10次阅读

composer官方定义的事件中,pre-install-cmd和post-install-cmd仅在composer install时触发;pre-update-cmd和post-update-cmd仅在composer update时触发;pre-autoload-dump和post-autoload-dump在autoloader重建时(如install、update、dump-autoload)均触发;pre-root-package-install等仅限root包安装时触发。

Composer scripts事件钩子大全 生命周期脚本执行时机【文档】

Composer scripts 不是“钩子”,而是生命周期中可配置的命令执行点;事件名不等于触发时机,实际执行依赖于调用方式(composer installcomposer update、手动触发等)。

哪些事件名对应真实执行阶段?

Composer 官方定义了固定事件名,但只有部分在标准流程中自动触发。常见被误认为“总能执行”的事件,其实有明确前置条件:

  • pre-install-cmdpost-install-cmd:仅在运行 composer install 时触发(不含 --no-scripts
  • pre-update-cmdpost-update-cmd:仅在 composer update 时触发,install 不会触发它们
  • pre-autoload-dumppost-autoload-dump:只要 autoloader 被重建就会触发(包括 installupdatedump-autoload
  • pre-root-package-install 等内部事件:只在 root 包安装时触发,插件或子依赖不触发

scripts 配置写法影响执行逻辑

同一事件名下多个脚本默认串行执行,但行为受写法细节控制:

  • 数组形式:"post-install-cmd": ["MyScript::doSomething", "php build.php"] —— 每个元素独立执行,任一失败即中断
  • 字符串形式:"post-install-cmd": "MyScript::doSomething && php build.php" —— shell 合并执行,错误可能被忽略
  • 使用 @php 前缀(如 @php -r "file_put_contents('log', date('c'))")可绕过 PATH 查找,避免环境差异导致命令找不到
  • 含空格的路径必须用引号包裹:"php "./scripts/deploy.php" --env=prod"

常见失效场景和调试方法

脚本“没运行”往往不是配置错,而是没走到那个阶段:

  • 运行 composer install --no-scripts → 所有 scripts 全部跳过(包括 post-autoload-dump
  • 本地 composer.lock 已存在且无变更 → install 不触发 pre-update-cmdpost-update-cmd
  • 脚本类未被 autoload 加载 → 报 class 'MyScript' not found,需确认类已声明在 autoloadautoload-dev
  • 调试建议:在脚本开头加 file_put_contents('debug.log', "post-install triggeredn", FILE_appEND);,比 echo 更可靠(避免被静默丢弃)

真正容易被忽略的是:Composer 的事件机制不保证顺序一致性——比如多个包都注册了 post-autoload-dump,执行顺序取决于包加载顺序,而非 composer.json 中声明顺序。

text=ZqhQzanResources