史上最全面的Spring Boot配置文件深入讲解

前言

spring boot在工作中是用到的越来越广泛了，简单方便，有了它，效率提高不知道多少倍。spring boot配置文件对spring boot来说就是入门和基础，经常会用到，所以写下做个总结以便日后查看。

下面话不多说了，来一起看看详细的介绍吧

1.配置文件

当我们构建完spring boot项目后，会在resources目录下给我们一个默认的全局配置文件 application.properties，这是一个空文件，因为spring boot在底层已经把配置都给我们自动配置好了，当在配置文件进行配置时，会修改springboot自动配置的默认值。

配置文件名是固定的

• application.properties

但我们可以修改为

• application.yml

这两个文件本质是一样的，区别只是其中的语法略微不同。

2.值的写法

application.properties 配置文件比较简单，形式如下

• key = value

application.yml 配置文件使用ymal语言，ymal不是如xml般的标记语言，更适合作为配置文件。

下面说下对于不同类型（字符串、数组）如何去规范书写。

2.1 数字，字符串，布尔

1、直接写

name=zhangsan

2、双引号

不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思

name: "zhangsan \n lisi"

输出：

zhangsan
lisi

3、单引号

会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: ‘zhangsan \n lisi'

输出：

zhangsan \n lisi

2.2 对象、map（属性和值）（键值对）

例如配置类中的字段为

map<string,string> maps;

在yml配置文件中，行内写法

person.maps: {key1: value1,key2: value2}

需要注意:号后的空格，或者

person:
 maps:
 key: value

在properties配置文件中

person.maps.key=value

2.3 数组（list、set）

在yml配置文件中

person:
 list:
 - 1
 - 2
 - 3

行内写法

person:
 list: [1,2,3]

在properties配置文件中

person.list[0]=1
person.list[1]=2
person.list[2]=3

3.自定义配置属性

spring boot提供自定义配置组件，拿前面举例的属性来写一个规范的配置文件

@component // 或者@configuration
@configurationproperties(prefix = "person")
public class person {
 private map<string,string> maps;
 private list<string> list;
 private string name;

 public map<string, string> getmaps() {
 return maps;
 }

 public void setmaps(map<string, string> maps) {
 this.maps = maps;
 }

 public list<string> getlist() {
 return list;
 }

 public void setlist(list<string> list) {
 this.list = list;
 }
 public string getname() {
 return name;
 }

 public void setname(string name) {
 this.name = name;
 }
}

@configurationproperties 注解向spring boot声明该类中的所有属性和配置文件中相关的配置进行绑定。

• prefix = "person"：声明配置前戳，将该前戳下的所有属性进行映射。

@component 或者@configuration：将该组件加入spring boot容器，只有这个组件是容器中的组件，配置才生效。

4.配置自动提示

在配置自定义属性时，如果想要获得和配置spring boot属性自动提示一样的功能，则需要加入下面的依赖：

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

若是依旧无法自动提示，可以尝试开启ide的annonation processing

5.配置属性校验

自定义配置文件时，可以使用@validated注解对注入的值进行一些简单的校验，示例代码

@validated
@configuration
@configurationproperties(prefix = "person")
public class person {
 @email
 private string mail;

 public string getmail() {
 return mail;
 }

 public void setmail(string mail) {
 this.mail = mail;
 }
}

@email 注解会对mail字段的注入值进行检验，如果注入的不是一个合法的邮件地址则会抛出异常。

其它常见注解：

• @assertfalse 校验false
• @asserttrue 校验true
• @decimalmax(value=,inclusive=) 小于等于value，inclusive=true，是小于等于
• @decimalmin(value=,inclusive=) 与上类似
• @max(value=) 小于等于value
• @min(value=) 大于等于value
• @notnull 检查null
• @past 检查日期
• @pattern(regex=,flag=) 正则
• @size(min=, max=) 字符串，集合，map限制大小
• @validate 对po实体类进行校验

上述的这些注解位于javax.validation.constraints包下，具体用法查看注释即可了解。

6.自定义配置文件

