SpirngBoot回顾二:yml配置 - Alias的博客

SpirngBoot回顾二:yml配置

配置文件

SpringBoot使用一个全局的配置文件 , 配置文件名称是固定的

  • application.properties

    • 语法结构 :key=value
  • application.yml

    • 语法结构 :key:空格 value

配置文件的作用 :修改SpringBoot自动配置的默认值,因为SpringBoot在底层都给我们自动配置好了;

比如我们可以在配置文件中修改Tomcat 默认启动的端口号

1
server.port=8081

yaml概述

YAML是 “YAML Ain’t a Markup Language” (YAML不是一种标记语言)的递归缩写。在开发的这种语言时,YAML 的意思其实是:”Yet Another Markup Language”(仍是一种标记语言)

这种语言以数据作为中心,而不是以标记语言为重点!

以前的配置文件,大多数都是使用xml来配置;比如一个简单的端口配置,我们来对比下yaml和xml

传统xml配置:

1
2
3
<server>
<port>8081<port>
</server>

yaml配置:

1
2
server: 
port: 8080

yaml基础语法

说明:语法要求严格!

1、空格不能省略

2、以缩进来控制层级关系,只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

字面量:普通值 [ 数字,布尔值,字符串 ]

字面量直接写在后面就可以 , 字符串默认不用加上双引号或者单引号;

1
k: v

注意:

  • “ ” 双引号,不会转义字符串里面的特殊字符 , 特殊字符会作为本身想表示的意思;
  • ‘’ 单引号,会转义特殊字符 , 特殊字符最终会变成和普通字符一样输出

对象、Map(键值对)

1
#对象、Map格式k:     v1:    v2:

在下一行来写对象的属性和值得关系,注意缩进;比如:

1
2
3
student:
name: lisihan
age: 3

行内写法

1
student: {name: lisihan,age: 3}

数组( List、set )

用 - 值表示数组中的一个元素,比如:

1
pets: - cat - dog - pig

行内写法

1
pets: [cat,dog,pig]

修改SpringBoot的默认端口号

配置文件中添加,端口号的参数,就可以切换端口;

1
2
server:  
port: 8082

注入配置文件

yaml文件更强大的地方在于,他可以给我们的实体类直接注入匹配值

yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yml

2、编写一个实体类 Dog;

1
2
3
4
5
6
7
package com.lsh.springboot.pojo;
@Component //注册bean到容器中
public class Dog {
private String name;
private Integer age;
//有参无参构造、get、set方法、toString()方法
}

3、思考,我们原来是如何给bean注入属性值的!@Value,给狗狗类测试一下:

1
2
3
4
5
6
7
@Component //注册bean
public class Dog {
@Value("adas")
private String name;
@Value("18")
private Integer age;
}

4、在SpringBoot的测试类下注入狗输出一下;

1
2
3
4
5
6
7
8
9
10
11
12
@SpringBootTest
class DemoApplicationTests {

@Autowired //将狗自动注入进来
Dog dog;

@Test
public void contextLoads() {
System.out.println(dog); //打印看下狗狗对象
}

}

结果成功输出,@Value注入成功,这是我们原来的办法对吧。

5、我们在编写一个复杂一点的实体类:Person 类

1
2
3
4
5
6
7
8
9
10
11
12
@Component //注册bean到容器中
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;

//有参无参构造、get、set方法、toString()方法
}

6、我们来使用yaml配置的方式进行注入,大家写的时候注意区别和优势,我们编写一个yaml配置!

1
2
3
4
5
6
7
8
9
10
11
12
13
14
person:
name: lisihan
age: 3
happy: false
birth: 2018/01/01
maps: {k1: v1,k2: v2}
lists:
- code
- girl
- music
- game
dog:
name: gdhf
age: 1

7、我们刚才已经把person这个对象的所有值都写好了,我们现在来注入到我们的类中!

1
2
3
4
5
6
7
8
9
10
11
@Component //注册bean
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
}

8、IDEA 提示,springboot配置注解处理器没有找到,让我们看文档,我们可以查看文档,找到一个依赖!

1
2
3
4
5
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency

9、确认以上配置都OK之后,我们去测试类中测试一下:

1
2
3
4
5
6
7
8
9
10
11
12
@SpringBootTest
class DemoApplicationTests {

@Autowired
Person person; //将person自动注入进来

@Test
public void contextLoads() {
System.out.println(person); //打印person信息
}

}

yaml配置注入到实体类完全OK!

加载指定的配置文件

@PropertySource :加载指定的配置文件;

@configurationProperties:默认从全局配置文件中获取值;

1、我们去在resources目录下新建一个person.properties文件

1
name=lisihan

2、然后在我们的代码中指定加载person.properties文件

1
2
3
4
5
6
7
8
@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

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

3、再次输出测试一下:指定配置文件绑定成功!

配置文件占位符

配置文件还可以编写占位符生成随机数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
person:
name: lisihan${random.uuid} # 随机uuid
age: ${random.int} # 随机int
happy: false
birth: 2018/01/01
maps: {k1: v1,k2: v2}
lists:
- code
- girl
- music
- game
dog:
name: ${person.hello:other}_sdfs
age: 1

评论