SpringBoot配置文件注意事项梳理

Spring Boot配置文件对Spring Boot来说就是入门和基础，经常会用到，所以写下做个总结以便日后查看。

1、配置文件

当我们构建完Spring Boot项目后，会在resources目录下给我们一个默认的全局配置文件 application.properties，这是一个空文件，因为Spring Boot在底层已经把配置都给我们自动配置好了，当在配置文件进行配置时，会修改SpringBoot自动配置的默认值。

配置文件名是固定的

application.properties

但我们可以修改为

application.yml

这两个文件本质是一样的，区别只是其中的语法略微不同。

2、值的写法

application.properties 配置文件比较简单，形式如下

key = value

application.yml 配置文件使用YMAL语言，YMAL不是如XML般的标记语言，更适合作为配置文件。

下面说下对于不同类型（字符串、数组）如何去规范书写。

2.1 数字，字符串，布尔

1、直接写

name=zhangsan

2、双引号

不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思

name: "zhangsan n lisi"

输出：
zhangsan
lisi

3、单引号

会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: ‘zhangsan n lisi’

输出：

zhangsan n lisi

2.2 对象、Map（属性和值）（键值对）

例如配置类中的字段为

Map<String,String> maps;

在yml配置文件中，行内写法

person.maps: {key1: value1,key2: value2}

需要注意:号后的空格，或者

person:
  maps:
   key: value

在properties配置文件中

person.maps.key=value

2.3 数组（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提供自定义配置组件，拿前面举例的属性来写一个规范的配置文件

@Component // 或者@Configuration
@ConfigurationProperties(prefix = "person")
public class Person {
 private Map<String,String> maps;
 private List<String> list;
 private String name;

 public Map<String, String> getMaps() {
 return maps;
 }

 public void setMaps(Map<String, String> 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;
 }
}

@ConfigurationProperties 注解向Spring Boot声明该类中的所有属性和配置文件中相关的配置进行绑定。

• prefix = “person”：声明配置前戳，将该前戳下的所有属性进行映射。

@Component 或者@Configuration：将该组件加入Spring Boot容器，只有这个组件是容器中的组件，配置才生效。

4、配置自动提示

在配置自定义属性时，如果想要获得和配置Spring Boot属性自动提示一样的功能，则需要加入下面的依赖：

<!--导入配置文件处理器，配置文件进行绑定就会有提示-->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>

若是依旧无法自动提示，可以尝试开启IDE的Annonation Processing

5、配置属性校验

自定义配置文件时，可以使用@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包下，具体用法查看注释即可了解。

6、自定义配置文件

除了在默认的application文件进行属性配置，我们也可以自定义配置文件，例如新建 peoson.properties ，配置内容如下

person.mail=[e-mail]

然后在配置类中使用@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”})

7、配置文件占位符

Spring Boot配置文件支持占位符，一些用法如下

7.1 随机数

${random.value}
${random.int}
${random.long}
${random.int(10)}
${random.int[1024,65536]}

7.2 默认值

占位符获取之前配置的值，如果没有可以是用:指定默认值

person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=200/12/17
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

本文地址：https://blog.csdn.net/storm_55/article/details/107597942