Composer脚本是需显式触发的钩子,非自动执行;有效事件名如post-install-cmd、post-autoload-dump等必须精确拼写并配置在scripts下,且依赖对应命令执行流程与autoload加载时机。

Composer 的脚本(scripts)不是“安装后自动执行”的黑盒机制,而是由 composer install、composer update 等命令显式触发的钩子;能否执行、何时执行,取决于你是否在 composer.json 中正确定义了对应事件名的脚本键,并且该命令本身支持该事件。
哪些事件名真正有效且被默认调用
Composer 内置了固定名称的事件钩子,只有这些名字才会被自动识别并执行。常见但易错的有:
-
pre-install-cmd和post-install-cmd:在composer install执行前后触发(注意后缀-cmd) -
pre-update-cmd和post-update-cmd:仅在composer update时触发 -
post-autoload-dump:每次自动生成自动加载文件后触发(包括 install/update),适合清理缓存或生成代理类 -
pre-autoload-dump:较少用,但可用于修改 autoloader 生成前的上下文 - 错误写法:
post-install、after-install、onInstall—— 这些名字不会被识别,脚本永远不会运行
如何在 composer.json 中正确配置脚本
脚本值可以是字符串命令、数组(按顺序执行)、或指向 PHP 方法的回调(需类+方法存在且可访问)。关键点是位置必须在 "scripts" 顶层字段下。
{
"scripts": {
"post-install-cmd": [
"@php artisan clear-compiled",
"php artisan optimize:clear"
],
"post-autoload-dump": "MyScriptClass::buildProxyClasses",
"pre-update-cmd": "echo 'Updating dependencies...'"
}
}
- 数组形式会按顺序逐条执行,任一失败则中断后续
- PHP 回调格式必须为
"ClassName::methodName",且该类必须能被 Composer 自动加载(通常放在src/下并已配置 autoload) - 脚本中使用
@php表示调用当前 Composer 进程所用的 PHP 可执行文件,避免硬编码路径
为什么 post-install-cmd 没有执行
最常见原因不是配置错,而是执行命令不对 —— composer install 在已有 vendor/ 且 composer.lock 未变时会跳过依赖安装流程,从而不触发 post-install-cmd。此时实际走的是 composer install --no-scripts 的等效逻辑(即使没加 --no-scripts)。
- 验证方式:加
-v参数运行composer install -v,观察输出中是否有Executing script ...行 - 强制触发:删掉
vendor/和composer.lock后重试,或改用composer update --lock - 更稳妥的替代:把关键逻辑移到
post-autoload-dump,它只要 autoloader 有变化就一定执行,覆盖 install/update/install-from-lock 多种场景
PHP 脚本回调的限制与调试技巧
回调函数接收一个 Composer\Script\Event 对象,可从中获取 IO、composer 实例、参数等,但不能直接访问全局变量或未加载的类。
class MyScriptClass
{
public static function buildProxyClasses($event)
{
$io = $event->getIO();
$io->write("Building proxy classes...");
// 注意:此处不能用 new \App\Services\Xxx(),除非 autoload 已生效且类存在
// 推荐用 $event->getComposer()->getPackage() 等安全方式取上下文
}
}
- 回调必须是
public static方法,否则报Call to undefined method - 调试时优先用
$event->getIO()->write()输出,不要用echo或var_dump,否则可能被静默吞掉 - 若类不在自动加载范围内,Composer 会报
Class not found,此时应检查autoload配置是否包含该文件路径
事件钩子不是魔法,它依赖命令流程和配置精度;最常被忽略的是事件名拼写、命令执行路径是否真触发了该阶段、以及 PHP 回调类的加载时机 —— 这三处出错,脚本就彻底静默。










