SpringBoot-狂神（3. yaml配置注入）学习笔记

最新推荐文章于 2023-04-03 00:20:17 发布

yuan_404

最新推荐文章于 2023-04-03 00:20:17 发布

阅读量562

点赞数

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

本文链接：https://blog.csdn.net/weixin_44449838/article/details/108563378

版权

SpringBoot 专栏收录该内容

20 篇文章 14 订阅

订阅专栏

上一篇：2. 运行原理初探
 下一篇：4. 多环境配置及配置文件位置

文章目录

1. yaml语法
2. 注入配置文件
3. 结论

1. yaml语法

1. 配置文件

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

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

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

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

application.properties

server.port=8081

application.yml

server：
  prot: 8080

2. yaml概述

YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。

在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）

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

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

传统xml配置:

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

yaml配置

server：
  prot: 8080

3. yaml基础语法

1. 说明：语法要求严格

空格不能省略
以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。
属性和值的大小写都是十分敏感的

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

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

Key: Value

3. 注意

“ ” 双引号，不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思；

比如：name: “AAA \n BBB” 输出：AAA 换行 BBB
‘’ 单引号，会转义特殊字符，特殊字符最终会变成和普通字符一样输出

比如：name: ‘AAA \n BBB’ 输出：AAA \n BBB

4. 对象、Map（键值对）

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

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

student:
	   name: hehe
	   age: 3

行内写法

student: {name: hehe,age: 3}

5. 数组（ List、set ）

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

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

6. 修改SpringBoot的默认端口号

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

server:
  port: 8082

2. 注入配置文件

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

1. yaml注入配置文件

老办法

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

编写一个实体类 Dog

@Component  //注册bean到容器中
public class Dog {
    private String name;
    private Integer age;
    //有参无参构造、get、set方法、toString()方法  
}

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

@Component //注册bean
public class Dog {
    @Value("阿黄")
    private String name;
    @Value("18")
    private Integer age;
}

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

@SpringBootTest
class DemoApplicationTests {

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

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

}

结果成功输出，@Value注入成功，这是我们原来的办法

YML

我们在编写一个复杂一点的实体类：Person 类

@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()方法  
}

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

person:
  name: hehe
  age: 3
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
   - code
   - girl
   - music
  dog:
    name: 旺财
    age: 1

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

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

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

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

@SpringBootTest
class DemoApplicationTests {
    @Autowired
    Person person; //将person自动注入进来
    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }
}

结果：所有值全部注入成功

2. 加载指定的配置文件

@PropertySource ：加载指定的配置文件；
@configurationProperties：默认从全局配置文件中获取值；
使用

在resources目录下新建一个person.properties文件
```
name=hehe
```

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

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

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

    ......  
}

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

3. 配置文件占位符

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

person:
    name: hehe${random.uuid} # 随机uuid
    age: ${random.int}  # 随机int
    happy: false
    birth: 2000/01/01
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - girl
      - music
    dog:
      name: ${person.hello:other}_旺财
      age: 1

4. 回顾properties配置

注意： properties配置文件在写中文的时候，会有乱码，我们需要去IDEA中设置编码格式为UTF-8
settings–>FileEncodings 中配置
使用

新建一个实体类User

@Component //注册bean
public class User {
    private String name;
    private int age;
    private String sex;
}

编辑配置文件 user.properties

user1.name=hehe
user1.age=18
user1.sex=男

在User类上使用@Value来进行注入

@Component //注册bean
@PropertySource(value = "classpath:user.properties")
public class User {
    //直接使用@value
    @Value("${user.name}") //从配置文件中取值
    private String name;
    @Value("#{9*2}")  // #{SPEL} Spring表达式
    private int age;
    @Value("男")  // 字面量
    private String sex;
}

Springboot测试

@SpringBootTest
class DemoApplicationTests {
    @Autowired
    User user;
    @Test
    public void contextLoads() {
        System.out.println(user);
    }
}

5. 对比小结

在这里插入图片描述

@ConfigurationProperties只需要写一次即可， @Value则需要每个字段都添加
松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下
JSR303数据校验，这个就是我们可以在字段是增加一层过滤器验证，可以保证数据的合法性@Validated 注解
源码地址： spring-context-X.X.X.RELEASE.jar → org → springframework → ui → validation 下
复杂类型封装，yml中可以封装对象，使用value就不支持

3. 结论

配置yml和配置properties都可以获取到值，强烈推荐 yml；
如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；
如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫

yuan_404

关注

0
点赞
踩
3

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringBoot-狂神（3. yaml配置注入）学习笔记

文章目录1. yaml语法1. 配置文件2. yaml概述3. yaml基础语法1. 说明：语法要求严格2. 字面量：普通的值 [ 数字，布尔值，字符串 ]3. 注意4. 对象、Map（键值对）5. 数组（ List、set ）6. 修改SpringBoot的默认端口号2. 注入配置文件1. yaml注入配置文件2. 加载指定的配置文件3. 配置文件占位符4. 回顾properties配置5. 对比小结3. 结论1. yaml语法1. 配置文件SpringBoot使用一个全局的配置文件，配置
复制链接

扫一扫