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

作者: 一颗白菜_ | 来源:发表于2019-12-21 19:29 被阅读0次

一、配置文件

springboot使用一个全局的配置文件，配置文件名是固定的，一般有两种写法：

application.properties
application.yml

配置文件的作用：SpringBoot在底层都给我们自动配置了，而配置文件的作用就是修改SpringBoot自动配置的默认值。

之前的配置文件，都是使用的xml文件格式，但是YAML也可以做配置文件，YAML是以数据为中心，比JSON、XML等等更适合做配置文件。
配置示例（将端口号设置为8081）

server:
  port: 8081

二、YAML语法

1、基本语法

k: v:表示一对键值对（空格必须有）。以空格的缩进来控制层级关系，只要是左对齐的一列数据，都是同一个层级的。并且其属性和值都是大小写敏感的。

示例：

server:
  port: 8081
  path: /hello

2、值的写法

(1)、字面量：普通的值（数字，字符串，布尔）

使用k: v:
对于字符串，默认不用加上单引号或者双引号，""双引号不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思；''单引号就会转义字符，特殊字符最终只是一个普通的字符串数据。

(2)、对象、Map（属性和值）

还是使用k:v:方式，在下一行来写对象的属性和值的关系，注意缩进，例如：

friend:
  lastName: zhangsan
  age: 20

这样表示lastName和age是friend对象的属性。
也可以写成行内写法：friend: {lastName: zhangsan,age: 18}

(3)、数组（List、Set）

用-表示数组中的一个元素

pets:
  - cat,
  - dog,
  - pig

也可以写成：pets: [cat,dog,pig]

三、配置文件值注入

在JavaBean类中加入@ConfigurationProperties注解将配置文件中配置的每一个属性的值映射到这个组件中，并且要将这个类加入到IOC容器中。要注意的是@ConfigurationProperties默认是从全局配置文件中获取值的。

1、一个简单的示例

yml文件：

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注解让该文件加载进来，在主配置类中我们使用该注解：

//导入Spring的配置文件并让其生效
@ImportResource(locations = {"classpath:bean.xml"})
@SpringBootApplication
public class Springboot01DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(Springboot01DemoApplication.class, args);
    }
}

然后我们再一次在Spring的单元测试中测试，现在结果是有包含这个bean。

但是我们不推荐这种形式来给容器添加组件，Spring比较推荐使用以下这种方式：

6、使用配置类及`@Bean`注解来给容器添加组件

Spring比较推荐使用配置类来给容器添加组件，首先我们先定义一个配置类：

package com.cerr.springboot.config;
import com.cerr.springboot.service.HelloService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * 指明当前类是一个配置类，用来替代之前的Spring配置文件
 */
@Configuration
public class AppConfig {
    //将方法的返回值添加到容器中，容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService(){
        System.out.println("给容器中添加组件了");
        return new HelloService();
    }
}

该配置类使用了@Configuration注解，表示其是一个配置类，然后在方法中使用了@Bean注解，该注解的作用是将方法的返回值添加到ioc容器中，并且这个组件的id就是方法名。
我们还是使用刚刚的那个测试类来测试ioc容器中是否包含了这个bean：

四、配置文件占位符

1、随机数

例如在配置文件中给lastName和age字段加上随机数：

person.last-name=张三${random.uuid}
person.age=${random.int}

2、占位符获取之前配置的值

person.last-name=张三${random.uuid}
person.dog.name=${person.last-name:hello}_dog

person.dog.name的值就是person.last-name的值拼上_dog，然后后面的:hello的意思是，如果我们没有在配置文件中指定person.last-name的值，那么那个占位符的默认值就是hello。

五、Profile

1、多Profile文件

我们在编写主配置文件的时候，文件名可以是application-{profile}.properties/yml，默认使用application.properties文件的配置。

我们新建了application-dev.properties,application-prod.properties文件，分别指定其port为8083和80，然后在application.properties文件中：

server.port=8080
spring.profiles.active=dev

第一句表示默认的环境配置（没指定是哪种环境时）为端口号是8080，第二句表示指定dev环境，即使用我们配置的application-dev.properties文件。

2、yml支持多文档块形式

yml中使用---可以将文件分为多文档，在不同的文档中定义即可：

server:
  port: 8081
  path: /hello
spring:
  profiles:
    active: dev
---
server:
  port: 8083
spring:
  profiles: dev

---
server:
  port: 80
spring:
  profiles: prod

上述代码中，在文档2中我们定义了dev环境下的配置，文档3中定义了prod环境下的配置，然后在文档1中我们先定义了默认的配置，并且使用了如下格式来配置环境：