除了在默认的application文件进行属性配置，我们也可以自定义配置文件，例如新建 peoson.properties ，配置内容如下

person.mail=[e-mail]

然后在配置类中使用@propertysource注解注入该配置文件

@configuration
@configurationproperties(prefix = "person")
@propertysource(value = "classpath:person.properties")
public class person {
 private string mail;

 public string getmail() {
 return mail;
 }

 public void setmail(string mail) {
 this.mail = mail;
 }
}

测试@propertysource注解不支持注入yml文件。

扩展： @importresource：该注解导入spring的xml配置文件，让配置文件里面的内容生效。

例如： @importresource(locations = {"classpath:beans.xml"})

7.配置文件占位符

spring boot配置文件支持占位符，一些用法如下

7.1 随机数

${random.value}
${random.int}
${random.long}
${random.int(10)}
${random.int[1024,65536]}

7.2 默认值

占位符获取之前配置的值，如果没有可以是用:指定默认值

person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

8.多配置文件

8.1 多profile文件

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

默认使用application.properties的配置

8.2 yml支持多文档块方式

通过---可以把一个yml文档分割为多个，并可以通过 spring.profiles.active 属性指定使用哪个配置文件

server:
 port: 8081
spring:
 profiles:
 active: prod #指定使用哪个环境

---
server:
 port: 8083
spring:
 profiles: dev #指定属于哪个环境


---

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

8.3 激活指定profile

无论是使用上述多文档块的方式，还是新建application-dev.yml文件，都可以在配置文件中指定 spring.profiles.active=dev 激活指定的profile，或者

1、使用命令行：

java -jar spring-boot-02-config-0.0.1-snapshot.jar --spring.profiles.active=dev

可以直接在测试的时候，配置传入命令行参数

2、虚拟机参数：

-dspring.profiles.active=dev

9.配置文件加载位置

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

• –file:./config/
• –file:./
• –classpath:/config/
• –classpath:/

优先级由高到底，高优先级的配置会覆盖低优先级的配置；springboot会从这四个位置全部加载主配置文件。

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置；

我们还可以通过spring.config.location来改变默认的配置文件位置，示例：

java -jar spring-boot-demo-0.0.1-snapshot.jar --spring.config.location=g:/application.properties

10.外部配置加载顺序

springboot也可以从以下位置加载配置，优先级从高到低，高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置。

1.命令行参数

所有的配置都可以在命令行上进行指定

java -jar spring-boot-02-config-02-0.0.1-snapshot.jar --server.port=8087 --server.context-path=/abc

多个配置用空格分开，形如 --配置项=值

2.来自java:comp/env的jndi属性

3.java系统属性（system.getproperties()）

4.操作系统环境变量

5.randomvaluepropertysource配置的random.*属性值

由jar包外向jar包内进行寻找

优先加载带{profile}

6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

再来加载不带profile

8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件

9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件

10.@configuration注解类上的@propertysource

11.通过springapplication.setdefaultproperties指定的默认属性

11.自动配置原理

11.1 自动配置原理

1.springboot启动的时候加载主配置类，@enableautoconfiguration注解开启了自动配置功能。

2.@enableautoconfiguration 作用：

• 利用enableautoconfigurationimportselector给容器中导入一些组件
• 可以查看selectimports()方法的内容；
• list<string> configurations = getcandidateconfigurations(annotationmetadata, attributes);获取候选的配置
• springfactoriesloader.loadfactorynames()

     扫描所有jar包类路径下 meta-inf/spring.factories

     把扫描到的这些文件的内容包装成properties对象

     从properties中获取到enableautoconfiguration.class类（类名）对应的值，然后把他们添加在容器中

     将类路径下 meta-inf/spring.factories 里面配置的所有enableautoconfiguration的值加入到了容器中

每一个这样的 xxxautoconfiguration类都是容器中的一个组件，都加入到容器中,用他们来做自动配置。

# auto configure
org.springframework.boot.autoconfigure.enableautoconfiguration=\
org.springframework.boot.autoconfigure.admin.springapplicationadminjmxautoconfiguration,\
......

