SpringBoot 教程核心功能-yml配置文件

 1.配置文件-yaml 的用法

之前我们使用的是 properties 配置文件，现在我们来学习一种新的配置文件 - yaml。

1.1 简介

YAML 是“YAML Ain’t Markup Language”（YAML 不是一种标记语言）的缩写。

它非常适合用来做以数据为中心的配置文件。

1.2 基本语法

• key: value ；kv 之间有空格。
• 大小写敏感
• 使用缩进表示层级关系
• 缩进不允许使用 tab，只允许使用空格
• 缩进的空格数不重要，只要相同层级的元素左对齐即可
• “#” 表示注解
• 字符串无需加引号，如果要加 单引号/双引号 表示字符串内容 会被 转义/不转义

1.3 数据类型

1）字面量：单个的、不可再分的值。date、boolean、string、number、null

k: v

2）对象：键值对的集合。map、hash、set、object

#行内写法
k: {k1:v1, k2:v2, k3:v3}
#或
k:
  k1: v1
  k2: v2
  k3: v3

3）数组：一组按次序排列的值。array、list、queue

# 行内写法
k: [v1,v2,v3]
#或
k:
  - v1
  - v2
  - v3

1.4 示例

实体类如下：

@Component
@ConfigurationProperties(prefix = "person")
@ToString
@Data
public class Person {
    private String userName;
    private Boolean boss;
    private Date birth;
    private Integer age;
    private Pet pet;
    private String[] interests;
    private List<String> animal;
    private Map<String, Object> score;
    private Set<Double> salarys;
    private Map<String, List<Pet>> allPets;
}


@ToString
@Data
public class Pet {
    private String name;
    private Double weight;
}

用 yaml 表示以上对象

person:
  userName: 张三
  boss: true
  birth: 1989/10/09 #日期的表示方式
  age: 30
  pet: #pet 属性表示
    name: tomcat
    weight: 22.2
  interests: [篮球, 游泳] #数组行内表示
  animal: #数组第二种表示
    - jerry
    - mario
  score: # map
    english: 98
    math: [100,99,80]
    yuwen:
      first: 89
      second: 70
  salarys: [6000,5500] # Set
  allPets:
    sick: [{name: 小米, weight: 10},{name: 小菊, weight: 6}]
    helth:
      - {name: 阿黄, weight: 9}
      - {name: 阿红, weight: 9}

1.5 自定义类 配置文件编写提示

自定义的类和配置文件绑定是没有提示的。比如 1.4 中的 yml 文件在编写时， IDEA 没有提示。若想要提示，则需添加如下依赖：

        <!-- 添加此依赖后，自定义类的绑定配置文件就有提示 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

此时，打好的 jar 包里面包含了【spring-boot-configuration-processo-x.x.x.jar】 ，如下图

我们打包的时候，需要去除【spring-boot-configuration-processo】这个 jar 包，所以需要在【spring-boot-maven-plugin】（打包插件）打包时排除【spring-boot-configuration-processo】：

            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.3.7.RELEASE</version>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>