Symfony Flex 通过 Composer Recipes 实现“包安装即配置”,自动拉取并应用 JSON 格式 recipe(含文件复制规则、交互提示、命令执行等),由 Flex 插件监听 Composer 事件触发,支持查看、禁用、覆盖及贡献 recipe。

Symfony Flex 通过 Composer Recipes 实现配置自动化,核心在于“包安装即配置”——当你用 composer require 安装一个支持 Flex 的包时,它会自动从官方或自定义 recipe 仓库拉取对应配置文件(如 YAML、PHP、Env 等),并按规则写入项目目录,无需手动复制粘贴。
Recipes 是什么?
Recipes 是 JSON 格式的指令清单,存放在 symfony/recipes(官方)或第三方 recipe 仓库中。每个 recipe 对应一个包的特定版本范围,例如:symfony/mailer:6.4 → 指向 symfony/mailer/6.4 目录下的 manifest.json。
该文件声明了要复制哪些文件、复制到哪、是否需要交互式参数(如 DSN)、是否运行 post-install 命令等。
Flex 如何触发 recipe 执行?
Composer 安装包时,Flex 作为插件监听 post-package-install 和 post-package-update 事件。一旦检测到已安装包在 recipe 仓库中有匹配项,就:
- 下载对应 recipe 的压缩包(ZIP)
- 解压并比对当前项目结构(跳过已存在且未修改的文件)
- 按
manifest.json中的copy-from和copy-to规则写入文件 - 执行
install字段定义的命令(如assets:install)
如何查看/禁用/自定义 recipe 行为?
运行 composer recipes 可列出所有已应用 recipe 及状态(✅ 已安装 / ⚠️ 有冲突 / ❌ 未应用)。
若想跳过某次自动配置,加 --no-scripts 或临时禁用 Flex:composer config extra.symfony.allow-contrib false
想覆盖默认 recipe,可在项目根目录建 config/recipes/包名/版本号/,放入你自己的 manifest.json 和模板文件,Flex 会优先使用本地版本。
自己为包写 recipe 的关键点
recipe 不属于你的包代码,而是单独提交到 symfony/recipes-contrib(社区)或 symfony/recipes(官方审核):
- 文件结构必须严格: vendor-name/package-name/X.Y/
- 必须包含 manifest.json,定义 copy-from(源路径相对于 recipe 目录)、copy-to(目标路径相对于项目根)
- 支持占位符如 %%APP_ENV%%、%%DATABASE_URL%%,Flex 会自动替换为 .env 值
- 避免硬编码敏感值,用交互式 prompt(questions 字段)引导用户输入
基本上就这些。Flex 不是黑魔法,而是把重复的手动配置变成可复用、可审查、可回滚的声明式操作。










