Sprint Boot 配置
配置文件、加载顺序、配置原理
1.配置文件
- SpringBoot使用一个全局的配置文件
- application.properties
- application.yml
- 配置文件放在src/main/resources目录或者类路径/config下
- .yml是yaml(yaml ain’t markup language)语言的文件,以数据为中心,比json、xml更适合做配置文件
- 全局配置文件的可以对一些默认配置值进行修改
yaml:8081配置
server:
port : 8081
<server>
<port>8081</port>
</server>
2.YAML 语法
1.基本语法
k:(空格)v:表示一对键值对(空格必须要有)
以空格的缩进来控制层级关系;只要左对齐的一列数据,都是同一个层级的
server:
port: 8081
path: /hello
属性和值也是大小敏感的;
2.值的写法
字面量:普通的值(数字、字符串、布尔):
k: v字面直接来写;
字符串默认不用加上单引号或者双引号
双引号:不会转义字符串里面的特殊字符;特殊字符串会作为本身想表达的意思
name: “Zhongshan \n lisi” 输出: zhangshan 换行lisi
单引号:会转义特殊字符,特殊字符最终只是一个普通的字符串数据
对象(属性和值)(键值对):
k: v 在一行来写对象的属性和值的关系;注意锁紧
对象还是k: v的方式
friends:
lastName: zhangshan
age: 20
行内写法:
friends: {lastName: zhangshan,age: 18}
数组(List、Set):
用- 值表示数组中的一个元素
pets:
- cat
- dog
- pig
行内写法:
pets: [cat,dog,pig]
3.配置文件注入
1.@ConfigurationProperties获取值和@Value获取值比较
配置文件
person:
lastName: zhangshan
age: 18
boss: false
birth: 2020/7/12
maps: {k1: v1,k2: 12}
lists:
- lisi
- zhaoliu
dog:
name: 小狗
age: 2
也可以用properties来配置,如果有汉字需要在file encoding设置运行时utf-8转ascii
person.last-name=张三
person.age=18
person.birth=2020/7/12
person.boss=false
person.lists=a,b,c
person.maps.k1=v4
person.maps.k2=14
person.dog.name=dog
person.dog.age=15
Javabean:
/**
* /将配置文件中配置的每一个属性的值,映射到这个组件中,
* @ConfigurationProperties:告诉springboot将本类中的所有属性和配置文件中相关的配置进行绑定
* prefix = "person":配置文件中哪个下面的所有属性进行一一映射
*
* 只有这个组件是容器中的组件,才能容器
*
*/
@Component
@ConfigurationProperties(prefix = "person")
@Data //自动生成setter() getter()等等方法
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;
}
我们可以导入配置文件处理器,以后编写配置就有提示
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-configuration-processor -->
<!-- 导入配置文件处理器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
采用@value注入
@Component
@ConfigurationProperties(prefix = "person")
@Data //自动生成setter() getter()等等方法
public class Person {
// @Value("${person.last-name}")
private String lastName;
// @Value("#{11*2}")
private Integer age;
// @Value("true")
private Boolean boss;
private Date birth;
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个个指定 |
松散绑定 | 支持 | 不支持 |
SpEL | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
配置文件yml还是properties他们都能获取到值;
如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,用@Value
如果说,我们专门编写了一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties;
2.注入校验
注入校验
@Validated
@Email等等
3. @PropertySource&@ImportResource
@PropertySource:加载指定的配置文件;
@Component
@PropertySource(value = {"classpath:person.properties"})
@ConfigurationProperties(prefix = "person")
@Data //自动生成setter() getter()等等方法
public class Person {
// @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;
}
@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效;
@ImportResource(locations={"classpath:beans.xml"})
这个方式太麻烦,过去Spring的方式
同时这里补一个方法的注释生成的:
**
- @Author: ZBZ
- @Description:
- @Date:
d
a
t
e
date
date
p a r a m s params params
r e t u r n return return
**/
params:groovyScript(“if(”KaTeX parse error: Can't use function '\"' in math mode at position 5: {_1}\̲"̲.length() == 2)…{_1}".replaceAll(’[\\[|\\]|\\s]’, ‘’).split(’,’).toList();for(i = 0; i < params.size(); i++) {if(i==0){result+=’* @Param ’ + params[i] + ‘: ‘}else{result+=’\n’ + ’ * @Param ’ + params[i] + ': '}}; return result;}", methodParameters());
return :groovyScript(“def returnType = “${_1}”; def result = '* @return: ’ + returnType; return result;”, methodReturnType());
生成: /*+Tab
SpringBoot推荐给容器中添加组件的方式:推荐使用全注解的方式
1、配置类===Spring配置文件
2、使用@Bean给容器中添加组件
/**
* @Configuration:指明当前类是一个配置类:就是来替代之前的srping配置文件
* 在配置文件中用<bean></>标签来添加组件
*/
@Configuration
public class MyAppConfig {
/**
* @Author: ZBZ
* @Description:
* @Date: 2020/7/12
* @return: com.crazys.springboot.service.HelloService
**/
// 将方法的返回值添加到容器中,容器中这个组件默认的id就是方法名
@Bean
public HelloService helloService(){
System.out.printf("配置类@bead给容器添加组件了");
return new HelloService();
}
}
4.配置文件占位符
1.随机数
random.value
random.int(10)
2.占位符获取之前配置的值,如果没有可以用冒号指定默认值
${random.}可以用随机数
${person.hello:hello}可以当占位符
5.Profile
1.多Profile文件
我们在主配置文件编写的时候,文件名是application-{profile}.properties/yml
默认使用application.properties的配置;
在配置文件中指定spring.profiles.active=dev
2.yml支持多文档块方式
server:
port: 8080
spring:
profiles:
active: dev---
server:
port: 8083
spring:
profiles: dev
---
server:
port: 8084
spring:
profiles: prod
3.激活指定profile
- 在配置文件中指定 spring.profiles.active-dev
- 命令行方式激活
可以在测试的时候加入–spring.profiles.active=dev
3.虚拟机参数
-Dspring.profiles.active=dev
6.配置文件加载位置
springboot启动会扫描以下位置的application.properties或者application.yml文件作为springboot的默认配置文件
- file:./config
- file:./
- classpath:/config/
- classpath:/
以上是按照优先级从高到低的顺序,所有位置的文件都会被加载,高优先级配置内容会覆盖低优先级配置内容
我们也可以通过配置spring.config.location来改变默认配置
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置,指定配置文件,不同的版本之间命令是可能不同的
7.外部配置加载顺序
官方文档列出了11个。。。 由高到低形成互补配置
1.命令行参数。 --server.port=8087 --server.context-path=/xxx
2.来自java:com/env的ndi 属性
3.Java系统属性
4.操作系统环境变量
5.RandomValuePropertySource配置的random.属性
优先加载带profile
6 ** .jar包外部的application-profile.properties/yml(带spring.profile)配置文件*
7.jar包内部
8.jar 包外部 不带
9.jar包内部 不带
10.@Configuration注释类上的@PropertySource
11.通过SpringApplication.setDefaultProperties指定的默认属性
所有支持的配置加载来源参考官方文档