SpringBoot配置文件详解

  本文主要详细介绍一下SpringBoot配置文件,SpringBoot是基于约定的,所以很多配置都有默认值,但如果想使用自己的配置替换默认配置的话,就可以使用application.properties或者application.yml(application.yaml)进行配置。
  SpringBoot默认会从Resources目录下加载application.properties或application.yml(application.yaml)文件。其中,application.properties文件是键值对类型的文件,之前一直在使用,所以此处不在对properties文件的格式进行阐述。除了properties文件外,SpringBoot还可以使用yml文件进行配置,下面对yml文件进行讲解。

1.yml配置文件简介

  YML文件格式是YAML (YAML Aint Markup Language)编写的文件格式,YAML是一种直观的能够被电脑识别的数据序列化格式,并且容易被人类阅读,容易和脚本语言交互的,可以被支持YAML库的不同的编程语言程序导入,比如: C/C++, Ruby, Python, Java, Perl, C#, PHP等。YML文件是以数据为核心的,比传统的xml方式更加简洁。
  YML文件的扩展名可以使用.yml或者.yaml。

2.yml配置文件的语法

2.1配置普通数据

  语法: key: value

1
name: zhangsan

  注意:value之前有一个空格

2.2配置对象数据

  语法:
  key:
  key1: value1
  key2: value2
  或者:
  key: {key1: value1,key2: value2}

1
2
3
4
5
6
7
8
person:
name: xiaohong
age: 18
addr: Beijing

#或者

person: {name: xiaohong,age: 18,addr: Beijing}

  注意:key1前面的空格个数不限定,在yml语法中,相同缩进代表同一个级别

2.3配置Map数据

  同上面的对象写法

2.4配置数组(List、Set)数据

  语法:
  key:
  - value1
  - value2
  或者:
  key: [value1,value2]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
city:
- Beijing
- tianjian
- shanghai

#或者

city: [Beijing,tianjian,shanghai]

#集合中的元素是对象形式
Student:
- name: zhangsan
age: 15
addr: beijing
- name: lisi
age: 16
addr: tianjian
- name: wangwu
age: 15
addr: shanghai

#或者

Student: [{name: zhangsan,age: 15,addr: Beijing},{name: lucy,age: 18,addr: shanghai}]

  注意:value1与之间的 - 之间存在一个空格

3.配置信息的查询

  上面提及过,SpringBoot的配置文件,主要的目的就是对配置信息进行修改的,但在配置时的key从哪里去查询
呢?我们可以查阅SpringBoot的官方文档
  文档URL:https://docs.spring.io/spring-boot/docs/2.0.1.RELEASE/reference/htmlsingle/#common-application-properties
  例如:
  application.properties文件

1
2
server.port=8888
server.servlet.context-path=demo

  application.yml文件

1
2
3
4
server:
port: 8888 #端口号
servlet:
context-path: /demo #项目名

4.配置文件与配置类的属性映射方式

4.1使用注解@Value映射

  application.yml配置如下:

1
2
3
person:
name: zhangsan
age: 18

  实体Bean代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@Controller
public class QuickStartController {

@Value("${person.name}")
private String name;
@Value("${person.age}")
private Integer age;


@RequestMapping("/quick")
@ResponseBody
public String quick(){
return "springboot 访问成功! name="+name+",age="+age;
}

}

4.2使用注解@ConfigurationProperties映射

  通过注解@ConfigurationProperties(prefix=”配置文件中的key的前缀”)可以将配置文件中的配置自动与实体进行映射
  实体Bean代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Controller
@ConfigurationProperties(prefix = "person")
public class QuickStartController {

private String name;
private Integer age;

@RequestMapping("/quick")
@ResponseBody
public String quick(){
return "springboot 访问成功! name="+name+",age="+age;
}

public void setName(String name) {
this.name = name;
}

public void setAge(Integer age) {
this.age = age;
}
}

  注意:使用@ConfigurationProperties方式可以进行配置文件与实体字段的自动映射,但需要字段必须提供set方法才可以,而使用@Value注解修饰的字段不需要提供set方法
  先写代码,在写配置文件,想要提示功能需要导入jar包

1
2
3
4
5
6
<!--@ConfigurationProperties的执行器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>