SpringBoot 学习笔记：YAML基本语法

青旅半醒 2022-12-31 01:30 177阅读 0赞

### SpringBoot 学习笔记：YAML基本语法 ###

*  扩展名问题\`yaml\`和\`yml\`
 *  \`profiles.active\` 支持同时启用多个
 *  数组
 *  引用 $\{...\}
 *   *  引用上文
     *  跨 Modules 引用
     *   *  include
         *  依赖优先级
 *  随机值
 *  参考资料
 *   *  基本说法
     *  YAML官网
     *  Spring官方文档
     *  湖边的小屋遗址

# 扩展名问题`yaml`和`yml` #

关于`yaml`和`yml`扩展名的问题，yaml.org 官方[**推荐**][Link 1]使用 `.yaml`。  
个人感觉就有点像`html`和`htm`  
与 properties 相比一个优势是支持`SpEL`

# `profiles.active` 支持同时启用多个 #

spring:
      profiles:
        active: dev, test ,prod

# 数组 #

<table> 
 <thead> 
  <tr> 
   <th>数组key</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>arrayName</code> + <code>换行 -</code></td> 
   <td align="left">直接写数组名，<code>value</code> 对应整个数组。<br>每个<code>-</code> 后对应数组中的一个元素</td> 
  </tr> 
  <tr> 
   <td><code>arrayName[index]</code></td> 
   <td align="left">写明索引值，<code>value</code> 对应此索引的元素值</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>数组value</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>{...}</code></td> 
   <td align="left">数组元素为 <code>map</code></td> 
  </tr> 
  <tr> 
   <td><code>[...]</code></td> 
   <td align="left">数组元素为 <code>array</code></td> 
  </tr> 
  <tr> 
   <td>其他</td> 
   <td align="left">其他非集合类型的直接写</td> 
  </tr> 
 </tbody> 
</table>

heroes:
      hero1:
        name: | 张三说：支持多行文本,不信你看： ============================================= 一壶泪，暗淡醇香味。 化作万樽与谁对？ 忧举杯，乐举杯，地老天荒只一醉。 欲哭时，男儿无泪，千般相思苦。 杯中汇…… =============================================
        age: 18
        friend:
          - name: 李四
            age: 19
          - {  name: 王五, age: 20, friend: null}
          - {  name: 赵六, age: 21}
        weapon:
          id: 110
          type: weapon
          price: 99
    
      hero2:
        name: 李四
        age: 18
        friend[0]:
          name: 王五
          age: 19
        friend[1]: {  name: 张三, age: 20, friend: null}
        friend[2]: {  name: 赵六, age: 21}
    
      hero3:
        name: 赵六
        age: 18
        friend: [
          { 
            name: 张三.1,
            age: 19,
            friend: [
              {  name: 王五.1, age: 20, friend: null},
              {  name: 王五.2, age: 20, friend: null}
            ]
          },
          { 
            name: 李四,
            age: 19,
            friend: [
              {  name: 赵六.1, age: 20, friend: null},
              {  name: 赵六.2, age: 20, friend: null}
            ]
          }
        ]

# 引用 $\{…\} #

## 引用上文 ##

`yml`中可以使用 `${...}` 引用上文定义过的内容

hero:
      name: 张三
      age: 18
      friend: null
    
    msg: 法外狂徒：${ hero.name}是也

## 跨 Modules 引用 ##

### include ###

在同一个父子项目中，`Module` 有多个 `A和B`依赖`C`那么`A和B`可以从`C`中`include`配置文件。  
`include`：可以引用多个，按顺序，如果有相同的属性后覆盖前。

<table> 
 <thead> 
  <tr> 
   <th>Module</th> 
   <th>配置文件</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>A</td> 
   <td>application.yml</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>B</td> 
   <td>application.yml</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>C</td> 
   <td>application-common1.yml</td> 
   <td>被A、B依赖</td> 
  </tr> 
  <tr> 
   <td>C</td> 
   <td>application-common2.yml</td> 
   <td>被A、B依赖</td> 
  </tr> 
 </tbody> 
</table>

`A和B`的`application.yml` 。

spring:
      profiles:
        include: common1, common2

### 依赖优先级 ###

`A`依赖`B、C`。依赖中前面的优先级高。（建议不要这样，如果公共的配置，提出来放到一个公共`Module`中）

<table> 
 <thead> 
  <tr> 
   <th>Module</th> 
   <th>配置文件</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>A</td> 
   <td>application.yml</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>B</td> 
   <td>application-common.yml</td> 
   <td>被A依赖</td> 
  </tr> 
  <tr> 
   <td>C</td> 
   <td>application-common.yml</td> 
   <td>被A依赖</td> 
  </tr> 
 </tbody> 
</table>

# 随机值 #

系统还提供了一些随机值如下：integers, longs, uuids, strings

my:
      secret: "${random.value}"
      number: "${random.int}"
      bignumber: "${random.long}"
      uuid: "${random.uuid}"
      number-less-than-ten: "${random.int(10)}"
      number-in-range: "${random.int[1024,65536]}"

# 参考资料 #

## 基本说法 ##

[菜鸟教程：YAML 入门教程][YAML]  
[W3schools：YAML - 简介、语法、示例][W3schools_YAML -]

## YAML官网 ##

[https://yaml.org][https_yaml.org]

## Spring官方文档 ##

`注意查看与自己相符的版本`  
[Spring官网：2.3.4. Importing Additional Data][Spring_2.3.4. Importing Additional Data]  
[Spring官网：2.5. Working with YAML][Spring_2.5. Working with YAML]  
[Spring官网：4. Spring Expression Language (SpEL)][Spring_4. Spring Expression Language _SpEL]

## 湖边的小屋遗址 ##

[SpringBoot 学习笔记：配置文件基础知识][SpringBoot]  
SpringBoot 学习笔记：YAML基本语法  
[SpringBoot 学习笔记：配置文件属性注入][SpringBoot 1]

[Link 1]: https://yaml.org/faq.html
[YAML]: https://www.runoob.com/w3cnote/yaml-intro.html
[W3schools_YAML -]: https://www.w3schools.io/file/yaml-introduction/
[https_yaml.org]: https://yaml.org
[Spring_2.3.4. Importing Additional Data]: https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-files-importing
[Spring_2.5. Working with YAML]: https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-yaml
[Spring_4. Spring Expression Language _SpEL]: https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#expressions
[SpringBoot]: https://jerryjin.blog.csdn.net/article/details/101567819
[SpringBoot 1]: https://jerryjin.blog.csdn.net/article/details/106686482