Spring Boot学习记录(三、配置文件)
1.配置文件
springboot使用一个全局的配置文件,配置文件名是固定的:
- application.properties
- application.yml
配置文件作用:修改springboot自动配置的默认值;springboot在底层将所有东西都配置好;
(ps:yml是YAML(YAML Ain't Markup Language)语言的文件,以数据为中心,比json、xml更适合做配置文件;)
配置文件放在src/main/resources目录或类路径/config下
全局配置文件的可以对一些默认配置
YAML配置例子:
server:
port: 8081
person:
name: 张三
age: 18
birth: 2016/7/14
dog:
name: dog
age:4
properties配置例子:
server.port=8081
person.name=张三 person.age=18 person.birth=2016/7/14 person.dog.name=dog person.dog.age=4
(ps:如果properties测试获取值时出现中文乱码,settings->Editor->file Encodings:default encoding for properties files选择utf-8,并勾选Transparent native-to-ascii conversion)
2.配置文件值注入
1.在类上注解:
为javabean类添加如下注解,其中xxx为yml下所对应:
@Component
@ConfigurationProperties(prefix = "xxx")
@Component:将javabean类注入容器中
2.在每个属性上注解:
类依然需要@Component注解,在属性上添加如下注解,没有注解的默认为null:
@Value(“”)
其中“”内可以是字面量;${key}从环境变量、配置文件中获取值;#{SpEL}
对应的例子:true;${person.name};#{11*2}
properties和yml都能获取到值。
@ConfigurationProperties |
@Value |
|
功能 | 批量注入文件属性 | 一个个指定 |
松散绑定(松散语法) | 支持 | 不支持 |
SpEL | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
(ps:松散绑定举例:a-c,a_c,aC,在properties或yml中是一样的)
(ps:JSR303数据校验举例:类前添加@Validated注解,在属性前添加@Email注释,则该属性必须符合email格式)
何时选择@ConfigurationProperties或@Value?
只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;
专门编写了一个javabean与配置文件进行映射,就直接使用@ConfigurationProperties.
ps:我们可以导入配置文件处理器,以后编写配置就有提示了,
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
3.@PropertySource&@ImportResource
@PropertySource:加载指定的配置文件;
@ConfigurationProperties默认从全局配置文件中获取值;
例:
1.新建配置文件person.properties
2.javabean类前添加如下注释:
@PropertySource(value={“classpath:person.properties”})
@ImportResource:导入spring的配置文件,让配置文件里面的内容生效;
springboot里面没有spring的配置文件,我们自己填写的配置文件,也不能自动识别;
想让spring的配置文件生效,加载进来;@ImportResource标注在一个配置类(例运行程序的类)上;
@ImportResource(location={“classpath:beans.xml”})
springboot推荐给容器中添加组件的方式,推荐使用全注解的方式;
1.配置类=======spring配置文件
2.使用@Bean给容器中添加组件
package com.ssx.deliveryorders.config; import com.ssx.deliveryorders.service.HelloService; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * Configuration指明当前类是一个配置类;就是替代之前的配置文件 * 在配置文件中使用<bean></bean>标签添加组件 */ @Configuration public class MyappConfig { /*将方法的返回值添加到容器中,容器中这个组件默认的id就是方法名*/ @Bean public HelloService helloService(){ System.out.println("配置类@Bean给容器添加组件了"); return new HelloService(); } }
4.配置文件占位符
RandomValuePropertySource:配置文件中可以使用随机数
${random.value};${random.int};${random.long};${random.int(10)};${random.int[1024,65536]}
属性配置占位符
可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用);
${app.name=默认值}来指定找不到属性时的默认值
5.Profile
1.多profile文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用application.properties
2.yml支持多文档块方式
用 --- 来分割yml文件为多个文档块
例:
server: port: 8081 spring: profiles: active:dev --- server: port: 8082 spring: profiles: dev #指定属于哪个环境
3.激活指定profile
1.创建新文件application-dev.properties 在配置文件中指定 spring.profiles.active=dev
2.命令行:
java -jar xxx.jar --spring.profiles.active=dev
可以直接在测试的时候,配置传入命令行参数
3.虚拟机参数:
-Dspring.profiles.active=dev
6.配置文件加载位置
springboot扫描以下位置的application.properties或者application.yml文件作为springboot默认文件
- file:./config/
- file:./
- classpath:/config/
- classpath:/
以上按优先级从高到低顺序排列,所有位置文件都被加载,高优先级覆盖低优先级。