可在 composer.json 的 extra 字段中写入任意合法 json 结构以存放项目自定义配置,Composer 不解析但插件和脚本可通过 $composer->getPackage()->getExtra() 读取,支持嵌套、多种数据类型,推荐小写短横线命名,避免敏感信息。

可以在 composer.json 的 extra 字段中直接写入任意合法的 JSON 结构,用于存放项目专属的自定义配置,Composer 本身不解析或使用这些内容,但插件和脚本可以读取它们。
extra 字段的基本写法
extra 是一个自由格式的对象(即 JSON Object),只要符合 JSON 语法即可。推荐用小写字母加短横线(kebab-case)或驼峰命名,避免与 Composer 官方字段冲突(如 branch-alias、installer-paths 等已保留字段)。
- 支持嵌套对象和数组
- 值可以是字符串、数字、布尔值、数组或对象
- 不要放敏感信息(如密钥、密码),该文件通常会提交到版本库
在 composer.json 中添加自定义配置示例
比如为部署脚本配置环境参数:
"extra": { "deploy": { "host": "example.com", "path": "/var/www/myapp", "user": "deployer" }, "build": { "skip-tests": true, "minify-js": true } }
在自定义脚本或插件中读取 extra 配置
通过 Composer 的 API,在事件监听器或命令中获取:
- 在
PluginInterface::activate()或事件回调中:$composer->getPackage()->getExtra() - 返回的是 php 数组,可直接访问键名,例如:
$extra['deploy']['host'] - 建议先做键存在性检查,避免未定义索引警告
配合 scripts 使用自定义逻辑
可在 scripts 中调用 PHP 脚本,并传入 extra 数据:
"scripts": { "deploy": "php deploy.php" }
然后在 deploy.php 中用 json_decode(file_get_contents('composer.json'), true) 或更稳妥地通过 Composer API 加载,提取 extra.deploy 配置执行操作。
基本上就这些 —— extra 就像一个安全又灵活的“便签区”,专为你的工具链服务,不复杂但容易忽略它的扩展潜力。
以上就是如何在 composer.json 的 extra 字段中存储自定义配置信息?的详细内容,更多请关注php中文网其它相关文章!