0

0

Composer如何设置自定义脚本钩子?(事件监听示例)

冰火之心

冰火之心

发布时间:2026-02-27 14:45:43

|

867人浏览过

|

来源于php中文网

原创

scripts 必须作为 composer.json 顶层字段,键为 composer 内置事件名(如 post-install-cmd),值支持字符串、数组或 classname::methodname 格式;事件名拼写错误或位置错误将导致静默失效。

composer如何设置自定义脚本钩子?(事件监听示例)

composer.json 里怎么写 scripts 字段

Composer 的脚本钩子全靠 scripts 字段驱动,它不是插件也不是扩展,就是个 JSON 键值对。写错位置或格式,composer install 不报错但脚本压根不触发。

  • scripts 必须是顶层字段,和 requireautoload 平级,不能塞进 configextra
  • 键名是事件名(比如 post-install-cmd),值可以是字符串命令、数组命令、或指向 PHP 方法的 ClassName::methodName
  • 如果值是数组,Composer 会按顺序执行每一项;字符串则直接交给 shell 解析,注意引号和空格转义

示例:在项目根目录 composer.json 中添加

"scripts": {
  "post-install-cmd": [
    "echo '安装完成'",
    "php -r \"file_put_contents('runtime/installed', date('c'));\""
  ],
  "pre-autoload-dump": "MyScript::beforeAutoload"
}

哪些事件名真正可用、什么时候触发

事件名不是随便写的,必须是 Composer 内置的生命周期钩子,拼错一个字母就静默失效。常见误区是把 post-update 当成合法事件——实际只有 post-update-cmd

  • 命令类事件带 -cmd 后缀:pre-install-cmdpost-update-cmdpost-autoload-dump(无 -cmd
  • post-autoload-dump 在生成自动加载文件后触发,适合清理旧缓存或生成代理类;post-install-cmdpost-update-cmd 区别在于前者只在首次 install 触发,后者在 updateinstall(有 lock 文件时)都触发
  • 自定义脚本名(如 build:assets)不会自动绑定事件,需手动运行 composer run build:assets,也不能被其他事件监听

PHP 类方法当脚本时要注意什么

ClassName::methodName 形式调用 PHP 方法看似高级,但容易因自动加载失败而中断——Composer 运行脚本时,vendor/autoload.php 尚未完全就绪,尤其是 pre-autoload-dump 阶段。

ColorMagic
ColorMagic

AI调色板生成工具

下载
  • 方法必须是 public static,且参数签名要匹配:通常接收一个 Composer\Script\Event 实例
  • 不要在方法里依赖尚未生成的 autoload 文件,比如别在 pre-autoload-dump 里 new 一个刚 require 的类
  • 调试时加 var_dump(get_class($event)); exit; 看是否真进了方法,比猜日志更直接

示例类写法:

class MyScript
{
    public static function beforeAutoload($event)
    {
        $vendorDir = $event->getComposer()->getConfig()->get('vendor-dir');
        file_put_contents("$vendorDir/../.build-timestamp", time());
    }
}

脚本执行失败却不报错?检查这几点

默认情况下,脚本返回非零退出码,Composer 只会警告(Script xxx handling the xxx event returned with error code 1),但不会中断后续流程——除非你加了 --no-interaction 或设了 COMPOSER_NO_INTERACTION=1

  • composer run-script post-install-cmd -v-v 查看完整输出,隐藏的 permission denied 或 command not found 就会露出来
  • Shell 命令中含管道、重定向或 && 时,整个表达式被视为单个命令,出错不会被单独捕获;建议拆成多个数组项,或用 sh -c "xxx && yyy" 包一层
  • Windows 下 php -r 的双引号容易和 CMD 解析冲突,改用单引号包裹 PHP 代码,或直接写 .php 文件再调用

最常被忽略的是:脚本在 CI 环境里以 nobody 用户运行,对 storage/runtime/ 目录没写权限,但错误被吞掉,只看到时间戳没更新。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

160

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

450

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

326

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

504

2023.11.27

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

391

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

348

2023.10.25

Golang 并发编程模型与工程实践:从语言特性到系统性能
Golang 并发编程模型与工程实践:从语言特性到系统性能

本专题系统讲解 Golang 并发编程模型,从语言级特性出发,深入理解 goroutine、channel 与调度机制。结合工程实践,分析并发设计模式、性能瓶颈与资源控制策略,帮助将并发能力有效转化为稳定、可扩展的系统性能优势。

2

2026.02.27

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.6万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 7.3万人学习

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

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