Composer scripts字段怎么写_Composer脚本钩子配置教程【完整】

Composer Scripts字段怎么写：一份避坑指南

配置 Composer 的 scripts 字段，看似简单，实则暗藏玄机。一个不留神，脚本就可能“静默失败”——它压根不运行，而 Composer 也不会给你任何错误提示。这背后的核心原因，往往可以归结为几个关键点：脚本必须写在根对象的顶层、钩子名必须精确匹配、命令格式有讲究，以及执行环境并非如你所想。

scripts 必须放在根 composer.json 的顶层 “scripts” 键下

首先得明确，scripts 字段不是普通的配置项，它是 Composer 识别并触发生命周期钩子的唯一入口。这就意味着，它必须被直接放置在 composer.json 文件的根对象下。任何嵌套，比如一时手快塞进了 extra 或 config 对象里，都会被 Composer 彻底忽略，你的脚本自然也就石沉大海了。

• ✅ 正确姿势："scripts": { "post-install-cmd": "php artisan optimize:clear" }
• ❌ 常见误区："extra": { "scripts": { "post-install-cmd": "..." } } —— 这么写，整个对象只会被当作普通的元数据处理，不会触发任何脚本。
• 另外，脚本名本身必须是字符串字面量，不能是变量或包含空格的键名。像 "post install-cmd" 或 "post-install cmd" 这样的写法，同样无效。

钩子名大小写和连字符必须严格匹配内置事件名

这是最容易踩坑的地方之一。Composer 对内置事件名的匹配是“精确制导”的，它不会做模糊匹配，更不会在你拼错时给出友好提示。如果你的脚本“神秘”地没有执行，十有八九是名字写错了。

• ✅ 记住这些标准事件名：pre-install-cmd、post-update-cmd、pre-autoload-dump、post-autoload-dump。
• ❌ 警惕这些典型错误：post-autoloader-dump（多了一个字母 r）、post-dump-autoload（单词顺序反了）、postinstall-cmd（缺少了中间的连字符）。
• 当然，自定义脚本名（比如 ci:test）可以自由发挥，但调用时必须通过 composer run-script 命令，且参数要完全一致：composer run-script ci:test。

命令值用数组比字符串更可靠

在定义具体要执行的命令时，是写成字符串还是数组？经验表明，使用数组格式是更稳妥的选择。字符串命令会经过系统 shell 解析，一旦命令中包含空格、引号嵌套或特殊字符，尤其是在 Windows 或某些 CI 环境中，就很容易解析失败。而数组格式则由 Composer 直接执行，绕过了 shell，参数传递更干净、更可靠。

• ✅ 推荐写法："post-update-cmd": ["php", "artisan", "cache:clear"]
• ✅ 也支持 PHP 回调："post-autoload-dump": ["MyClass::onDump"]（注意，这里引用的类必须能被当前的自动加载器加载）。
• ✅ 支持递归调用：像 "@php -v" 中的 @ 符号，会触发已定义的 php 脚本（如果存在的话）。
• ❌ 尽量避免复杂 Shell 逻辑：类似 "if [ -f .env ]; then php artisan key:generate; fi" 这样的命令，在 Windows 上会直接崩溃，毫无跨平台性可言。

路径、PHP 二进制和环境变量不能依赖默认行为

最后一个需要警惕的层面是执行环境。Composer 执行脚本时，工作目录确实是项目根目录，但这并不意味着一切路径和环境都如你所愿。

• 路径问题：系统的 PATH 环境变量不一定包含项目的 vendor/bin 目录。所以，调用项目依赖的工具时，最好使用完整路径，比如用 vendor/bin/phpunit 而不是简单的 phpunit，这样可以避免全局命令的干扰或缺失。
• PHP 调用：执行 PHP 脚本时，显式地写上 php 命令会更安全，例如 "php ./scripts/deploy.php"，不要依赖脚本文件的 shebang 或可执行权限。
• 环境变量：Composer 不会自动加载你的 .env 文件。如果脚本需要读取其中的环境变量，你得在 PHP 脚本内部自己处理，比如使用 putenv() 或直接 require 那个文件。
• 特殊场景：在 CI 环境中，项目可能是浅克隆（shallow clone）或部署模式，.git 目录可能根本不存在。因此，千万别在 post-install-cmd 这样的钩子里，想当然地尝试拷贝文件到 .git/hooks/ 目录。

最后，再提一个至关重要的细节：post-install-cmd 和 post-update-cmd 这两个钩子的触发时机有微妙差别。post-install-cmd 仅在首次执行 composer install（即 vendor/ 目录为空）时触发。而 post-update-cmd 则会在每次执行 composer update，或者当 composer.lock 文件发生变更后再次执行 install 时触发。如果你误以为“安装后”的逻辑都应该放在 post-install-cmd，很可能会漏掉许多关键的执行时机。