0

0

如何利用Composer Scripts实现自动化任务? (钩子事件详解)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-11 15:33:09

|

680人浏览过

|

来源于php中文网

原创

需将脚本写在 composer.json 的 scripts 字段下,键名为合法事件名或自定义名;值支持字符串、字符串数组或关联数组,推荐数组形式避免转义问题;仅 scripts 下内容被识别,extra 或拼错字段(如 script)均无效。

如何利用composer scripts实现自动化任务? (钩子事件详解)

composer.json 里的 scripts 怎么写才生效?

必须把命令写在 composer.jsonscripts 字段下,且键名是合法的事件名或自定义脚本名。Composer 不会自动执行任意字段,只认 scripts 下的内容。

常见错误:把脚本写在 extra 或根级,或者拼错字段名(比如写成 script 少了个 s)。

  • 脚本值可以是字符串(单条命令)、字符串数组(顺序执行)、或关联数组(含 cmddev 等选项)
  • 推荐用数组形式,避免 shell 特殊字符转义问题,例如:
    ["php -v", "php artisan optimize:clear"]
  • 如果脚本需区分环境,可用 "@composer run-script --no-dev xxx" 手动控制,但更稳妥的是在脚本内部判断 $_ENV['COMPOSER_DEV_MODE']

哪些钩子事件能被自动触发?

不是所有事件都默认激活——只有 Composer 在执行特定命令(如 installupdaterequire)时,才会按顺序触发对应生命周期钩子。

关键钩子包括:pre-install-cmdpost-install-cmdpre-update-cmdpost-update-cmdpre-autoload-dumppost-autoload-dump。其中 post-autoload-dump 是最常用于生成代理类或刷新缓存的时机。

  • post-autoload-dumpvendor/autoload.php 重生成后立即触发,适合运行 phpstan analyse 或清理 opcache
  • pre-autoload-dump 在 autoloader 重建前触发,适合检查类文件是否缺失或格式是否合规
  • post-root-package-install 只在 root 包(即你当前项目)安装完成时触发,不适用于 require 子依赖

如何让自定义脚本支持参数传递?

Composer 原生不支持带参数的脚本调用(如 composer run my-script -- --env=prod),但可通过环境变量或解析 $argv 绕过限制。

最可靠方式是写一个封装 PHP 脚本,再在 scripts 中调用它:

FreeTTS
FreeTTS

FreeTTS是一个免费开源的在线文本到语音生成解决方案,可以将文本转换成MP3,

下载
#!/usr/bin/env php

然后在 composer.json 中注册:

"scripts": {
  "deploy": [
    "@composer run-script --no-dev deploy:check",
    "php scripts/deploy.php"
  ],
  "deploy:check": "php -r \"if (!getenv('SCRIPT_ENV')) { exit(1); }\""
}
  • 调用时用 SCRIPT_ENV=prod composer run deploy
  • 不要依赖 $argv 直接读取,因为 Composer 启动 PHP 时可能不透传原始参数
  • 若必须用 CLI 参数,建议改用 symfony/console 单独构建命令行工具,而非强塞进 Composer Scripts

为什么 post-update-cmd 有时不执行?

根本原因:这个钩子只在显式执行 composer update 时触发,而 composer install 不会触发它——哪怕 vendor/ 不存在或 composer.lock 已过期。

典型误判场景:CI 环境中先 rm -rf vendorcomposer install,期待 post-update-cmd 运行迁移或构建逻辑,结果静默跳过。

  • 解决方案一:统一用 composer update --lock 替代 install(仅当 lock 文件存在且可信)
  • 解决方案二:把关键逻辑移到 post-install-cmd + post-update-cmd 共享脚本中,并在脚本内用 file_exists('composer.lock') 判断上下文
  • 注意:钩子执行失败(非零退出码)会导致整个 Composer 命令中止,调试时可加 || true 临时绕过,但上线前必须修复

实际项目里最容易被忽略的是钩子触发边界——它不等价于“每次依赖变化”,而是严格绑定到具体命令。想覆盖所有安装/更新路径,得组合多个钩子,或放弃钩子、改用 Makefile / npm scripts 做外层编排。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2402

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1547

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1444

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

951

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1414

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1233

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1305

2023.11.13

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

80

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.5万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号