SpringBoot 使用的是一个全局的配置文件,就是application.properties配置文件,这个文件的路径放在src/main/resources/目录下面或者放在类路径下面,并且这个文件名是固定的。 IDEA工具默认创建的时候创建到对应的第一个目录下面。既然是全局的配置文件,那么就可以对全局的默认配置进行修改。 在实际开发中我们用的更多的是yml后缀的配置文件。
关于这个配置文件有两种格式
- application.properties
- application.yml
yaml与yml后缀都可以
从之前的xml文件的配置中可以知道使用XML方式配置数据,会将大多的信息浪费在了标签的开闭上,真正有用的数据很少,这个也是xml和json格式的数据两者在数据传输领域的差别。 而springboot除了兼容properties为后缀的配置文件类型外,还有另外一个方式yaml,它非常适合用来做以数据为中心的配置文件。接下来我们就来介绍一下它。
1、yml文件类型
1.1、基本语法
yml后缀的配置文件基本的语法规则有如下几点
-
key: value;kv之间有空格
-
大小写敏感
-
使用缩进表示层级关系
-
缩进不允许使用tab,只允许空格(实际用idea开发的时候也可以放心用)
-
缩进的空格数不重要,只要相同层级的元素左对齐即可
-
'#'表示注释
-
字符串无需加引号,如果要加,’'与""表示字符串内容 会被 转义/不转义
1.2、数据类型
- 字面量:单个的、不可再分的值。date、boolean、string、number、null
k: v #变量名叫k,值是v
- 对象:键值对的集合。map、hash、set、object
#有两种写法:下面两种方式都表示有一个变量k,它有k1,k2,k3这三个属性,属性值分别是v1,v2,v3
在一行内写法:
k: {k1:v1,k2:v2,k3:v3}
#或着:
k:
k1: v1
k2: v2
k3: v3
- 数组:一组按次序排列的值。array、list、queue
也有两种写法,都表示数组有三个值:v1,v2,v3
行内写法: k: [v1,v2,v3]
#或者
k:
- v1
- v2
- v3
1.3、示例
创建一个Person类以及Pet类
import lombok.Data;
import lombok.ToString;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;
@ToString
@Data
public class Person {
private String userName;
private Boolean boss;
private Date birth;
private Integer age;
private Pet pet;
private String[] interests;
private List<String> animal;
private Map<String, Object> score;
private Set<Double> salarys;
private Map<String, List<Pet>> allPets;
}
-------------------------------------------------------------------------------
@ToString
@Data
public class Pet {
private String name;
private Double weight;
}
先给Person类加上@Component注解加入容器中,然后再给Person类加上@ConfigurationProperties注解使其与配置文件绑定。prefix表示与配置文件中的哪个前缀绑定
resource目录下创建一个application.yml文件
(在springboot中,application.properties与application.yml文件同时存在也可以,两个文件的配置都会生效)
application.yml文件内容:(注意缩进)
# yaml表示以上对象
person:
userName: zhangsan
boss: false
birth: 2019/12/12 20:12:33
age: 18
pet:
name: tomcat
weight: 23.4
interests: [篮球,游泳]
animal:
- jerry
- mario
score:
english:
first: 30
second: 40
third: 50
math: [131,140,148]
chinese: {first: 128,second: 136}
salarys: [3999,4999.98,5999.99]
allPets:
sick:
- {name: tom}
- {name: jerry,weight: 47}
health: [{name: mario,weight: 47}]
在主程序中获取person对象进行测试
public static void main(String[] args) {
ConfigurableApplicationContext run = SpringApplication.run(HelloBootApplication.class, args);
Person person = (Person) run.getBean("person");
System.out.println(person);
}
2、配置提示
自定义的类和配置文件绑定一般没有提示,如果想要提示,可以加入如下依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
因为这只是我们开发的一个小提示,虽然打包的时候把它也打包了对功能上没什么影响,但是总会影响性能。故我们建议在打包的时候不要将其也打包进去,若不想打包进去,只需要加入如下内容进pom文件即可
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>