Spring Boot在工作中是用到的越来越广泛了，简单方便，有了它，效率提高不知道多少倍。Spring Boot配置文件对Spring Boot来说就是入门和基础，经常会用到，所以写下做个总结以便日后查看。
1.配置文件
如果想学习Java工程化、高性能及分布式、深入浅出。微服务、Spring，MyBatis，Netty源码分析的朋友可以加我的Java高级交流：854630135，群里有阿里大牛直播讲解技术，以及Java大型互联网技术的视频免费分享给大家。
当我们构建完Spring Boot项目后，会在resources目录下给我们一个默认的全局配置文件 application.properties，这是一个空文件，因为Spring Boot在底层已经把配置都给我们自动配置好了，当在配置文件进行配置时，会修改SpringBoot自动配置的默认值。
配置文件名是固定的
但我们可以修改为
这两个文件本质是一样的，区别只是其中的语法略微不同。
2.值的写法
application.properties 配置文件比较简单，形式如下
application.yml 配置文件使用YMAL语言，YMAL不是如XML般的标记语言，更适合作为配置文件。
下面说下对于不同类型（字符串、数组）如何去规范书写。
2.1 数字，字符串，布尔
直接写
name=zhangsan
双引号不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思
name: "zhangsan n lisi"
输出：zhangsanlisi单引号会转义特殊字符，特殊字符最终只是一个普通的字符串数据
name: ‘zhangsan n lisi’
输出：zhangsan n lisi
2.2 对象、Map（属性和值）（键值对）
例如配置类中的字段为
Map 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 maps;
private List list;
private String name;
public Map getMaps() {
return maps;
}
public void setMaps(Map maps) {
this.maps = maps;
}
public List getList() {
return list;
}
public void setList(List list) {
this.list = list;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
@ConfigurationProperties 注解向Spring Boot声明该类中的所有属性和配置文件中相关的配置进行绑定。
@Component 或者@Configuration：将该组件加入Spring Boot容器，只有这个组件是容器中的组件，配置才生效。
4.配置自动提示
在配置自定义属性时，如果想要获得和配置Spring Boot属性自动提示一样的功能，则需要加入下面的依赖：
org.springframework.boot spring-boot-configuration-processor true
若是依旧无法自动提示，可以尝试开启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字段的注入值进行检验，如果注入的不是一个合法的邮件地址则会抛出异常。
其它常见注解：
上述的这些注解位于javax.validation.constraints包下，具体用法查看注释即可了解。
6.自定义配置文件
除了在默认的application文件进行属性配置，我们也可以自定义配置文件，例如新建 peoson.properties ，配置内容如下
person.mail=yster@foxmail.com
然后在配置类中使用@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
如果想学习Java工程化、高性能及分布式、深入浅出。微服务、Spring，MyBatis，Netty源码分析的朋友可以加我的Java高级交流：854630135，群里有阿里大牛直播讲解技术，以及Java大型互联网技术的视频免费分享给大家。
无论是使用上述多文档块的方式，还是新建application-dev.yml文件，都可以在配置文件中指定 spring.profiles.active=dev 激活指定的profile，或者
使用命令行：
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
可以直接在测试的时候，配置传入命令行参数虚拟机参数：-Dspring.profiles.active=dev9.配置文件加载位置
springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
优先级由高到底，高优先级的配置会覆盖低优先级的配置；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 作用：
每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中,用他们来做自动配置。
# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration= org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration, ......
3.对每一个自动配置类进行自动配置功能。
创业/副业必备：
本站已持续更新1W+创业副业顶尖课程，涵盖多个领域。
点击查看详情
评论(0)