1、配置文件
SpringBoot使用一个全局的配置文件,配置文件名是固定的;
- application.properties
- application.yml
配置文件的作用 : 修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;
YAML(YAML Ain’t Markup language)
YAML A Markup Language : 是一个标记语言
YAML isn’t Markup Language : 不是一个标记语言
标记语言:
以前的配置文件;大多都使用的是 xxx.xml文件;
YAML : 以数据为中心,比json、xml等更适合做配置文件;
YAML : 配置例子
server:
port:8081
XML:
<server>
<port>8081</port>
</server>
2、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
行内写法
pets: [cat,dog,pig]
3、配置文件值注入
配置文件
person:
lastName: zhangsan
age: 18
boss: false
birth: 2019.2.21
maps: {k1: v1,k2: l2}
lists:
- lisi
- wangwu
- zhaoliu
dog:
name: xiaogou
age: 2
javaBean
/**
* 将配置文件中配置的每一个属性的值,映射到这个组件中
*@ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置和配置文件中相关的配置进行绑定
* 只有这个是容器中的组件,才能使用容器提供的功能:@ConfigurationProperties功能
*/
@Component
@ConfigurationProperties(prefix = "person")
public class person {
private String lastName;
private Integer age;
private Boolean boss;
private String birth;
private Map<String,Object> map;
private List<Object> lists;
private Dog dog;
我们可以导入配置文件处理器,以后编写配置就有提示了
<!--配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
1、@Value获取值和@ConfigurationProperties获取值比较
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个个指定 |
SpEL | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
配置文件yml还是properties他们都能获取到值;
如果说,我们只是在某个业务逻辑中获取一下配置文件中的某项值,使用@Value;
如果说,我们专门编写一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties ;
2、@PropertySource&@ImportResource
@PropertySource: 加载指定的配置文件;
/**
* 将配置文件中配置的每一个属性的值,映射到这个组件中
*@ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置和配置文件中相关的配置进行绑定
* 只有这个是容器中的组件,才能使用容器提供的功能:@ConfigurationProperties功能
*/
@Component
@ConfigurationProperties(prefix = "person")
@PropertySource(value = {"classpath:person.properties"})
public class person {
private String lastName;
private Integer age;
private Boolean boss;
private String birth;
private Map<String,Object> map;
private List<Object> lists;
private Dog dog;
@ImportResource : 导入Spring的配置文件,让配置文件里面的内容生效;
Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;
想让Spring的配置文件生效,加载进来;@ImportResource标注一个配置类上
@ImportResource(location = {"classpath:beans.xml"})
导入Spring的配置文件让其生效
SpringBoot推荐容器中添加组件的方式;推荐使用注解的方式
1、配置类====Spring配置文件
2、使用@Bean给容器中添加组件
/**
* @Configuration : 指明当前类是一个配置类 ;就是来替代之前的Spring配置文件
*
* 在配置文件中用<bean></bean>标签添加组件
*/
@Configuration
public class MyAppConfig(){
//将方法的返回值添加到容器中;容器中的这个组件默认的id就是方法名
@Bean
pubilc HelloService helloServoce(){
System.out.println("配置类@Bean给容器中添加组件了...");
return new HelloService();
}
}
4、配置文件占位符
1、随机数
${random.value},${random.int},${random.long}
${random.int(10)},${random.int[1024,65536]}
2、占位符获取之前配置的值,如果没有可以说用:指定默认值
person.last-name=张三${random.int}
person.dog.name=${person.hello:hello}_dog
5、Profile
1、多Profile文件
我们在主配置文件编写的时候,文件名可以是 application-[profile].properties/yml
默认使用application.properties的配置;
2、yml支持多文档块方式
server:
port: 8081
spring:
profiles: dev
---
server:
port: 8083
spring:
profiles: dev
---
server:
port: 8084
spring:
profiles: prod
3、激活指定profile
1、在配置文件中指定 spring. profiles.active=dev
2、命令行:
java -jar spring-boot.jar- -spring.profiles.active=dev
可以直接在测试的时候,配置传入命令行参数
3、虚拟机参数
-Dspring.profiles.active=dev
6、配置文件加载位置
springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring Boot的默认配置文件
-file:./config/
-file:./
-classpath:/config/
-classpath:/
优先级由高到底,高优先的配置会覆盖低优先级的配置;
SpringBoot会从这四个位置全部加载主配置文件;互不配置;
我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;
7、外部配置加载顺序
SpringBoot也可以从以下位置加载配置 : 优先级从高到低 ; 高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置
1、命令行参数
java -jar spring-boot-config-SNAPSHOT.jar - -server.port=8087 - -server.context.path=/abc
多个配置用空格分开 ; - - 配置项=值
2、来着java:comp/env的NDI属性
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.setDefaulitProperties指定的默认属性
8、自动配置原理
自动配置原理:
1、SpringBoot启动的时候加载主配置类,开启了自动配置功能==@EnableAutoConfiguration==
2、@EnableAutoConfiguration作用:
-
利用EnableAutoConfigurationImportSelector给容器中导入一些组件
-
可以插件selectImports()方法的内容:
-
List<String> configuration = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
SpringFactoriesLoader.loadFactoryNames() 扫描所有jar包类路径下 META-INF/spring.factories 把扫描到的这些文件的内容包装成properties对象 从properties中获取到EnableAutoConfiguration.class类(类名)对应的值,然后把他们添加在容器中
将类路径下 META-INF/spring-factories里面配置的所有EnableAutoConfiguration的值添加到容器中;
每一个这样的 xxxAutoConfiguration 类都是容器中的一个组件,都加入到容器中; 用他们来做自动配置;
3、每一个自动配置类进行自动配置功能;
4、以HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理;
@Configuration//表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
@EnableConfigurationProperties(HttpEncodingProperties.class)//启动指定类的 ConfigurationProperties功能:将配置文件中对应的值和HttpEncodingProperties绑定起来;并把HttpEncodingAutoConfiguration加入到Ioc容器中
@ConditionOnWebApplication//Spring就是@Conditional注解,根据不同的条件,如果是当前配置类生效;
@ConditionalOnClass(CharacterEncodingFilter.class)//判断当前项目有没有这个类 CharacterEncodingFilter:SpringMVC中进行乱码解决的过滤器;
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)//判断配置文件是否存在某个配置 spring.http.encoding.enabled;如果不存在 判断也是成立的
//即使我们配置文件中不配置 spring.http.encoding.enabled = true ,默认也生效的;
public class HttpEncodingAutoConfiguration{
//他已经和SpringBoot的配置文件映射了
private final HttpEncodingProperties properties;
//只有一个有参构造器的情况下,参数的值就会从容器中拿
public HttpEncodingAutoConfiguration(HttpEncodingProperties properties){
this.properties = properties;
}
@Bean
@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")
public class HttpEncodingProperties{
public static final Charset DEFAUL_T = Charset.forName("UTF-8");
精髓:
1、SpringBoot启动会加载大量的自动配置类;
2、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;
3、我们再来看这个自动配置类中到底配置了哪些组件;
4、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值;
xxxxAutoConfiguration : 自动配置类 ;
给容器中添加组件
xxxxProperties : 封装配置文件中相关属性;