SpringBoot | 详解SpringBoot配置文件及其原理

person:
  lastName: zhangsan
  age: 18
  boss: false
  birth: 2019/12/12
  map: {k1: 1,k2: 2}
  list:
    - lisi
    - zhaoliu
  dog:
     name: 小狗
     age: 2

JavaBean（省略getter、setter、toString方法）：

package com.cerr.springboot.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * 将配置文件中配置的每一个属性的值映射到这个组件中
 * @ConfigurationProperties告诉Springboot将本类中的所有属性和配置文件中相关的配置进行绑定
 *      prefix：配置文件中哪个下面的所有属性进行配置
 *
 *  只有这个组件是容器中的组件，才能使用容器提供的ConfigurationProperties功能
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}

我们可以导入配置文件处理器，以后编写配置就有提示：

        <!-- 导入配置文件处理器，配置文件进行绑定就会有提示 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

刚刚在yml中的配置也可以在properties中配置：

person.last-name=张三
person.age=14
person.birth=2019/12/2
person.boss=false
person.map.k1=11
person.map.k2=22
person.list=a,b,c
person.dog.name=dog
person.dog.age=15

2、@Value获取值和@ConfigurationProperties获取值比较

对于yml或者properties配置文件，这两个注解都可以获取到配置文件的值，但是它们有以下的区别：

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	必须一个一个属性的指定
松散语法（松散绑定）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

如果我们只是在某个业务逻辑中需要获取一下配置文件的某个值时，我们使用@Value比较方便；如果我们专门编写了一个JavaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties。

3、数据校验

在类上标注@Validated注解，并在你需要校验的字段标注上对应的注解即可，假设我们在lastName字段要使用@Eamil校验，则代码如下：

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    @Email
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}

4、使用`@PropertySource`加载指定的配置文件

@PropertySource这个注解可以加载指定的配置文件。
我们定义一个局部的配置文件，文件的位置位于类路径下，如图所示：

使用@PropertySource(value = {"classpath:person.properties"})将该配置文件加载进来：

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}

5、使用`@ImportResource`导入Spring的配置文件

@ImportResource的作用是导入Spring的配置文件，让配置文件里面的内容生效。

我们编写了一个spring的配置文件，位于类路径下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean class="com.cerr.springboot.service.HelloService" id="helloService"></bean>
</beans>

然后我们在Spring的单元测试中测试ioc容器中是否有helloService这个bean：

@SpringBootTest
class Springboot01DemoApplicationTests {
    @Autowired
    ApplicationContext ioc;
    @Test
    public void testHelloService(){
        boolean b = ioc.containsBean("helloService");
        System.out.println(b);
    }
}

结果却是没有这个bean，因为此时这个配置文件并没有被加载，因此我们需要使用@ImportResource注解让该文件加载进来，在主配置类中我们使用该注解：