文章目录
SpringBoot配置文件
概述
SpringBoot的配置文件是全局的,当我们创建一个SpringBoot项目时,默认会在resources目录下生成一个application.properties文件。
配置文件的名称是默认是[application]的,也可以为其他名字,但是这样你就要让spring知道这是你的配置文件
- application.properties
- application.yml
虽然默认生成properties文件,但是两种文件格式都支持。
可以有多个配置文件,配置文件可以放置的地方有四个,优先级降低依次
-
当前项目根目录 下的 config 目录下【1】
-
当前项目的根目录下【2】
-
resources 目录下的 config 目录下【3】
-
resources 目录下【4】
【注意】:
-
创建SpringBoot项目时,自动生成的配置文件,默认在resources目录下
-
默认同一目录下,先读取application.properties
-
如果多个配置文件配置了同一个属性,默认使用第一个读取到的
一般情况下,我们用配置文件来修改SpringBoot自动配置好的一些属性值
编写配置文件
个人觉得YAML比properties更好用一些,看起来也比较明了。所以下面就只说YAML如何编写。
YAML概述
YAML是YAML Ain’t Markup Language【YAML不是一种标记语言】的缩写,但为了强调这种语言以数据做为中心,而不是以置标语言为重点,而用返璞词重新命名。它是一种直观的能够被电脑识别的数据序列化格式,是一个可读性高并且容易被人类阅读,容易和脚本语言交互,用来表达资料序列的编程语言。
它是类似于标准通用标记语言的子集XML的数据描述语言语法比XML简单很多。
--------百度百科
对比一下yaml和xml:
//yaml 注意空格
server:
port: 8087
//xml
<server>
<port>8087<port>
</server>
YAML基础语法
【注意】
- YAML大小写敏感
- yaml以空格的缩进来控制层级关系。
- 只能用空格,不能用 Tab,不要求空格个数,但同一级要左对齐在一列上
- “#” 表示注释
- 字符串 可以不用加引号
<1.常量值:
key:(我是空格)value
number: 1.777
isReal: true
name1: 巴西龟
name2: '巴西龟\n可爱'
#单引号会转义换行符---取出来是:巴西龟\n可爱
name3:"巴西龟\n可爱"
#双引号,换行符会换行
<2.对象
user:
name: a
age: 27
sex: 女
流式语法(行内写法):
user: {
name: a,age: 27,sex: 女}
< 3.数组
短横线+空格
hobby:
- draw
- song
- book
float:
- 3.14
- 5.77
流式语法(行内写法):
hobby: [draw,song,book]
float: [3.14,5.77]
代码实例
<1.pom.xml导入所需依赖
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<2.编写yml配置文件
server:
port: 8083
person:
name: 夏风
gender: girl
hobby:
- sing
- draw
- read
birth: 2019/07/07
pet:
type: dog
name: summer
< 3.编写实体类(记得pojo包放在主程序的 同级目录下)
package com.sehun.springboot.pojo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
import java.util.Arrays;
import java.util.Date;
/*
@ConfigurationProperties:
将配置文件中配置的每一个属性的值,映射到这个组件中;
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
*/
//注册bean
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private String gender;
private String[] hobby;
private Date birth;
private Pet pet;
//此处省略了get/set以及toString()方法,记得写
}
/*
除了使用@ConfigurationProperties,还可以使用@Value来关联配置文件
@Component //注册bean
public class User {
@Value("${person.name}")
private String name;
@Value("girl")
private String gender;
......
}
*/
package com.sehun.springboot.pojo;
public class Pet {
private String type;
private String name;
//此处省略了get/set以及toString()方法,记得写
}
<4.编写测试类
package com.sehun.springboot;
import com.sehun.springboot.pojo.Person;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootPropertiesApplicationTests {
@Autowired
Person person = new Person();
@Test
public void contextLoads() {
System.out.println(person);
}
}
<5.运行结果
扩展
1.加载指定配置文件
@configurationProperties
默认从全局配置文件中获取值
@PropertySource
可以用来加载指定配置文件
假设你在resources目录下又写了一个配置文件,another.properties,你要在你的实体类上加载它:
@Component
@PropertySource(value = "classpath:another.prop