spring:
  profiles:
    active: dev

因此当前使用的环境是dev环境，所以此时的端口号应该是8083，我们启动主启动类：

3、激活指定Profile

(1)、在配置文件中指定`spring.profiles.active`属性来激活

对于properties文件，我们可以这样激活：

spring.profiles.active=dev

(2)、使用命令行来激活

在终端中使用--spring.profiles.active=xxx来激活，比如我们在配置yml配置文件中指定激活dev环境：

server:
  port: 8081
  path: /hello
spring:
  profiles:
    active: dev

但是我们在idea中加上命令行参数--spring.profiles.active=prod表示我们想激活prod环境：

最后启动之后发现使用的是prod的环境配置：

或者是将项目打包为jar包后，在终端中运行该jar包且指定命令行参数也行：

命令行输入：
java -jar springboot-01-demo-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod

3、虚拟机参数

在IDEA中设置虚拟机参数：-Dspring.profiles.active=prod

然后启动：

六、配置文件的加载位置

Springboot启动会扫描以下位置的application.properties或者application.yml文件作为Springboot的默认配置文件：

file:../config/：根目录下的config文件夹下
file:../：根目录下
classpath:/config/：类路径下的config文件夹下
classpath:/：类路径下

以上是按照优先级从高到低的顺序，所有位置的文件都会被加载，高优先级配置内容会覆盖低优先级配置内容，称为互补配置。

例如我们在根目录下新建一个config文件夹，并且新建一个application.properties文件，配置port为8082：

server.port=8082

在类路径下的application.properties文件中配置如下：

server.port=8081

#配置项目的访问路径
server.servlet.context-path=/boot1

因为配置文件遵循高优先级配置内容覆盖低优先级配置内容，所以这类路径下文件的port配置会被第一个文件覆盖，而第一个文件都没配置server.servlet.context-path，所以这个属性的值还是第二个配置文件的值，我们访问后：

我们可以通过配置spring.config.location来改变默认配置
在项目打包好后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件得新位置。

我们在E盘中新建一个application.properties文件，然后设置port为80：

server.port=80

我们将项目打包后，在IDEA的控制台中运行该jar包：

默认端口为80，因此localhost会省略80：

七、外部配置加载顺序

Springboot可以从以下位置加载配置，优先级从高到低，高优先级的配置覆盖低优先级的配置：

(1)、命令行参数

语法：--配置项=值，多个参数使用空格分隔

打包后并在命令行输入：
java -jar springboot-01-demo-0.0.1-SNAPSHOT.jar --server.port=8087
运行jar包并且修改server.port=8087

启动后访问8087端口能正常运行，访问原来的8082端口不能用：

(2)、关于jar包外、jar包内的配置文件以及带不带profiles的顺序区别

由jar包外向jar包内进行寻找，优先加载带profiles，再来加载不带profiles

此时我们项目内配置文件最高优先级的应该是端口为8082，我们将项目打包，然后新建一个boot文件夹，将打包好的jar包放入文件夹中：

然后我们在该文件夹下新建一个application.properties文件（在jar包外），里面的配置如下：

server.port=8089

在命令行中输入：
java -jar springboot-01-demo-0.0.1-SNAPSHOT.jar

此时的端口号为8089，因此证明了我们定义在jar包外的这个配置文件是最高优先级的，我们访问：

因为访问的路径中有/boot2，因此说明我们jar包内定义的配置文件也有起作用，只是有一部分被jar包外的覆盖而已。

(3)、`@Configuration`注解类上的`@PropertySource`

八、SpringBoot配置的原理

1、Springboot启动的时候加载主配置类时开启自动配置功能

主配置类中有@EnableAutoConfiguration注解，我们下面来研究其作用：

2、`@EnableAutoConfiguration`作用

利用AutoConfigurationImportSelector给容器中导入一些组件。可以查看selectImports()的内容：

    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        if (!this.isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        } else {
            AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
            AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata);
            return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
        }
    }

    protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) {
        if (!this.isEnabled(annotationMetadata)) {
            return EMPTY_ENTRY;
        } else {
            AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
            List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
            configurations = this.removeDuplicates(configurations);
            Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
            this.checkExcludedClasses(configurations, exclusions);
            configurations.removeAll(exclusions);
            configurations = this.filter(configurations, autoConfigurationMetadata);
            this.fireAutoConfigurationImportEvents(configurations, exclusions);
            return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
        }
    }

在selectImports方法中调用了getAutoConfigurationEntry()，其方法中的一句代码List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);是获取候选的配置，我们进入该方法：

    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
        List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
        Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
        return configurations;
    }

该方法扫描所有jar包类路径下META-INF/spring.factories文件，并把扫描到的这些文件的内容包装成properties对象。从properties中获取到EnableAutoConfiguration.class类名对应的值，然后把他们添加到容器中。

总结来说其作用就是将类路径下META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值加入到容器中
每一个xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中，用他们来做自动配置。

3、每一个自动配置类进行自动配置

4、我们以`HttpEncodingAutoConfiguration`为例来解释自动配置原理：

首先这个类上有如下的注解：

@Configuration(
    proxyBeanMethods = false
)
@EnableConfigurationProperties({HttpProperties.class})
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
@ConditionalOnClass({CharacterEncodingFilter.class})
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)

我们来逐一分析这些注解：

(1)、@Configuration

表示这是一个配置类。和以前编写的配置文件一样，也可以给容器添加组件

(2)、@EnableConfigurationProperties

这个注解表示启动指定类的ConfigurationProperties功能，我们点进去HttpProperties类，有如下注解：

@ConfigurationProperties(
    prefix = "spring.http"
)
public class HttpProperties{
}

@ConfigurationProperties注解的作用是从配置文件中获取指定的值和bean的属性来进行绑定。

因此所有在配置文件中能配置的属性都是在xxxProperties类中封装着，如果我们想要知道该配置文件能够配置什么功能，我们就可以参考某个功能对应的Properties类

对于这个例子，我们这个注解最后就是让配置文件中对应的值和HttpProperties绑定起来了，并加入到ioc容器中，为后面我们要向容器中添加组件服务。

(3)、@ConditionalOnWebApplication

在Spring底层中有一个@Conditional注解，判断如果满足指定的条件，整个配置类里面的配置会生效。
因此这个@ConditionalOnWebApplication就是判断当前应用是否是web应用，如果是，则当前配置类生效。

(4)、@ConditionalOnClass

判断当前项目有没有这个类。
@ConditionalOnClass({CharacterEncodingFilter.class})表示判断当前项目中有没有CharacterEncodingFilter这个类，这个类是SpringMVC中进行乱码解决的过滤器。

(5)、@ConditionalOnProperty

判断配置文件中是否存在某个配置，在这个例子中：

@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)

表示判断配置文件夹是否有spring.http.encoding.enabled这个配置，而matchIfMissing = true表示如果不存在这个配置，这个配置也是默认生效的。

(6)、总结

因此AutoConfiguration配置类的作用就是不断的判断，最终决定这个配置类是否生效，如果生效的话，则给容器添加各种组件，这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的

HttpEncodingAutoConfiguration类中的一部分源码如下：

public class HttpEncodingAutoConfiguration {
    //通过@EnableConfigurationProperties注解，和SpringBoot的配置文件进行了映射
    private final Encoding properties;
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }
    
    @Bean
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    }
}

5、结论

SpringBoot启动会加载大量的自动配置类。
我们看我们需要的功能有没有SpringBoot默认写好的自动配置类
我们再来看这个自动配置类中配置了哪些组件（如果我们要用的组件有，那我们就不需要再来配置）
给容器中自动配置类添加属性的时候，会从properties类中获取某些属性，我们就可以在配置文件中指定这些属性的值
本质上SpringBoot的各种Properties类就封装了配置文件中的相关属性，然后各种AutoConfiguration自动配置类就会给容器添加各种组件。

九、@Conditional及其自动配置报告

@Conditional作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

`@Conditional`扩展注解	作用（判断是否满足当前指定条件）
`@ConditionalOnJava`	系统的java版本是否符合要求
`@ConditionalOnBean`	容器中存在指定Bean；
`@ConditionalOnMissingBean`	容器中不存在指定Bean；
`@ConditionalOnExpression`	满足SpEL表达式指定
`@ConditionalOnClass`	系统中有指定的类
`@ConditionalOnMissingClass`	系统中没有指定的类
`@ConditionalOnSingleCandidate`	容器中只有一个指定的Bean，或者这个Bean是首选Bean
`@ConditionalOnProperty`	系统中指定的属性是否有指定的值
`@ConditionalOnResource`	类路径下是否存在指定资源文件
`@ConditionalOnWebApplication`	当前是web环境
`@ConditionalOnNotWebApplication`	当前不是web环境
`@ConditionalOnJndi`	JNDI存在指定项

自动配置类必须在一定的条件下才能生效；
我们可以通过设置debug=true属性，来让控制台打印自动配置报告，我们通过配置报告就知道哪些自动配置生效。