七SpringBoot2核心技术——配置文件

Posted 2021-07-06 上善若水

一、文件类型

1.1、properties

同以前的properties用法一致。

1.2、yaml

1.2.1、简介

YAML 是 “YAML Ain’t Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。
非常适合用来做以数据为中心的配置文件。

1.2.2、基本语法

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

1.2.3、数据类型

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

k: v

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

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

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

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

1.2.4、示例

package com.xbmu.bean;

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

import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;

@Component
@ConfigurationProperties(prefix = "person")
@Data
@ToString
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> salaries;
    private Map<String, List<Pet>> allPets;
}

package com.xbmu.bean;

import lombok.Data;
import lombok.ToString;

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

server:
  port: 8888
# person对象
person:
  #  单引号会将 \\n作为字符串输出   双引号会将\\n 作为换行输出
  #  双引号不会转义，单引号会转义
  userName: zhangsan
  boss: false
  birth: 2012/12/12 12:12:12
  age: 12
  pet:
    name: dog
    weight: 23.4
  interests: [篮球,羽毛球]
  animal:
    - jerry
    - mario
  score:
    english:
      first: 30
      second: 40
      third: 50
    math: [121,140,134]
    chinese: {first: 123,second: 134}
  salaries: [3434,5455.65,4344.56]
  allPets:
    sick:
      - {name: tom}
      - {name: jerry,weight: 45}
    health: [{name: mario,weight: 47}]

package com.xbmu.controller;

import com.xbmu.bean.Person;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @Autowired
    Person person;
    @RequestMapping("/person")
    public Person printPersonInfo()
    {
        System.out.println(person);
        return person;
    }
}

二、配置提示

自定义的类和配置文件绑定一般没有提示。
官方文档：https://docs.spring.io/spring-boot/docs/2.5.0/reference/html/configuration-metadata.html#configuration-metadata.annotation-processor

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

		<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>
        

person:
  # user-name 等同于 userName
  # -n 等价于 N
  user-name: lisi
  age: 18