composer scripts 可在事件触发时自动执行任务,如通过 post-update-cmd 清除缓存或调用 php 方法构建资源;可在 composer.json 中定义脚本,支持命令行指令和静态方法,还可手动运行自定义脚本,提升项目自动化效率。

Composer scripts 是 Composer 提供的一种机制,允许你在 Composer 执行某些事件(如安装、更新、加载自动加载器等)时自动运行自定义的 php 函数或命令行脚本。它们常用于自动化项目中的常见任务,比如清空缓存、生成代码、执行数据库迁移等。
常见的 Composer 脚本事件
Composer 内置了一系列生命周期事件,你可以绑定脚本来响应这些事件。例如:
- pre-install-cmd:在
composer install执行前运行 - post-install-cmd:在
composer install执行后运行 - pre-update-cmd:在
composer update前运行 - post-update-cmd:在
composer update后运行 - post-autoload-dump:在自动加载器生成后运行
- post-create-project-cmd:使用
create-project创建项目后运行
如何定义自定义脚本
你可以在项目的 composer.json 文件中通过 scripts 字段来定义脚本。支持两种类型的脚本:闭包函数(PHP 回调)和命令行命令。
1. 运行命令行命令
例如,在每次依赖更新后清除缓存:
{ "scripts": { "post-update-cmd": "php clear-cache.php" } }
2. 执行 PHP 方法(静态方法或闭包)
需要指定类名和方法名,格式为 ClassName::methodName 或 [$className, $methodName]。
例如:
{ "scripts": { "post-update-cmd": [ "MyScript::buildAssets", "MyScript::notifyDeployment" ] } }
对应的 PHP 类:
<?php class MyScript { public static function buildAssets($Event) { echo "构建前端资源...n"; // 执行 gulp、webpack 等 } public static function notifyDeployment($event) { echo "部署通知已发送。n"; } }
注意:方法接收一个 ComposerScriptEvent 对象,可用于获取上下文信息(如是否是更新操作、IO 对象等)。
如何手动运行自定义脚本
除了绑定到特定事件外,你也可以将脚本作为“命令别名”来运行。
例如定义一个名为 clear-cache 的脚本:
{ "scripts": { "clear-cache": "php clear-cache.php" } }
然后通过以下命令运行:
composer run clear-cache
这相当于把 Composer 当作一个简单的任务运行器使用。
实用建议
- 脚本命令可以是任何可执行的 shell 命令,比如
php artisan optimize、npm run build等 - 多个脚本可以用数组形式依次执行
- 使用闭包时需确保类文件能被自动加载(通常放在
autoload区域中) - 调试脚本时可添加日志输出或使用
composer run <script> --verbose查看详情
基本上就这些。合理使用 Composer scripts 可以显著提升项目初始化和维护效率。


