composer scripts 使用详解：如何定义自己的命令脚本？

Composer Scripts 是 composer.json 中定义的自定义脚本或事件钩子，用于在特定生命周期执行命令。例如 "hello" 是自定义命令，运行 composer run hello 输出 Hello World；"build" 为复合脚本，依次执行 composer install --optimize-autoloader 和 php bin/build.php；"test" 调用 PHPUnit。支持事件如 post-install-cmd（安装后清除缓存）、post-update-cmd（更新后检查代码）等。还可通过 PHP 类处理复杂逻辑，如 BuildScript::build 在 build 时生成构建标记。需确保脚本可加载且命令在 PATH 中，推荐使用 composer run 执行脚本，提升自动化效率。

在使用 Composer 管理 PHP 项目时，scripts 是一个非常实用的功能。它允许你在 Composer 执行特定生命周期事件时运行自定义脚本，比如安装依赖后自动执行某些操作，或者定义可调用的命令来简化开发流程。

什么是 Composer Scripts？

Composer 支持在 composer.json 中定义 scripts（脚本），这些脚本可以是 PHP 脚本、命令行指令，也可以是外部脚本文件。它们通常与 Composer 的事件挂钩，例如 post-install-cmd 或 pre-update-dump，也可以通过 scripts 定义自定义命令供开发者手动调用。

如何定义自定义命令脚本？

你可以通过在 composer.json 的 scripts 字段中添加条目来定义自己的命令。下面是一个常见结构：

{
    "scripts": {
        "hello": "echo 'Hello, World!'",
        "build": [
            "@composer install --optimize-autoloader",
            "php bin/build.php"
        ],
        "test": "phpunit"
    }
}

在这个例子中：

• hello 是一个简单的自定义命令，运行 composer hello 就会输出 Hello, World!
• build 是一个复合脚本，包含多个命令，按顺序执行。其中 @composer 表示调用 Composer 自身的命令。
• test 直接调用 PHPUnit 测试工具。

支持的事件类型

除了自定义命名命令，Composer 还支持多种内置事件，可以在对应阶段自动触发脚本：

• pre-install-cmd：在 install 命令执行前运行
• post-install-cmd：在 install 后运行（常用于生成 autoload 文件或清除缓存）
• pre-update-cmd：更新前执行
• post-update-cmd：更新依赖后执行
• post-autoload-dump：自动加载器生成后执行，适合重新生成缓存
• post-create-project-cmd：项目创建完成后运行（如 Laravel 安装后设置密钥）

示例：

Looka

AI辅助Logo和品牌设计工具

894

查看详情

"scripts": {
    "post-install-cmd": [
        "php artisan optimize",
        "chmod -R 755 bootstrap/cache"
    ],
    "post-update-cmd": "php bin/check-codes.php"
}

编写 PHP 脚本类（更高级用法）

如果你需要更复杂的逻辑，可以编写 PHP 类来处理脚本。Composer 支持调用静态方法作为脚本处理器。

步骤如下：

1. 创建一个 PHP 类文件，例如 scripts/BuildScript.php：

<?php
class BuildScript
{
    public static function build($event)
    {
        $composer = $event->getComposer();
        $io = $event->getIO();
        $io->write("<info>开始构建项目...</info>");
        
        // 可以读取配置、操作文件等
        if (file_put_contents('build.lock', date('Y-m-d H:i:s'))) {
            $io->write("构建标记已生成。");
        }
    }
}

2. 在 composer.json 中注册该类：

"scripts": {
    "build": "BuildScript::build"
}

3. 确保该文件能被自动加载，可通过 files 或 classmap 加载：

"autoload": {
    "classmap": ["scripts/"]
}

然后运行 composer dump-autoload 更新自动加载映射。

常用技巧和注意事项

• 脚本支持数组形式，按顺序执行，推荐将相关命令组合在一起。
• 使用 @composer 可以调用其他 Composer 脚本或命令，避免重复路径问题。
• 脚本中的命令必须在系统 PATH 中可用，否则需指定完整路径。
• 调试脚本时，可加上 -v 参数查看详细输出：composer run hello -v
• 从 Composer 2.0 开始，推荐使用 run 命令来执行自定义脚本：composer run build

基本上就这些。合理使用 Composer scripts 能极大提升项目自动化程度，减少重复操作。关键是根据项目需求设计清晰的脚本结构，避免过度复杂化。

以上就是composer scripts 使用详解：如何定义自己的命令脚本？的详细内容，更多请关注php中文网其它相关文章！