3.对每一个自动配置类进行自动配置功能。

4.以httpencodingautoconfiguration（http编码自动配置）为例解释自动配置原理；

@configuration //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@enableconfigurationproperties(httpencodingproperties.class) //启动指定类的configurationproperties功能；将配置文件中对应的值和httpencodingproperties绑定起来；并把httpencodingproperties加入到ioc容器中

@conditionalonwebapplication
//spring底层@conditional注解（spring注解版），根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效；判断当前应用是否是web应用，如果是，当前配置类生效

@conditionalonclass(characterencodingfilter.class)
//判断当前项目有没有这个类characterencodingfilter；springmvc中进行乱码解决的过滤器；

@conditionalonproperty(prefix = "spring.http.encoding", value = "enabled", matchifmissing = true)
//判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的
//即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
public class httpencodingautoconfiguration {

 //他已经和springboot的配置文件映射了
 private final httpencodingproperties properties;

 //只有一个有参构造器的情况下，参数的值就会从容器中拿
 public httpencodingautoconfiguration(httpencodingproperties properties) {
 this.properties = properties;
 }

 @bean //给容器中添加一个组件，这个组件的某些值需要从properties中获取
 @conditionalonmissingbean(characterencodingfilter.class) //判断容器没有这个组件
 public characterencodingfilter characterencodingfilter() {
 characterencodingfilter filter = new orderedcharacterencodingfilter();
 filter.setencoding(this.properties.getcharset().name());
 filter.setforcerequestencoding(this.properties.shouldforce(type.request));
 filter.setforceresponseencoding(this.properties.shouldforce(type.response));
 return filter;
 }

根据当前不同的条件判断，决定这个配置类是否生效。

一但这个配置类生效，这个配置类就会给容器中添加各种组件，这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的。

5.所有在配置文件中能配置的属性都是在xxxxproperties类中封装者，配置文件能配置什么就可以参照某个功能对应的这个属性类

@configurationproperties(prefix = "spring.http.encoding") //从配置文件中获取指定的值和bean的属性进行绑定
public class httpencodingproperties {

 public static final charset default_charset = charset.forname("utf-8");

精髓：

​ 1）、springboot启动会加载大量的自动配置类

​ 2）、先看我们需要的功能有没有springboot默认写好的自动配置类

​ 3）、再来看这个自动配置类中到底配置了哪些组件（只要我们要用的组件有，我们就不需要再来配置了）

​ 4）、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值

xxxxautoconfigurartion：自动配置类；给容器中添加组件；

xxxxproperties:封装配置文件中相关属性；

11.2 @conditional注解

@conditional派生注解（spring注解版原生的@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存在指定项

 

 

自动配置类必须在一定的条件下才能生效。

我们怎么知道哪些自动配置类生效？

我们可以通过在properties（yml）启用 debug=true 属性来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效。

============================
conditions evaluation report
============================


positive matches:（自动配置类启用的）
-----------------

 codecsautoconfiguration matched:
 - @conditionalonclass found required class 'org.springframework.http.codec.codecconfigurer'; @conditionalonmissingclass did not find unwanted class (onclasscondition)

 codecsautoconfiguration.jacksoncodecconfiguration matched:
 - @conditionalonclass found required class 'com.fasterxml.jackson.databind.objectmapper'; @conditionalonmissingclass did not find unwanted class (onclasscondition)
.......
negative matches:（没有启动，没有匹配成功的自动配置类）
-----------------

 activemqautoconfiguration:
 did not match:
  - @conditionalonclass did not find required classes 'javax.jms.connectionfactory', 'org.apache.activemq.activemqconnectionfactory' (onclasscondition)

 aopautoconfiguration:
 did not match:
  - @conditionalonclass did not find required classes 'org.aspectj.lang.annotation.aspect', 'org.aspectj.lang.reflect.advice', 'org.aspectj.weaver.annotatedelement' (onclasscondition)

参考

docs.spring.io官方文档

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对服务器之家的支持。

原文链接：https://www.cnblogs.com/yueshutong/p/10025820.html