SpingBoot yml语法及测试总结yml文件常用的五种方式

引言

今天在开发过程中用到了application.yml文件需要配置一些值，略感自己在此方面没有全面系统的使用总结过，因此使用IDEA创建好SpringBoot项目，来测试总结在yml文件中经常用到的几种类型

项目介绍

初始化SpringBoot项目

依赖文件：pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.7</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zhou</groupId>
    <artifactId>springboot-setting</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-setting</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

这里的application.yml为手动新建，作为和application.properties的一个对比

application.properties介绍

看到启动日志中打印出来的端口号是8081端口号，在默认加载配置的时候使用的是application.properties配置文件。但是在项目开发时往往不使用这种方式，而是使用yml文件的方式。因此需要删除默认的配置文件，建立application.yml文件

yml配置文件基本语法

1. YML基本语法
   k：v :表示键值对（这里注意一点就是在键和值之间有一个空格），以空格的缩进来控制层级关系

bookconfig: #这里的bookconfig就是title的一个父级
  title: 三体2：黑暗森林

2. 字面量
   普通的值（日期，浮点型，数字，字符串，布尔）

  title: 三体2：黑暗森林
  pages: 350
  price: 98.5
  award: true  #是否获奖
  publishTime: 2019/03/09

3. List,Set,Array的写法

  tagList: #用- 值表示集合或数组中的一个元素
    - 科幻
    - 文学
    - 物理
  tagArray: [雨果奖,银河奖,星云奖] #行内写法

4. Map的写法

 rolesMap: {role1: 罗辑,role2: 章北海,role3: 托马斯维德}
 otherRolesMap:
    "role4": 史强
    "role5": 叶文洁
    "role7": 丁仪

5. 对象的两种写法

 seriesBook: #空格缩进写法
    serieTitle: 《中国科幻基石丛书》
    seriesNo : 丛书号
    seriesNum: 3
 seriesBook: {serieTitle: 《中国科幻基石丛书》,seriesNo : 丛书号,seriesNum: 3} #行内写法

实际操作测试

这里以书目信息为配置示例：

application.yml

server:
  port: 8083

bookconfig:
  title: 三体2：黑暗森林
  pages: 350
  price: 98.5
  award: true  #是否获奖
  publishTime: 2019/03/09
  tagList:
    - 科幻
    - 文学
    - 物理
  #这里的rolesMap与otherROlesMap的效果一致，只是两种不同的写法
  rolesMap: {role1: 罗辑,role2: 章北海,role3: 托马斯维德}
  otherRolesMap:
    "role4": 史强
    "role5": 叶文洁
    "role7": 丁仪
  #丛书配置的对象
  seriesBook:
    serieTitle: 《中国科幻基石丛书》
    seriesNo : 丛书号
    seriesNum: 3

对应的配置类：
BookConfig.java

package com.zhou.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.HashMap;
import java.util.List;

/**
 * @author zhouquan
 * @description 配置类
 * @date 2022-05-10 17:06
 **/

//prefixe 表示配置文件中的哪个下面的所有属性进行映射。注意：这里的prefix命名必须小写！否则会提示prefix must be in canonical form less...
@ConfigurationProperties(prefix = "bookconfig")
@Data
@Component  //@Component注解表示被加上这个注解的类成为spring容器中的一个组件
public class BookConfig {

    private String title;

    private Integer pages;

    private Double price;

    private Boolean award;

    private Date publishTime;

    private List<String> tagList;

    private HashMap<String, String> rolesMap;

    private HashMap<String, String> otherRolesMap;

    private SeriesBook seriesBook;

}

丛书对象类：
SeriesBook.java

package com.zhou.config;

import lombok.Data;
import org.springframework.stereotype.Component;

/**
 * @author zhouquan
 * @description 对象类
 * @date 2022-05-10 17:27
 **/
@Component
@Data
public class SeriesBook {

    private String seriesTitle;

    private String seriesNo;

    private Integer seriesNum;

}

测试类：
SpringbootSettingApplicationTests.java

package com.zhou;

import com.zhou.config.BookConfig;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringbootSettingApplicationTests {

    @Autowired
    BookConfig bookConfig;

    @Test
    void contextLoads() {
        System.out.println(bookConfig.toString());
    }

}

输出结果：

BookConfig(title=三体2：黑暗森林, pages=350, price=98.5, award=true, publishTime=Sat Mar 09 00:00:00 CST 2019, 
tagList=[科幻, 文学, 物理], 
rolesMap={role1=罗辑, role2=章北海, role3=托马斯维德}, 
otherRolesMap={role4=史强, role5=叶文洁, role7=丁仪}, 
seriesBook=SeriesBook(serieTitle=《中国科幻基石丛书》, seriesNo=丛书号, seriesNum=3))