spring boot项目中常用的配置文件格式为 key:value,这里记录一下被面试问到的map和list配置文件是如何配置的。
一、具体步骤
1、对象、Map(属性和值)(键值对)
例如配置类中的字段为
Map<String,Object> maps;
在yml
配置文件中,行内写法
person.maps: {key1: value1,key2: value2}
需要注意:号后的空格,或者
person:
maps:
key: value
在properties
配置文件中
person.maps.key=value
2、数组(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属性自动提示一样的功能,则需要加入下面的依赖:
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
4、自定义配置属性
Spring Boot提供自定义配置组件,拿前面举例的属性来写一个规范的配置文件
@Component // 或者@Configuration
@ConfigurationProperties(prefix = "person")
public class Person
{
private Map<String,Object> maps;
private List<String> list;
private String name;
private int age;
public Map<String, Object> getMaps()
{
return maps;
}
public void setMaps(Map<String, Object> maps)
{
this.maps = maps;
}
public List<String> getList()
{
return list;
}
public void setList(List<String> list)
{
this.list = list;
}
public String getName()
{
return name;
}
public void setName(String name)
{
this.name = name;
}
public int getAge()
{
return age;
}
public void setAge(int age)
{
this.age = age;
}
}
@ConfigurationProperties
注解向Spring Boot
声明该类中的所有属性和配置文件中相关的配置进行绑定。
prefix = "person"
:声明配置前戳,将该前戳下的所有属性进行映射。@Component
或者@Configuration
:将该组件加入Spring Boot
容器,只有这个组件是容器中的组件,配置才生效。
二、Spring boot配置文件扩展
1、配置属性校验
自定义配置文件时,可以使用@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字段的注入值进行检验,如果注入的不是一个合法的邮件地址则会抛出异常。
其它常见注解:
@AssertFalse 校验false
@AssertTrue 校验true
@DecimalMax(value=,inclusive=) 小于等于value,inclusive=true,是小于等于
@DecimalMin(value=,inclusive=) 与上类似
@Max(value=) 小于等于value
@Min(value=) 大于等于value
@NotNull 检查Null
@Past 检查日期
@Pattern(regex=,flag=) 正则
@Size(min=, max=) 字符串,集合,map限制大小
@Validate 对po实体类进行校验
上述的这些注解位于javax.validation.constraints
包下,具体用法查看注释即可了解。
2、自定义配置文件
除了在默认的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"})
3、配置文件占位符
Spring Boot配置文件支持占位符,一些用法如下
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.dog.name=${person.hello:hello}_dog
person.dog.age=15
4、多配置文件
1 多Profile文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用application.properties
的配置
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 #指定属于哪个环境
3 激活指定profile
无论是使用上述多文档块的方式,还是新建application-dev.yml
文件,都可以在配置文件中指定spring.profiles.active=dev
激活指定的profile
,或者
1、使用命令行:
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
可以直接在测试的时候,配置传入命令行参数
2、虚拟机参数:
-Dspring.profiles.active=dev