如何在 composer.json 的 extra 字段中存储自定义配置信息?

冰火之心
发布: 2025-12-16 11:19:09
原创
342人浏览过
可在 composer.json 的 extra 字段中写入任意合法 JSON 结构以存放项目自定义配置,Composer 不解析但插件和脚本可通过 $composer->getPackage()->getExtra() 读取,支持嵌套、多种数据类型,推荐小写短横线命名,避免敏感信息。

如何在 composer.json 的 extra 字段中存储自定义配置信息?

可以在 composer.jsonextra 字段中直接写入任意合法的 JSON 结构,用于存放项目专属的自定义配置,Composer 本身不解析或使用这些内容,但插件和脚本可以读取它们。

extra 字段的基本写法

extra 是一个自由格式的对象(即 JSON object),只要符合 JSON 语法即可。推荐用小写字母加短横线(kebab-case)或驼峰命名,避免与 Composer 官方字段冲突(如 branch-aliasinstaller-paths 等已保留字段)。

  • 支持嵌套对象和数组
  • 值可以是字符串、数字、布尔值、数组或对象
  • 不要放敏感信息(如密钥、密码),该文件通常会提交到版本库

composer.json 中添加自定义配置示例

比如为部署脚本配置环境参数:

"extra": {
  "deploy": {
    "host": "example.com",
    "path": "/var/www/myapp",
    "user": "deployer"
  },
  "build": {
    "skip-tests": true,
    "minify-js": true
  }
}
登录后复制

在自定义脚本或插件中读取 extra 配置

通过 Composer 的 API,在事件监听器或命令中获取:

达芬奇
达芬奇

达芬奇——你的AI创作大师

达芬奇 166
查看详情 达芬奇
  • 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中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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