Spring杂谈之SpringBoot配置文件详解

上一篇我们详细的学习了SpringBoot的统一日志处理机制，以及通过slf4j的桥接原理实现了本地日志与分布式
日志合并实践，本篇我们来详细的探索SpringBoot中的配置文件

SpringBoot配置文件

在SpringBoot中常见的参数的配置，都会默认自动配置，并且提供了一个默认的全局配置文件，文件名固定，如下:

•application.properties
•application.yml

可以看到除了常见的properties配置文件以外，SpringBoot中还引入了yml文件作为配置文件，效果等同于properties，并且官方默认推荐使用yml来替代properties文件，究其原因和properties文件灵活性以及编码问题等相关，也和yml配置文件自身的灵活特性有关，接下来我们来学习一下yml文件的常见基本语法

YAML配置文件语法

为什么Yaml更适合做配置文件

在以前Spring时代，大多数配置文件都使用的是xxx.xml等，需要遵循严格的语法与标签语义化实现配置，配置复杂繁多，而YAML（YAML Ain't Markup Language）以数据为中心，比起json、xml等更关注于配置项与数据，自身语法较松散灵活，并不严格局限语法，所以更适合做配置文件，举个例子:

server:
  port: 8081

而这个简单的配置在xml中则是需要如下配置:

<server>
    <port>8081</port>    
</server>

YAML基本语法

YAML的基本语法为K:(空格)v :表示一堆键值对(需要注意的是这里的空格必须有，而且千万别用tab键！)，在yaml中唯一的局限是每个层级之间必须依靠空格来控制，只要是左对齐的一列数据都是同一个层级的属性和值，同样的如果需要在下一个层级，必须要在上一层的配置右边空格两位，举例如下:

server:
    port: 8081
    path: /demo

需要注意的是在YAML中也是大小写敏感的，千万不要写错哦

普通值、对象、Map与数组

在YAML中支持更多类型的数据，主要分为普通数值(包括数字、字符串、布尔类型等常见基础类型)；对象与Map类型（包括复杂对象类型）；以及数组类型(包括Set、List等)。我们来逐一看看各种类型在YAML中的语法:

1.普通类型值

可以在YAML文件中直接按照K:(空格)v 的格式直接填写，但是需要注意的是字符串类型值，在yaml中字符串的值与其他值一样，不需要添加“”或者‘’修饰，在yaml中如果添加了“”(双引号)，代表在双引号范围内的字符串的特殊字符并不需要进行转义，会按照原样符号意义输出，例如:

name: "zhangsan \n lisi"

输出的结果为: zhangsan 换行 lisi

如果是添加了''(单引号)会将当前的单引号内的字符串中所有的特殊字符进行转义，输出为普通的字符串，例如：

name: 'zhangsan \n lisi'

输出的结果为 : zhangsan \n lisi

2.对象类型与Map类型

在yaml中对象类型和Map类型的写法都是一样的，层级代表当前属性所在的层级，而每个属性的key就是yaml的key，例如:

demo:
  lastName: zhangsan        
  age: 20 

而demo可以是一个Map，包含了lastName以及age的key，也可以是一个对象实例，包含这两个名叫lastName以及age的属性

3.数组(Set、List)类型

在yaml中对于数组类型的值有两种支持的写法，第一种写法每一个值对应数组中的一个值，没有key，变为-替代，如下：

pets:
 ‐ cat
 ‐ dog
 ‐ pig

而第二种写法则是yaml对于这类数组类型的优化写法，支持将值写入一行，代表一个数组的值，使用[]进行包裹，如下:

pets: [cat,dog,pig]

自动注入配置文件

了解了yaml的基础语法以后，我们来使用SpringBoot的配置文件自动注入来读取我们的配置参数，在SpringBoot中，我们可以将测试文件编写一个对应的实体类Bean，将Bean申明给Spring接管，并且在类上标记@ConfigurationProperties注解，添加此注解后，SpringBoot会将配置文件中的每一个属性的值，映射到这个Bean中，而在ConfigurationProperties注解中有prefix参数可填，代表着将配置文件中的哪一部分与当前的Bean进行匹配注入，即可将配置文件的值注入到实体Bean中，例子如下:

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      ‐ lisi
      ‐ zhaoliu
    dog:
      name: 小狗
      age: 12

对应的实体Bean为:

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定，默认是application.yml/application.properties；
 *      prefix = "person"：配置文件中哪个key开始将下面的所有属性进行一一映射
 * 只有当前实体Bean是容器中的组件，才能使用      @ConfigurationProperties开启自动注入配置功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

使用这个功能，我们还可以将配置文件处理器的依赖添加进来，以后再去编写配置文件的时候就有属性提示了，会自动帮我们查找关联当前配置文件的实体Bean，pom坐标如下:

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

