Docker compose 文件中 << 是什么 | Yaml Merge key

前言

Yaml 文件在 Kubernetes 和 Docker compose 使用非常广泛，之前搞过 K8s 的运维同学还有称自己是 Yaml 工程师。不过肯定会有人不知道 Docker compose 文件中 << 是什么，还有 Yaml 的 merge key 概念大家是否了解，它有什么作用呢。

YAML merge key

Merge Key Language-Independent Type (<<) 是 YAML 中的一种数据类型，它允许将多个映射合并到一个映射中。这种类型提供了一种优雅和简洁的方式来组合和重用配置数据。在 YAML 中，<<(称为 Merge Key) 一般和&，* Yaml operators 搭配一起使用。首先 & 用于为复杂的数据结构创建一个锚点，* 则用于引用该锚点。

我们看下官方提供的例子：

yaml 复制代码

---
- &CENTER { x: 1, y: 2 }
- &LEFT { x: 0, y: 2 }
- &BIG { r: 10 }
- &SMALL { r: 1 }

# All the following maps are equal:

- # Explicit keys
  x: 1
  y: 2
  r: 10
  label: center/big

- # Merge one map
  << : *CENTER
  r: 10
  label: center/big

- # Merge multiple maps
  << : [ *CENTER, *BIG ]
  label: center/big

- # Override
  << : [ *BIG, *LEFT, *SMALL ]
  x: 1
  label: center/big

<< Merge key 指定要与当前映射合并的一个或多个映射。它用于指示应将一个或多个指定映射的所有键插入到当前映射中。如果与键关联的值是单个映射节点，则其每个键/值对都将插入到当前映射中，除非该键已存在于其中。如果与 Merge key 关联的值是一个序列，则该序列应包含映射节点，并且每个节点都根据其在序列中的顺序依次合并。序列中较早映射节点中的键将覆盖后面映射节点中指定的键。

也可以使用 python 下面代码帮助理解

python 复制代码

import yaml
import pprint

y_str1 = '''
---
- &CENTER { x: 1, y: 2 }
- &LEFT { x: 0, y: 2 }
- &BIG { r: 10 }
- &SMALL { r: 1 }

# All the following maps are equal:

- # Explicit keys
  x: 1
  y: 2
  r: 10
  label: center/big

- # Merge one map
  << : *CENTER
  r: 10
  label: center/big

- # Merge multiple maps
  << : [ *CENTER, *BIG ]
  label: center/big

- # Override
  << : [ *BIG, *LEFT, *SMALL ]
  x: 1
  label: center/big
         '''

pp = pprint.PrettyPrinter()
y1 = yaml.load(y_str1, Loader=yaml.SafeLoader)
pp.pprint(y1)

结果如下

txt 复制代码

[{'x': 1, 'y': 2},
 {'x': 0, 'y': 2},
 {'r': 10},
 {'r': 1},
 {'label': 'center/big', 'r': 10, 'x': 1, 'y': 2},
 {'label': 'center/big', 'r': 10, 'x': 1, 'y': 2},
 {'label': 'center/big', 'r': 10, 'x': 1, 'y': 2},
 {'label': 'center/big', 'r': 10, 'x': 1, 'y': 2}]

也就是说，合并时遵循的规则是:

如果遇到单个映射，则将该映射的键/值对插入,除非键已存在
如果遇到一个序列，则按序列顺序合并每个映射节点
序列中前面的映射节点具有更高优先级，会覆盖后面的同名键

docker-compose

有没发现，你之前编写的 docker compose 文件，services 里的每个容器的配置的某一部分可能会相同，这就可以使用 <<(Merge key)。使用 YAML Merge key << 可以减少 Docker Compose 文件长度，提高可读性。 实际上很多开源软件里的 docker compose 文件也有用到 Merge key，比如 redash，如下图

总结

Merge key <<语法让 YAML 能够组合和重用数据，使配置更加模块化和可维护。它消除了手动合并映射的需求，从而减少了重复代码。如果您在阅读过程中发现了任何问题，或者有任何可以改进的地方，欢迎留言或者私信我。

参考链接：

yaml.org/type/merge....