本文详解 Symfony Flex 私有配方（Private Recipe）中 copy-from-recipe 不生效的根本原因，并提供标准、可靠且可维护的替代方案：使用内联 files 字段声明配置文件内容，同时推荐通过官方工具自动生成合规私有配方。
本文详解 symfony flex 私有配方（private recipe）中 `copy-from-recipe` 不生效的根本原因，并提供标准、可靠且可维护的替代方案：使用内联 `files` 字段声明配置文件内容，同时推荐通过官方工具自动生成合规私有配方。
在使用 Symfony Flex 构建私有 Bundle 配方（如内部 SDK、定制化 API 客户端等）时，开发者常误以为私有配方可沿用公开配方的目录结构逻辑——即在 Git 仓库中保留 config/、src/ 等子目录，再通过 "copy-from-recipe": {"config/": "%CONFIG_DIR%"} 实现文件复制。但这是错误的认知。 Flex 的私有配方机制与官方仓库（symfony/recipes 或 recipes-contrib）有本质区别：私有配方不支持“从仓库目录动态复制文件”，所有需注入的文件内容必须以字符串数组形式显式内联到 JSON 中的 files 字段里。
✅ 正确写法：使用 files 字段内联配置内容
以下为修正后的私有配方 composer.json（或独立 manifest.json）关键片段：
{
"manifests": {
"edumedia/gar-api-bundle": {
"manifest": {
"bundles": {
"eduMedia\GarApiBundle\eduMediaGarApiBundle": ["all"]
},
"env": {
"GAR_DISTRIBUTOR_ID": "000000000_0000000000000000",
"GAR_SSL_CERT": "/path/to/cert.pem",
"GAR_SSL_KEY": "/path/to/cert.key"
}
},
"files": {
"config/packages/edumedia_gar_api.yaml": {
"contents": [
"edumedia_gar_api:",
" distributor_id: '%env(GAR_DISTRIBUTOR_ID)%'",
" ssl_cert: '%env(GAR_SSL_CERT)%'",
" ssl_key: '%env(GAR_SSL_KEY)%'",
" remote_env: 'preprod'",
" cache_directory: '%kernel.cache_dir%/gar-cache'"
],
"executable": false
}
},
"ref": "ad610a54abdf2f5563841a4ce4b3c3cb29a7d0ff"
}
}
}
⚠️ 注意事项：
- 路径必须为 目标项目内的相对路径（如 config/packages/xxx.yaml），而非配方仓库中的原始路径；
- contents 是字符串数组，每行一个元素，无需额外换行符，Flex 会自动拼接并保留 YAML 缩进语义；
- executable 应明确设为 false（配置文件不可执行）；
- 所有环境变量引用（如 %env(...)%）必须确保已在 manifest.env 中正确定义，否则运行时将报错。
? 推荐实践：用 symfony/flex 工具链自动生成私有配方
手动拼接 YAML 内容易出错、难维护。更专业的方式是：先按官方配方规范组织本地目录结构，再用 Flex 自带命令生成最终私有配方 JSON。
-
在本地新建目录（例如 recipe-src/），严格遵循官方结构：
recipe-src/ └── edumedia/ └── gar-api-bundle/ └── 1.0/ ├── config/ │ └── packages/ │ └── edumedia_gar_api.yaml └── manifest.json ← 仅含 bundles/env 等元信息，不含 files 编写 recipe-src/edumedia/gar-api-bundle/1.0/config/packages/edumedia_gar_api.yaml（纯内容，无需转义）；
-
运行生成命令（需全局安装 symfony/flex）：
composer create-project symfony/skeleton tmp-skel cd tmp-skel composer config extra.symfony.allow-contrib true # 将你的 bundle 加入 require（触发 flex 解析） composer require edumedia/gar-api-bundle:dev-main --no-update # 使用 flex 命令导出配方（需提前配置好 private repo URL） vendor/bin/flex dump-recipe edumedia/gar-api-bundle > ../final-recipe.json
该流程确保生成的 JSON 符合 Flex 私有配方规范，且天然支持多版本、多环境、多文件场景。
✅ 总结
| 误区 | 正解 |
|---|---|
| 认为私有配方支持 copy-from-recipe 目录复制 | ✅ 必须用 files + contents 内联全部文件内容 |
| 手动拼接 YAML 字符串易格式错误 | ✅ 优先使用 flex dump-recipe 工具链自动化生成 |
| 忽略 ref 必须指向包含完整配方结构的 Git commit | ✅ ref 应为配方仓库中该版本结构的精确 commit hash |
遵循以上规范，即可让私有 Symfony Bundle 在 composer require 时，精准、稳定地完成配置注入与环境初始化，真正发挥 Flex “零配置体验”的设计初衷。
