YAML配置中多键复用同一值的实现方法求助

1. 正确使用YAML锚点&别名（优先推荐） #

很多时候锚点失效是因为语法使用错误，或者解析器未启用相关特性。以下是标准的复用写法：

方式一：合并整个配置片段 #

用&定义锚点，<<: *合并整个片段到目标节点，还支持添加当前节点独有的配置：

# 定义可复用的基础配置
common_resource_config: &common_resource_config
  fields: ["id", "name", "created_at"]
  defaultPattern: "^[a-z0-9]+$"

ROOT_RESOURCE_GET:
  <<: *common_resource_config
  method: GET

ROOT_RESOURCE_CREATE:
  <<: *common_resource_config
  method: POST

ROOT_RESOURCE_UPDATE:
  <<: *common_resource_config
  method: PUT

方式二：单独复用字段值 #

如果只需要复用部分字段，可分别定义锚点：

common_fields: &common_fields ["id", "name", "created_at"]
common_pattern: &common_pattern "^[a-z0-9]+$"

ROOT_RESOURCE_GET:
  fields: *common_fields
  defaultPattern: *common_pattern

ROOT_RESOURCE_CREATE:
  fields: *common_fields
  defaultPattern: *common_pattern

ROOT_RESOURCE_UPDATE:
  fields: *common_fields
  defaultPattern: *common_pattern

注意：如果你的YAML解析器不支持锚点/合并键（比如某些轻量级解析库），可以尝试升级解析器或切换到支持完整YAML 1.2特性的库。

2. 模板引擎预渲染YAML #

如果锚点方案不可行，可通过模板引擎提前渲染出最终的YAML文件，以Jinja2为例：

步骤1：编写模板文件（config_template.j2） #

{% set common_fields = ["id", "name", "created_at"] %}
{% set common_pattern = "^[a-z0-9]+$" %}

ROOT_RESOURCE_GET:
  fields: {{ common_fields }}
  defaultPattern: "{{ common_pattern }}"

ROOT_RESOURCE_CREATE:
  fields: {{ common_fields }}
  defaultPattern: "{{ common_pattern }}"

ROOT_RESOURCE_UPDATE:
  fields: {{ common_fields }}
  defaultPattern: "{{ common_pattern }}"

步骤2：用Python渲染成YAML #

from jinja2 import Template

with open('config_template.j2', 'r') as f:
    template = Template(f.read())

# 渲染并保存最终配置
with open('config.yaml', 'w') as f:
    f.write(template.render())

3. 命令行工具生成配置（适合CI/CD场景） #

用yq（一款YAML处理工具）批量生成重复配置：

步骤1：编写基础配置文件（base.yaml） #

common_config:
  fields: ["id", "name", "created_at"]
  defaultPattern: "^[a-z0-9]+$"

步骤2：执行命令生成最终配置 #

yq eval '
  .ROOT_RESOURCE_GET = .common_config |
  .ROOT_RESOURCE_CREATE = .common_config |
  .ROOT_RESOURCE_UPDATE = .common_config |
  del(.common_config)
' base.yaml > config.yaml

4. 利用框架自带的配置复用特性 #

如果你的项目基于特定框架（如Spring Boot），可直接用框架的占位符机制：

# 定义公共变量
common:
  fields: ["id", "name", "created_at"]
  defaultPattern: "^[a-z0-9]+$"

# 引用公共变量
ROOT_RESOURCE_GET:
  fields: ${common.fields}
  defaultPattern: ${common.defaultPattern}

ROOT_RESOURCE_CREATE:
  fields: ${common.fields}
  defaultPattern: ${common.defaultPattern}

ROOT_RESOURCE_UPDATE:
  fields: ${common.fields}
  defaultPattern: ${common.defaultPattern}

这种方式依赖框架的配置解析能力，确保框架支持${}占位符替换即可。

内容的提问来源于stack exchange，提问作者Shantanu Srivastava