Spring Boot 使用一个全局配置文件,配置文件名是固定的,application.properties或者application.yml
配置文件的作用:修改Spring Boot 自动配置的默认值(Spring Boot 在底层给我们配置好的参数)
一、YAML语言介绍
YAML:(YAML Ain’t Markup Language)
YAML A Markup Language:是一个标记语言
YAML isn’t Markup Language:不是一个标记语言
标记语言
以前的配置文件:大多都使用的是XXX.xml文件;
<server>
<port>8081</port>
</server>
YAML:以数据为中心,比json, xml等更适合做配置文件;
server:
port: 8082
二、YAML语法
- 基本语法
k:(空格)v:表示一对键值对,冒号后面必须有空格;
以空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的;
并且属性和值都对大小写敏感。
server:
port: 8081
path: /hello
- 不同类型值的写法
1)字面量:普通的值(数字,字符串,布尔)
k: v:字面值直接写;
字符串默认不加上单引号和双引号;
双引号:不会转义字符串里面的特殊字符,特殊字符会作为本身想要表达的意思输出。
例如:name:“zhangsan \n lisi”,输出:zhangsan 换行 lisi
单引号:会转义特殊字符,特殊字符最终只是一个普通的字符串数据。
例如:name:‘zhangsan \n lisi’,输出:zhangsan \n lisi
(弹幕有争议,说反了,待验证)
2)对象,Map(属性和值)(键值对)
k: v:在下一行来写对象的属性和值的关系;注意缩进
对象还是 k: v的方式
friends:
name: zhangsan
age: 20
行内写法:
friends: {name: zhangsan,age: 20}
3)数组(List, set)
用 - 表述数组中的一个元素
pets:
- cat
- dog
- pig
行内写法
pets: [cat,dog,pig]
三、测试
- 快速创建一个spring boot工程,在src\main\resources目录下新建配置文件application.yml
- 创建javaBean
package cn.springboottest.springboot.bean;
public class Dog {
private String name;
private Integer age;
//快捷键:alt + insert
@Override
public String toString() {
return "Dog{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
}
package cn.springboottest.springboot.bean;
import java.util.Date;
import java.util.List;
import java.util.Map;
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String, Object> maps;
private List<Object> lists;
private Dog dog;
@Override
public String toString() {
return "Person{" +
"lastName='" + lastName + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Boolean getBoss() {
return boss;
}
public void setBoss(Boolean boss) {
this.boss = boss;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public Map<String, Object> getMaps() {
return maps;
}
public void setMaps(Map<String, Object> maps) {
this.maps = maps;
}
public List<Object> getLists() {
return lists;
}
public void setLists(List<Object> lists) {
this.lists = lists;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
}
- 编写application.yml中的内容
person:
lastname: 张三
age: 18
boss: false
birth: 2019/01/01
maps: {k1: v1,k2: v2}
lists: [lst1,lst2,lst3]
dog:
name: 小狗
age: 2
- 将配置文件中的配置的属性映射到Person这个组件中,在类中增加配置@ConfigurationProperties(@ConfigurationProperties:告诉Spring Boot将本类中的所有属性和配置文件中相关的配置进行绑定);prefix = “person”:将配置文件中person属性值和本类中的属性一一映射;只有这个组件为容器中的组件,才能使用容器提供的@ConfigurationProperties功能;@ConfigurationProperties(prefix = “person”)默认从全局配置文件中获取值。
1)添加@ConfigurationProperties,会提示:Spring Boot Configuration Annotation Processor not found in classpath
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
添加完成之后,依然提示:Not registered via @EnableConfigurationProperties or marked as Spring component,意思是这个类不是容器中的组件,不能使用@EnableConfigurationProperties这个功能,所以我们在类上添加@Component标记使此类成为容器中的组件。
以下是添加完注释的最终样子
package cn.springboottest.springboot.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 将配置文件中配置的每一个属性值,映射到这个组件中
* @ConfigurationProperties: 告诉Spring Boot将本类中的所有属性和配置文件中相关的配置进行绑定
* prefix ="person":配置文件中哪个下面的所有属性进行一一映射
*
* 只有这个组件是容器中的组件,才能使用容器提供的@ConfigurationProperties功能
*
* @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值;
*
*
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String, Object> maps;
private List<Object> lists;
private Dog dog;
@Override
public String toString() {
return "Person{" +
"lastName='" + lastName + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Boolean getBoss() {
return boss;
}
public void setBoss(Boolean boss) {
this.boss = boss;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public Map<String, Object> getMaps() {
return maps;
}
public void setMaps(Map<String, Object> maps) {
this.maps = maps;
}
public List<Object> getLists() {
return lists;
}
public void setLists(List<Object> lists) {
this.lists = lists;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
}
- 编写测试类
package cn.springboottest.springboot;
import cn.springboottest.springboot.bean.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;
/**
* Spring Boot单元测试
* 可以在测试期间很方便的类似编码一样进行自动注入等容器的功能
*/
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot02Config01ApplicationTests {
@Autowired
Person person;
@Test
public void contextLoads() {
System.out.println(person);
}
}
运行测试类,查看控制台输出