在需要获取对应配置的地方使用自动注入B该实体Bean即可

使用@Value获取值和@ConfigurationProperties获取值比较

同样在SpringBoot中我们还可以通过传统的方式--@Value注解的方式，将配置文件中的每一个属性单独注入到指定的字段中，而使用@Value和使用@ConfigurationProperties方式注入配置文件有何不同？我们将两种方式的区别是局限性列了表格，作为参照，表格如下:

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

前面我们通过@ConfigurationProperties读取了application.yml的配置信息，那么我们能不能读取其他的配置文件加载进对应的配置bean中呢？在SpringBoot中提供了一个@PropertySource的注解，可以指定加载的配置文件，例如:

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
}

这样就可以指定其他的配置文件加载进对应的配置实体中

ImportResource

我们在使用Spring编程的时候，往往喜欢使用xml配置的方式配置对应的bean实例，而在SpringBoot中可以通过@ImportResource注解的方式，导入对应的xml配置文件，将其配置在某个配置类上，即可将xml配置文件中的实例注册，例如我们现在编写一个xml配置文件:

<?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 id="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
</beans>

然后使用@ImportResource将xml配置文件导入:

//导入Spring的配置文件让其生效
@ImportResource(locations = {"classpath:beans.xml"})

而熟悉Spring注解驱动开发的应该明白，在Spring4.x版本开始，Spring支持全注解式申明Bean配置，而要完成注解式申明Bean，我们只需要@Configuration替代xml配置文件，而在配置类中，我们需要注册的Bean可以使用@Bean 将组件添加进Spring中，即可实现和xml配置一样的操作,例如:

/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 *
 在配置文件中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {
    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("往Spring中添加HelloService组件...");
        return new HelloService();
    }
}

多Profile文件配置

我们在日常开发过程中往往会遇到需要多个环境使用多个配置的场景，这个时候我们往往会配置多个profile，即

application-{profile}.properties/yml 文件，而在yml中还支持多个文档块的方式配置，即可以在一个yml文件中配置多个profile环境的配置:

server:
  port: 8081
spring:
  profiles:
    active: prod

server:
  port: 8083
spring:
  profiles: dev

server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

而使用也比较简单，可以选择以下几种方式指定默认激活的环境:

1.在配置文件中指定

我们在配置文件中可以指定

spring.profiles.active=dev

2.java启动命令参数指定

java -jar spring-boot-config.jar --spring.profiles.active=dev；

3.配置jvm虚拟机启动参数指定默认参数

-Dspring.profiles.active=dev

默认加载配置文件

还记得文章开篇我们说过，在SpringBoot中默认会扫描项目中的application.properties或者application.yml 文件作为Spring boot的默认配置文件，而SpringBoot中默认会从以下四个地方加载主配置文件，优先级由高到低，如下:

–file:./config/       ##工程所在跟目录平级的config目录
–file:./             ##工程所在根目录
–classpath:/config/   ##当前工程内的config包目录中
–classpath:/          ##当前工程的类加载范围内(包括jar中)

这里需要注意的是，SpringBoot默认加载机制由高优先级开始查找配置，如果多个文件中有同一个配置，并且配置得值不相同，那么SpringBoot并不会查找最后一个配置对应的值，而是以第一个查找到的值为主，即高优先级会覆盖低优先级的配置。当然除了SpringBoot默认的加载主配置文件的机制外，我们还可以通过在启动jar的java命令参数中加入spring.config.location参数，指定我们的默认主配置文件的位置，命令如下:

java -jar spring-boot-config.jar  --spring.config.location=G:/application.properties

外部化配置文件加载顺序

除了我们命令指定的外部配置文件以外，SpringBoot还支持了多种加载外部化配置文件的策略，按照优先级从高到低排序，如下:

命令行参数

将一些我们需要的配置项在启动jar的时候，使用参数传递进去，如：

java -jar spring-boot-Config.jar --server.port=8087 --server.context-path=/abc

系统属性与环境变量

可以从System.getProperties()中获取配置在系统属性的参数，也可以从操作系统自身的配置的环境变量中获取

带profile的配置文件

优先从jar包外的application-{profile}.properties或application.yml(带spring.profile)配置文件中读取需要的配置参数，如果没有会从jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件中加载配置参数

不带profile的配置文件

优先从jar包外的application.properties或application.yml(不带spring.profile)配置文件中读取需要的配置参数，如果没有会从jar包内部的application.properties或application.yml(不带spring.profile)配置文件中加载配置参数

@PropertySource

包含@Configuration注解的类上的@PropertySource注解指定的参数

SpringApplication.setDefaultProperties指定

最后，SpringBoot会加载通过SpringApplication.setDefaultProperties配置的默认参数作为配置参数