Composer Scripts 是定义在 composer.json 中的命令钩子,可在安装、更新等生命周期自动执行 PHP 函数或系统命令。支持事件钩子(如 post-install-cmd)和自定义脚本(composer run),可运行 shell 命令或调用 PHP 回调函数,适用于缓存清理、配置生成等任务。通过 @php 和 @composer 快捷方式确保环境一致,推荐使用 PHP 类提升跨平台兼容性,并结合 autoload 加载脚本。合理设计脚本能提升自动化水平,但需注意幂等性、输出控制与生产安全。

Composer 不只是 PHP 依赖管理工具,它的 scripts 功能还能让你在安装、更新、部署等生命周期中自动执行自定义逻辑。合理使用 scripts,可以极大提升开发效率和项目自动化水平。
什么是 Composer Scripts
Composer 的 scripts 是定义在 composer.json 中的命令钩子,允许你在特定事件发生时运行 PHP 函数或系统命令。这些事件包括:包安装、更新、卸载,以及自定义脚本调用。
基本结构如下:
{
"scripts": {
"post-install-cmd": "echo '安装完成!'",
"post-update-cmd": [
"php generate-config.php",
"chmod -R 755 cache/"
]
}
}
支持的事件类型分为两类:事件钩子(如 post-install-cmd)和自定义脚本(可由 composer run 触发)。
常用事件钩子与基础用法
这些是 Composer 内置的常见执行时机,适合自动化常规任务。
-
post-install-cmd:运行
composer install后触发 -
post-update-cmd:运行
composer update后触发 - post-autoload-dump:自动加载文件生成后,适合清理缓存或生成代理类
- pre-install-cmd 和 pre-update-cmd:用于前置检查,比如确认环境配置
你可以指定一个命令字符串,也可以用数组列出多个操作:
"scripts": {
"post-install-cmd": [
"@php artisan optimize",
"@composer dump-autoload"
]
}
注意:@php 和 @composer 是 Composer 提供的快捷方式,分别调用当前项目的 PHP 和 Composer 可执行文件,确保路径一致。
编写 PHP 回调函数处理复杂逻辑
当 shell 命令不够用时,可以定义 PHP 类和方法作为脚本处理器。这种方式更安全、跨平台且易于调试。
例如:
"scripts": {
"post-update-cmd": "App\\Console\\ComposerScripts::postUpdate"
}
对应的 PHP 类需要能被自动加载:
# src/Console/ComposerScripts.php namespace App\Console;class ComposerScripts { public static function postUpdate($event) { $io = $event->getIO(); $io->write("
正在清理旧缓存... "); system('rm -rf var/cache/*');if ($event->isDevMode()) { $io->write("开发模式:跳过生产优化"); return; } $io->write("生成生产配置... "); system('@php bin/console config:dump-public'); }}
$event 是
Composer\Script\Event实例,提供上下文信息如是否为开发模式、输入输出对象等。自定义脚本与组合命令
你还可以定义完全自定义的脚本名称,便于封装项目专用命令。
"scripts": { "build": [ "@composer install --no-dev", "@composer run optimize-autoloader", "npm run build" ], "optimize-autoloader": "@php composer.phar dump-autoload -o", "start-server": "php -S localhost:8000 -t public/" }然后通过以下方式运行:
composer run build composer run start-server这种写法让团队成员无需记忆复杂命令,统一通过
composer run管理项目脚本。最佳实践与注意事项
要让 scripts 发挥最大作用,同时避免陷阱,注意以下几点:
- 保持脚本幂等性:重复运行不会导致错误或状态混乱
- 优先使用 PHP 脚本而非 shell 命令,提高跨平台兼容性
- 输出信息使用
$event->getIO()->write(),支持颜色和静默模式 - 避免阻塞操作或长时间任务,除非明确需要
- 不要在生产 deploy 脚本中执行风险操作(如清库),应加确认机制
- 利用
--no-scripts参数临时禁用所有脚本,用于调试
如果项目较大,考虑将脚本类组织到独立目录,并在 autoload 中注册:
"autoload": {
"psr-4": { "App\\": "src/" },
"files": ["scripts/helpers.php"]
}
基本上就这些。Composer scripts 看似简单,但结合实际项目流程后,能成为自动化部署、环境初始化、构建流程的重要一环。关键是按需设计,保持简洁清晰。










