SpringBoot的yaml配置注入

最新推荐文章于 2024-07-26 14:40:07 发布

十分之九加九分之一

最新推荐文章于 2024-07-26 14:40:07 发布

阅读量3k

点赞数 1

分类专栏： SpringBoot 文章标签： spring boot yaml

本文链接：https://blog.csdn.net/wulei2921625957/article/details/107922843

版权

SpringBoot 专栏收录该内容

21 篇文章 4 订阅

订阅专栏

yaml语法学习

配置文件

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

application.properties
- 语法结构：key=value
application.yml
- 语法结构：key：空格 value

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

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

server.port=8081

yaml概述

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

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 的配置文件后缀为 .yml，如：runoob.yml 。

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

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

传统xml配置：

<server>
    <port>8081<port>
</server>

yaml配置：

server：
  prot: 8081

yaml基础语法

大小写敏感
使用缩进表示层级关系
缩进不允许使用tab，只允许空格
缩进的空格数不重要，只要相同层级的元素左对齐即可
'#'表示注释

字面量：普通的值 [ 数字，布尔值，字符串 ]

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

name: 张三
age: 20
isHappy: false

注意：

“ ” 双引号，不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思；
比如：name: “zhang\n san” 输出：zhang换行 san
‘’ 单引号，会转义特殊字符，特殊字符最终会变成和普通字符一样输出
比如：name: ‘zhang\n san’ 输出：zhang\n san

对象、Map（键值对）

对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。
也可以使用 key:{key1: value1, key2: value2, ...}。
还可以使用缩进表示层级关系；

public class Person{
	private String name;
	private int age;
}

比如：

person: 
	name: 张三
	age: 20

#或者用行内写法
person: {name: 张三,age: 20}

较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value：（一般用不到）

?
	- complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]

数组（ List、set )

以 - 开头的行表示构成一个数组：

private List pets;

pets:
  - cat
  - dog
  - pig
  - ...

行内写法

pets: [cat,dpg,pig,...]

一个相对复杂的例子：

perpon: 
  -
      id: 1
      name: 张三
  -
	  id: 2
	  name: 李四

意思是 perpon属性是一个数组，每一个数组元素又是由 id、name两个属性构成。

使用流式(flow)的方式表示：

person: [{id: 1,name: 张三},{id: 2,name: 李四}]

修改SpringBoot的默认端口号

server: 
	port: 8888

注入配置文件

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

yaml注入配置文件

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

2、编写一个实体类 Dog；

package com.wu.pojo;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component//注册bean到容器中
public class Dog {
    private String name;
    private int age;

}

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

public class Dog {
	@Value("阿黄")
    private String name;
    @Value("18")
    private int age;
}

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

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    private Dog dog;
    @Test
    void contextLoads() {
        System.out.println(dog);
    }
}

结果成功输出，@Value注入成功，这是我们原来的办法对吧。
在这里插入图片描述
5、我们再编写一个复杂一点的实体类：Person 类

@Component
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;
    private int age;
    private Boolean habby;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;
}

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

person:
  name: 张三
  age: 20
  habby: false
  birth: 2020/11/28
  maps: {k1: v1,k2: v2}
  list:
    - code
    - music
    - girl
  dog:
    name: 旺财
    age: 3

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

package com.wu.pojo;

/*
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/

@ConfigurationProperties(prefix = "person")
@Component
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;
    private int age;
    private Boolean habby;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;
}

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

由于我的没有那个提示了，删了依赖也没有了，所以我直接贴依赖了

<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

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

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    private Person person;
    @Test
    void contextLoads() {
        System.out.println(person);
    }
}

在这里插入图片描述
yaml配置注入到实体类完全OK！

加载指定的配置文件

@PropertySource ：加载指定的配置文件；

@configurationProperties：默认从全局配置文件中获取值；

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

name=张三

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

package com.wu.pojo;

@Component
//@ConfigurationProperties(prefix = "person")
@PropertySource(value = "classpath:person.properties")
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    @Value("${name}")
    private String name;
    private int age;
    private Boolean habby;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;
}

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

在这里插入图片描述

配置文件占位符

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

person:
  name: 张三${random.uuid}  # 随机uuid
  age: ${random.int} # 随机int
  habby: false
  birth: 2020/11/28
  maps: { k1: v1,k2: v2 }
  lists:
    - code
    - music
    - girl
  dog:
    #如果person有hello这个属性，那么就会输出" hello的值+_旺财 ",否则输出"other_旺财"
    name: ${person.hello:other}_旺财
    age: 3

由于有uuid，输出结果有点长，我就不发截图了

回顾properties配置

我们上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的！那我们来唠唠其他的实现方式，道理都是相同的；写还是那样写；配置文件除了yml还有我们之前常用的properties ，我们没有讲，我们来唠唠！

【注意】properties配置文件在写中文的时候，会有乱码，我们需要去IDEA中设置编码格式为UTF-8；

settings–>FileEncodings 中配置；

在这里插入图片描述
测试步骤：

1、新建一个实体类User

package com.wu.pojo;

@AllArgsConstructor
@NoArgsConstructor
@Data
@Component
public class User {
    private String name;
    private  int age;
    private String sex;
}

2、编辑配置文件 user.properties

user1.name=张三
user1.age=18
user1.sex=男

我在这个配置文件中的user1.name卡了一会，当你用user.name=张三时候，它反正输出的都是你电脑的用户名，我也不知道咋事，不知道你们的是不是这样,所以我改成了user1

3、我们在User类上使用@Value来进行注入！

package com.wu.pojo;

@PropertySource(value = "classpath:user.properties")
@AllArgsConstructor
@NoArgsConstructor
@Data
@Component
public class User {
	//如果这里你写成了@Value("${user.name}")，那输出的是你电脑的用户名
    @Value("${user1.name}")//从配置文件中读取
    private String name;
    @Value("#{9*2}")  // #{SPEL} Spring表达式
    private  int age;
    @Value("男")  // 字面量
    private String sex;
}

4、Springboot测试

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    private User user;

    @Test
    void contextLoads() {
        System.out.println(user);
    }
}

结果正常输出：

在这里插入图片描述

对比小结

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	支持
复杂类型封装	支持	支持

1、@ConfigurationProperties只需要写一次即可， @Value则需要每个字段都添加

2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

3、JSR303数据校验，这个就是我们可以在字段是增加一层过滤器验证，可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象，使用value就不支持

结论：

配置yml和配置properties都可以获取到值，强烈推荐 yml；

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！

十分之九加九分之一

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot的yaml配置注入

yaml语法学习配置文件SpringBoot使用一个全局的配置文件，配置文件名称是固定的application.properties语法结构：key=valueapplication.yml语法结构：key：空格 value配置文件的作用：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！server.port=8081yaml概述YAML是 “
复制链接

扫一扫

专栏目录