这可能是把SpringBoot配置文件讲解的最详细的文章了
一、配置文件
SpringBoot使用一个全局的配置文件,配置文件名是固定的,配置文件主要分为以下两种
•application.properties
•application.yml
配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;
YAML(YAML Ain't Markup Language
YAML A Markup Language:是一个标记语言
YAML isn't Markup Language:不是一个标记语言;
标记语言:
以前的配置文件;大多都使用的是 xxxx.xml 文件;
YAML: 以数据为中心 ,比json、xml等更适合做配置文件;
YAML:配置例子
server:
port: 8081
XML:<server>
<port>8081</port>
</server>
二、YAML语法
1、基本语法
k:(空格)v:表示一对键值对(空格必须有);
以
空格
的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的
server:
port: 8081
path: /hello
属性和值也是大小写敏感;
2、值的写法
字面量:普通的值(数字,字符串,布尔)
k: v:字面直接来写;
字符串默认不用加上单引号或者双引号;
"":双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
name: "zhangsan \n lisi":输出;zhangsan 换行 lisi
'':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据
name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi
对象、Map(属性和值)(键值对):
k: v:在下一行来写对象的属性和值的关系;注意缩进
对象还是k: v的方式
friends:
lastName: zhangsan
age: 20
行内写法:
friends: {lastName: zhangsan,age: 18}
数组(List、Set):
用- 值表示数组中的一个元素
pets:
- cat
- dog
- pig
people:
- name
- age
- address
行内写法
pets: [cat,dog,pig]
三、配置文件值注入
配置文件
person:
lastName: hello
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
- lisi
- zhaoliu
name: 小狗
age: 12
javaBean:
/**
* 将配置文件中配置的每一个属性的值,映射到这个组件中
* @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
* prefix = "person":配置文件中哪个下面的所有属性进行一一映射
* 只有这个组件是容器中的组件,才能容器提供的@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;
我们可以导入配置文件处理器,以后编写配置就有提示了
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
①在springboot单元测试中,bean对象注入失败的问题
我的单元测试里面显示bean对象注入失败,我们都知道spring中使用注解会在spring配置文件中开启扫描注解的方法,springmvc也是一样,那么spring-boot也会提供一个扫描注解的方法叫做@ComponentScan(basePackages = {"com.bdqn.Controller"}),表示会扫描到basePackages中所有约定包下面的所有注解
后来经研究发现,SpringBoot项目的Bean装配默认规则是根据Application类所在的包位置从上往下扫描!“Application类”是指SpringBoot项目入口类。这个类的位置很关键:
如果Application类所在的包为:
io.github.gefangshuai.app
,则只会扫描
io.github.gefangshuai.app
包及其所有子包,如果service或dao所在包不在
io.github.gefangshuai.app
及其子包下,则不会被扫描!
本次测试的是yml配置文件映射动态绑定到实体类中,但是在单元测试类中出现bean对象扫描失败
这里给大家说明两点要注意的地方:
①测试文件的项目名称要和启动类的项目名称保持一致
②扫描注解只有放在启动类上面才会起到扫描bean对象的作用
实现步骤如下
/***
* 将配置文件中配置的每一个值映射到这个组件中
* * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
* * prefix = "person":配置文件中哪个下面的所有属性进行一一映射
* * 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
* */
@Component //把实体类注入容器
@ConfigurationProperties(prefix = "person")
public class Person {
// alt+insert
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
###aplication.yml配置文件
person:
lastName: hello
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
- lisi
- zhaoliu
name: 小狗
age: 12
springboot启动类
@SpringBootApplication
@ComponentScan(basePackages = {"com.bdqn"})
* 当测试启动类和Controller不位于同一个包下面时候需要
* 配置@ComponentScan(basePackages = {"com.bdqn.Controller"})去扫描controller的路径
public class SpringBootQuickApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootQuickApplication.class, args);
}
在springboot提供的单元测试类里面进行测试
启动单元测试类,拿到了application.yml文件中配置的值
②@Value获取值和@ConfigurationProperties获取值比较
②@Value获取值和@ConfigurationProperties获取值比较
配置文件yml还是properties他们都能获取到值;
如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;
测试代码如下
application.properties文件,实体类的代码还是不变
##修改spring-boot给我们底层的默认配置
#默认是的的是utf-8
#配置person的值
person.last-name=tom
person.age=18
person.boss=true
person.birth=2017/10/1
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=dog
person.dog.age=15
@RestController
* 相当于 Contoller和RequestBody的合体,都是把数据响应给浏览器
@RequestMapping("/test")
public class HelloController {
@Value("${person.last-name}")
private String name;
@RequestMapping("/hello")
public String hello(){
return "hello you name is"+name;
③、配置文件注入值数据校验
③、配置文件注入值数据校验
@Component
@ConfigurationProperties(prefix = "person")
@Validated //专门验证数据的格式是否正确
public class Person {
* <bean class="Person">
* <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
* <bean/>
//lastName必须是邮箱格式
@Email
//@Value("${person.last-name}")
private String lastName;
//@Value("#{11*2}")
private Integer age;
//@Value("true")
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
④@PropertySource&@ImportResource&@Bean
④@PropertySource&@ImportResource&@Bean
/**
* 将配置文件中配置的每一个属性的值,映射到这个组件中
* @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
* prefix = "person":配置文件中哪个下面的所有属性进行一一映射
* 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
* @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值;
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
* <bean class="Person">
* <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
* <bean/>
//lastName必须是邮箱格式
// @Email
//@Value("${person.last-name}")
private String lastName;
//@Value("#{11*2}")
private Integer age;
//@Value("true")
private Boolean boss;
@
ImportResource
:导入Spring的配置文件,让配置文件里面的内容生效;
Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;
想让Spring的配置文件生效,加载进来;@
ImportResource
标注在一个启动Application配置类上,ApplicationContext.xml
<bean id="helloService" class="com.bdqn.Controller.service.HelloService"></bean>
单元测试类代码如下,不加入@ImportResource情况下
@Test
public void TestService(){
//测试容器中是否有这个值
Boolean bean= (Boolean) ioc.containsBean("helloService");
System.out.println(bean);
}
@SpringBootApplication
@ComponentScan(basePackages = {"com.bdqn"})
//引入spring的配置文件
@ImportResource(locations = {"classpath:ApplicationContext.xml"})
* 当测试启动类和Controller不位于同一个包下面时候需要
* 配置@ComponentScan(basePackages = {"com.bdqn.Controller"})去扫描controller的路径
public class SpringBootQuickApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootQuickApplication.class, args);
}
不用编写Spring的配置文件
SpringBoot推荐给容器中添加组件的方式;推荐使用全注解的方式,但是我觉得太麻烦了,每次创建一个bean都要创建一个类对象
1、配置类
@Configuration
------>Spring配置文件
2、使用
@Bean
给容器中添加组件
/**
* @Configuration:指明当前类是一个配置类;就是来替代之前的Spring配置文件
* 在配置文件中用<bean><bean/>标签添加组件
@Configuration
public class MyAppConfig {
//将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
@Bean
public HelloService helloService02(){
System.out.println("配置类@Bean给容器中添加组件了...");
return new HelloService();
⑤、配置文件占位符
⑤、配置文件占位符
1、随机数
${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}
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.maps这个值,后面person.dog.name想用一下前面的值
person.dog.name=${person.maps:hello}_dog
person.dog.age=15
四、Profile
四、Profile
是springboot用来做多环境支持的,开发环境、测试环境、运行环境
①、多Profile文件
①、多Profile文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用application.properties的配置;
②、yml支持多文档块方式
②、yml支持多文档块方式
server:
port: 8081
spring:
profiles:
active: prod
---//三个横线+回车
server:
port: 8083
spring:
profiles: dev
server:
port: 8084
spring:
profiles: prod #指定属于哪个环境
③、激活指定profile
③、激活指定profile
1、在application.properties配置文件中指定 spring.profiles.active=dev
2、命令行:
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev;
可以直接在测试的时候,配置传入命令行参数
3、虚拟机参数;
-Dspring.profiles.active=dev
五、配置文件加载位置或顺序
五、配置文件加载位置或顺序
springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
–file:./config/
–file:./
–classpath:/config/
–classpath:/
入图上所展示,优先级由高到底,高优先级的配置会覆盖低优先级的配置;
SpringBoot会从这四个位置全部加载主配置文件;
互补配置
;
==我们还可以通过spring.config.location来改变默认的配置文件位置==
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;
先输入 cd target
在输出dir
输入:java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar
--spring.config.location=F:/application.properties(里面是湍口号内容)也可以运行项目
六、外部配置加载顺序
六、外部配置加载顺序
==SpringBoot也可以从以下位置加载配置;优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置==
1.命令行参数
所有的配置都可以在命令行上进行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.port=8087
--server.context-path=/abc //访问项目名称,但是需要修改多个配置的时候这么写的话?显得很累赘
可以专门写一个外部配置文件
多个配置用空格分开;--配置项=值
2.来自java:comp/env的JNDI属性
3.Java系统属性(System.getProperties())
4.操作系统环境变量
5.RandomValuePropertySource配置的random.*属性值
==
由jar包外向jar包内进行寻找;
==
==
优先加载带profile
==
优先加载,外部jar包旁边的配置文件
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指定的默认属性
所有支持的配置加载来源;
七、自动配置原理
七、自动配置原理
配置文件到底能写什么?怎么写?自动配置原理;
配置文件能配置的属性参照
1、
自动配置原理:
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的值加入到了容器中;==
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");
精髓:
springboot里面的HttpEncodingProperties会自动配置好很多注组件
1)、SpringBoot启动会加载大量的自动配置类
2)、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;
3)、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)
4)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值;
xxxxAutoConfigurartion:自动配置类;
给容器中添加组件
xxxxProperties:封装配置文件中相关属性;
2、细节
2、细节
1、@Conditional派生注解(Spring注解版原生的@Conditional作用)
1、@Conditional派生注解(Spring注解版原生的@Conditional作用)
作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;
自动配置类必须在一定的条件下才能生效;
我们怎么知道哪些自动配置类生效;
==我们可以通过启用 在全局配置文件aplication.properties中开启 debug=true属性;来让控制台打印自动配置报告==
,这样我们就可以很方便的知道哪些自动配置类生效;
#开启Springboot中的debug
debug=true
#配置端口号
server.port=8089
#我们能配置那些都是来源于properties类
spring.http.encoding.enabled=true
spring.http.encoding.charset=utf-8
spring.http.encoding.force=true
=========================
AUTO-CONFIGURATION REPORT
=========================
Positive matches:(自动配置类启用的)
-----------------
DispatcherServletAutoConfiguration matched:
- @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
- @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)
Negative matches:(没有启动,没有匹配成功的自动配置类)
-----------------
ActiveMQAutoConfiguration: