Composer scripts 可在生命周期事件中自动执行脚本,如 pre-install-cmd、post-update-cmd 等,支持 shell 命令或 PHP 静态方法,通过 composer.json 的 scripts 字段定义,结合 autoload 配置实现可复用类,提升项目自动化效率。

Composer 提供了 scripts 功能,允许你在 Composer 执行某些生命周期事件时自动运行自定义脚本。这些脚本可以是 PHP 脚本、命令行指令,或外部程序。通过定义 scripts 钩子,你可以自动化诸如环境配置、代码生成、缓存清理等任务。
常见的 Composer Scripts 钩子
Composer 支持多种内置事件钩子,你可以在 composer.json 中监听这些事件:
-
pre-install-cmd:在
install命令执行前运行 -
post-install-cmd:在
install完成后运行 -
pre-update-cmd:在
update前运行 -
post-update-cmd:在
update后运行 - pre-autoload-dump:在生成自动加载文件前运行
- post-autoload-dump:在自动加载文件生成后运行
-
post-create-project-cmd:在使用
create-project创建项目后运行
如何定义自定义脚本
在项目的 composer.json 文件中,添加 scripts 字段,并绑定事件与要执行的命令或 PHP 方法。
{
"scripts": {
"post-install-cmd": [
"echo '安装完成,正在优化自动加载...'",
"composer dump-autoload --optimize"
],
"post-update-cmd": "php scripts/clear_cache.php"
}
}
示例:调用 PHP 类的静态方法
{
"scripts": {
"post-create-project-cmd": [
"MyScript\\Installer::welcome"
]
}
}
对应的 PHP 类文件需要能被自动加载:
getOperation()->getName() . "\n";
}
}
编写可复用的脚本类
对于复杂逻辑,推荐编写独立的 PHP 类来处理脚本逻辑。该类必须提供一个静态方法,接收 Composer\Script\Event 参数。
确保脚本类所在目录已被自动加载(如通过 psr-4 或 files):
"autoload": {
"psr-4": {
"MyScript\\": "scripts/"
}
}
然后运行 composer dump-autoload 使其生效。
脚本执行注意事项
- 多个脚本可以用数组形式依次执行
- 脚本失败会导致 Composer 命令中断(除非使用
|| true忽略错误) - 在 CI/CD 环境中慎用交互式命令
- PHP 脚本需注意命名空间和自动加载路径
基本上就这些。合理使用 Composer scripts 可以极大提升项目初始化和部署效率,减少人为操作遗漏。










