3.SpringBoot配置文件

1.配置文件类型

1.1 properties文件

同以前的properties用法

@Data
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String name;
    private boolean gender;
    private Date birthday;
    private List<String> hobbys;

    private Car car;
    private Map<String,Car> carMap;
    private Map<String,List<Car>> mapList;
}

# 配置Person信息
person.name=张三
person.gender=true
person.birthday=2020/12/12
person.hobbys=[编程,音乐,篮球]

person.car.label=奥迪
person.car.price=200000.0

# Map<String,Car>
person.car-map.AAA.label=奔驰
person.car-map.AAA.price=500000.0

# Map<String,List<Car>>
person.map-list.BBB[0].label=沃尔沃
person.map-list.BBB[0].price=600000.0

person.map-list.BBB[1].label=比亚迪
person.map-list.BBB[1].price=500000.0

@SpringBootTest
class SpringbootCh03ConfigApplicationTests {

    @Autowired
    private Person person;

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

}

1.2 YAML 的用法

YAML 是 “YAML Ain’t Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。

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

1）、基本语法

key: value；kv之间有空格

大小写敏感

使用缩进表示层级关系

缩进不允许使用tab，只允许空格

缩进的空格数不重要，只要相同层级的元素左对齐即可

'#'表示注释

字符串无需加引号，如果要加，单引号’’、双引号""表示字符串内容会被 转义 / 不转义

2）、数据类型

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

k: v

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

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

#或
k: 
  k1: v1
  k2: v2
  k3: v3

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

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

#或者
k:
  - v1
  - v2
  - v3

3）、实例

@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;
}


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

用yaml表示以上对象

person:
  userName: zhangsan
  boss: false
  birth: 2019/12/12 20:12:33
  age: 18
  pet: 
    name: tomcat
    weight: 23.4
  interests: [篮球,游泳]
  animal: 
    - jerry
    - mario
  score:
    english: 
      first: 30
      second: 40
      third: 50
    math: [131,140,148]
    chinese: {first: 128,second: 136}
  salarys: [3999,4999.98,5999.99]
  allPets:
    sick:
      - {name: tom}
      - {name: jerry,weight: 47}
    health: [{name: mario,weight: 47}]

2.自定义类绑定的配置提示

You can easily generate your own configuration metadata file from items annotated with @ConfigurationProperties by using the spring-boot-configuration-processor jar. The jar includes a Java annotation processor which is invoked as your project is compiled.——link（https://docs.spring.io/spring-boot/docs/2.4.2/reference/htmlsingle/#configuration-metadata-annotation-processor）

自定义的类和配置文件绑定一般没有提示。若要提示，添加如下依赖：

<!-- 自定义的类和配置文件绑定有提示 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

<!-- 下面插件作用是工程打包时，不将spring-boot-configuration-processor打进包内，让其只在编码的时候有用 -->
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            
            <configuration>
                <excludes>
                    <exclude>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-configuration-processor</artifactId>
                    </exclude>
                </excludes>
            </configuration>
            
        </plugin>
    </plugins>
</build>