如何在Composer中通过脚本重写配置文件

雨枫大大_5257

雨枫大大_5257

2026-04-13

455人浏览

原创

composer脚本执行时应使用php原生json操作安全修改配置:先json_decode读取并容错解析,修改数组后用json_encode(带json_unescaped_unicode和json_pretty_print)写入,写入前备份原文件,写入后用json_last_error校验,失败则自动还原;禁用sed等文本替换,因其无法可靠处理跨行、特殊字符及格式变化。

如何在composer中通过脚本重写配置文件

Composer脚本执行时如何安全修改配置文件

Composer 的 scripts 不是 shell 脚本沙盒,它默认在项目根目录执行,且环境变量、工作路径、权限都受当前用户和 Composer 运行方式(如全局 vs 本地)影响。直接用 sed 或 php -r 写配置文件容易覆盖内容、破坏 JSON 格式或忽略 UTF-8 BOM,尤其当配置含注释或非标准结构时。

实操建议优先使用 PHP 原生 JSON 操作,而非文本替换:

  • 用 json_decode(file_get_contents($file), true) 读取,确保解析容错(如尾逗号、多余空格)
  • 修改数组后,用 json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) 输出,避免中文变 \uXXXX
  • 写入前先 file_put_contents($file . '.bak', $original_content) 备份原始文件
  • 写入后用 json_last_error() 校验结果是否合法,失败则自动还原备份

在 composer.json 中定义可复用的重写脚本

不要把逻辑塞进一行 php -r,而是拆成独立 PHP 文件并注册为脚本命令。这样便于调试、单元测试和参数化。

例如,在项目根目录新建 bin/update-config.php:

#!/usr/bin/env php
<?php $configPath = __DIR__ . '/../config/app.php';
if (!file_exists($configPath)) {
    die("Config file not found: $configPath\n");
}
$data = json_decode(file_get_contents($configPath), true) ?: [];
$data['debug'] = ($_SERVER['APP_ENV'] ?? 'dev') === 'dev';
$data['version'] = $_SERVER['COMPOSER_ROOT_VERSION'] ?? 'dev';

file_put_contents($configPath . '.bak', file_get_contents($configPath));
if (false === file_put_contents($configPath, json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n")) {
    file_put_contents($configPath, file_get_contents($configPath . '.bak'));
    die("Failed to write config\n");
}

然后在 composer.json 的 scripts 中注册:

Pandas 配置文件报告生成器
Pandas 配置文件报告生成器

使用ydata-profiling(前身为pandas-profiling)生成全面的数据质量报告,包含相关性分析、缺失值模式和基数检测。导出交互式HTML仪表板和JSON摘要。

下载
"scripts": {
  "post-install-cmd": [
    "php bin/update-config.php"
  ],
  "post-update-cmd": [
    "php bin/update-config.php"
  ]
}

为什么不能用 shell 脚本直接 sed 替换 version 字段

因为 sed -i 's/\"version\":.*$/\"version\": \"1.2.3\",/' config.json 类操作极不可靠:

  • JSON 值可能跨行(尤其开启 JSON_PRETTY_PRINT 后)
  • 字段顺序不固定,version 可能在末尾无逗号,也可能在中间需补逗号
  • 值中含斜杠、引号、反斜杠时,sed 正则易崩溃或误替换
  • Windows 下 sed 行为与 GNU sed 不一致,CI 环境常出错

真正稳定的方式是走 JSON 解析链:读 → 改 → 校验 → 写。哪怕多几行 PHP,也比花半天调 sed 正则强。

注意 post-root-package-install 钩子的执行时机

这个钩子只在 create-project 时触发一次,且此时 vendor/ 尚未生成,autoload 未就绪,无法 require 第三方包。如果脚本依赖 symfony/filesystem 或 spatie/json-api,会直接 fatal error。

可行方案只有两个:

  • 纯原生 PHP 实现(如上例),不引入任何外部依赖
  • 改用 post-create-project-cmd,它在 vendor/ 初始化完成后执行,可安全 require 自定义类

多数人卡在这里——以为钩子名带 “root” 就能最早运行,结果发现连 file_get_contents 都报错,其实是路径或 autoload 问题。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer 配置文件

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

2025.09.11

5577

17

composer是什么插件
composer是什么插件

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

2023.12.25

344

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

563

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

327

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

349

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

300

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

483

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

271

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

330

18

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习