Composer scripts 是 Composer 提供的自动化机制,用于在安装、更新等生命周期执行 PHP 函数或命令。通过在 composer.json 的 scripts 字段定义内置事件(如 post-install-cmd)或自定义脚本(如 hello),可绑定闭包、静态方法或外部命令。例如:"scripts": { "hello": ["php script/hello.php"] },运行 composer run hello 即可触发。PHP 类方法需注册并确保自动加载,如 "greet": "MyScript::hello",配合 autoload.files 加载脚本文件。还可模拟自定义命令,如 setup、clear-cache,实现项目初始化、缓存清理等统一操作,提升开发流程一致性。

Composer scripts 是 Composer 提供的一种机制,允许你在特定生命周期事件(如安装、更新、加载时)自动执行 PHP 函数或外部命令。它们通常用于自动化项目初始化、清理缓存、生成文件等任务。你也可以通过自定义脚本创建类似“自定义命令”的功能,虽然 Composer 本身不是命令行工具框架,但能通过 scripts 模拟出命令行为。
composer scripts 是什么?
在 composer.json 中,scripts 字段定义了一组命名的脚本钩子,这些钩子会在 Composer 执行某些操作时被触发。常见的内置事件包括:
-
post-install-cmd:运行
composer install后触发 -
post-update-cmd:运行
composer update后触发 - pre-autoload-dump:生成自动加载文件前触发
- post-autoload-dump:自动加载文件生成后触发
-
post-create-project-cmd:使用
create-project创建项目后触发
你可以绑定这些事件到闭包函数、类的静态方法或外部可执行命令。
如何定义和运行 scripts?
在 composer.json 中添加 scripts 配置:
{
"scripts": {
"post-install-cmd": [
"echo '项目已安装!'"
],
"hello": [
"php script/hello.php"
]
}
}
然后运行:
composer run hello
这里的 hello 不是内置事件,而是一个自定义脚本名称,可以通过 composer run 脚本名 手动调用。
如何编写 PHP 函数作为脚本?
你可以定义一个类来处理脚本逻辑:
// scripts/MyScript.php
class MyScript {
public static function hello($event) {
$name = $event->getArguments()[0] ?? 'World';
echo "Hello, $name!\n";
}
}
在 composer.json 中注册:
{
"scripts": {
"greet": "MyScript::hello"
}
}
确保该文件能被自动加载,或者放在 composer 的 files 自动加载中:
"autoload": {
"files": ["scripts/MyScript.php"]
}
运行命令:
composer run greet John
输出:Hello, John!
如何模拟自定义 composer 命令?
虽然 Composer 不支持像 Artisan 那样定义完整命令,但你可以把 scripts 当作轻量级命令使用:
- 命名脚本为动词形式,如
build,clear-cache,setup - 指向可执行 PHP 脚本或 shell 脚本
- 通过
composer run xxx调用
示例:
{
"scripts": {
"setup": "php bin/setup.php",
"clear-cache": "rm -rf cache/*",
"test": "phpunit"
}
}
这样团队成员只需运行:
composer run setup
就能统一执行项目初始化流程。
基本上就这些。Composer scripts 适合轻量自动化,不复杂但容易忽略其灵活性。只要合理组织脚本,就能实现类似“自定义命令”的体验。










