如何使用Composer Scripts在安装前后自动执行命令?

11次阅读

composer脚本需通过install/update或run-script触发,预定义钩子如post-install-cmd自动执行,自定义脚本须手动调用;安全执行php脚本应使用相对路径、避免绝对路径和未初始化环境依赖。

如何使用Composer Scripts在安装前后自动执行命令?

composer.json 里的 scripts 怎么写才生效?

Composer 脚本不是写完就自动运行的,必须通过 composer installcomposer update 或显式调用 composer run-script 触发。默认情况下,只有预定义的钩子(如 post-install-cmd)会在对应生命周期自动执行。

  • scripts 是一个 jsON 对象,键名是脚本名(比如 post-install-cmd),值可以是字符串命令、字符串数组或对象(含 scriptdev 字段)
  • 常见自动触发钩子包括:pre-install-cmdpost-install-cmdpre-update-cmdpost-update-cmdpre-autoload-dumppost-autoload-dump
  • 自定义脚本(如 build)不会自动运行,需手动执行 composer run-script build

如何在 post-install-cmd 中安全执行 PHP 脚本?

直接写 "php bin/console cache:clear" 很常见,但容易因环境缺失或路径问题失败。关键在于确保命令可被定位,且不依赖未安装的扩展或配置。

  • 优先使用相对路径或 Composer 自带的 bin 入口,例如:"php ./bin/console cache:clear --env=prod"
  • 避免硬编码绝对路径(如 /usr/bin/php),改用 php 命令让系统解析
  • 如果脚本依赖 autoloader,建议加 composer dump-autoloadpost-autoload-dump,而不是 post-install-cmd,否则可能遇到类找不到
  • PHP 脚本中不要假设 $_SERVER['DOCUMENT_ROOT'] 存在 —— CLI 环境下它通常为空
{     "scripts": {         "post-install-cmd": [             "@php -r "file_put_contents('installed.flag', date('c'));"",             "php ./bin/console cache:clear --no-warmup"         ],         "post-autoload-dump": "php ./bin/console doctrine:schema:update --force"     } }

为什么 pre-install-cmd 里执行 npm install 会失败?

因为 pre-install-cmd 运行时,vendor/ 尚未生成,而很多前端工具(如 laravel Mix、symfony webpack Encore)依赖已安装的 PHP 包提供 CLI 命令或配置文件 —— 此时它们还不存在。

  • 更稳妥的做法是把 node.js 相关命令移到 post-autoload-dump 或独立脚本,再由 CI 显式调用
  • 若必须前置,先检查 nodenpm 是否可用:which node && which npm || echo "node.js not found" && exit 1
  • 注意 windowsnpm 可能不在 PATH,建议用 npm.cmd 或统一用 cmd /c npm install
  • 不要在脚本中静默忽略错误;加 set -e(Shell)或用 && 链式执行,确保前序失败时中断

脚本执行失败时,怎么快速定位问题?

Composer 默认隐藏完整错误输出,只报 “Script … returned with Error code …”,真正原因藏在 stderr 里。

  • 本地调试时加 -v 参数: composer install -v,能看到每条命令的完整执行过程和错误
  • CI 环境中建议在脚本开头加 set -x(Shell)或 echo "Running: …",明确当前步骤
  • 避免在脚本中使用 exit 0 掩盖真实退出码;Composer 依赖子进程返回码判断成功与否
  • PHP 脚本出错时,记得开启 display_errors=stderr 或捕获异常并显式 echo 错误信息

最常被忽略的是权限和工作目录:Composer 执行脚本时的当前目录是项目根目录,但某些命令(如 git 操作)可能隐式依赖 .git 目录是否存在 —— 安装时若项目尚未 git init,就会失败。

text=ZqhQzanResources