SpringBoot—Yaml以及properties

最新推荐文章于 2024-04-12 11:08:50 发布

叫我菜菜就好

最新推荐文章于 2024-04-12 11:08:50 发布

阅读量1k

点赞数

分类专栏： SpringBoot 文章标签： spring java 后端

本文链接：https://blog.csdn.net/m0_46983722/article/details/123878388

版权

SpringBoot 专栏收录该内容

10 篇文章 1 订阅

订阅专栏

SpringBoot—Yaml详解

前言
yaml基础语法
yaml基本使用
加载指定的配置文件
配置文件占位符
properties配置
- 测试
对比
JSR303数据校验
作用域
- 多文件
- 单文件
结论

前言

什么是yaml

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

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

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

为什么要用yaml

yaml作为官方推荐的一种配置文件的方式，优点在于语法简单。
yaml可以直接给实体类赋值。
以传统的传统xml配置作为对比：
xml：


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

yaml

server：
  prot: 8080

要求

1、空格不能省略

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

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

yaml基础语法

对象、Map（键值对）


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

例如：


student:
    name: caicai
    age: 3

行内写法：


student: {name: caicai,age: 3}

注意：空格绝对不可以省略，也不可以多打几个空格。

数组（ List、set ）

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

pets:
 - cat
 - dog
 - pig

行内写法：

pets: [cat,dog,pig]

修改默认端口号


server:
  port: 8082

yaml基本使用

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

2、编写一个实体类 Dog；


package com.kuang.springboot.pojo;

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

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


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

4、在SpringBoot的测试类下注入狗狗输出一下
@Autowired自动注入


@SpringBootTest
class DemoApplicationTests {

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

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

}

5、我们在编写一个复杂一点的实体类：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()方法  
}

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


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

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

@ConfigurationProperties作用：

将配置文件中配置的每一个属性的值，映射到这个组件中；

告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定

参数 prefix = “person” : 将配置文件中的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;
}

8、注入一个依赖


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

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


@SpringBootTest
class DemoApplicationTests {

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

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

}

加载指定的配置文件

applicationproperties和yaml文件是可以共存的，但有优先级，我们可以用@PropertySource来加载指定的配置文件

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

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

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


name=caicai

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

@PropertySource(value = "classpath:person.properties")


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

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

    ......  
}

这样我们就将配置文件中的相应的值绑定进去了

配置文件占位符

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


person:
    name: caicai${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

properties配置

【注意】properties配置文件在写中文的时候，会有乱码，我们需要去IDEA中设置编码格式为UTF-8
方法：
settings–>FileEncodings 中配置；
在这里插入图片描述

测试

1、新建一个实体类User


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

2、编辑配置文件 user.properties


user.name=caicai
user.age=18
user.sex=男

3、我们在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;
}

4、Springboot测试


@SpringBootTest
class DemoApplicationTests {

    @Autowired
    User user;

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

}

对比

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图
在这里插入图片描述
1、@ConfigurationProperties只需要写一次即可， @Value则需要每个字段都添加

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

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

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

JSR303数据校验

使用@Validated来进行数据的校验
例如邮箱校验@Email
在这里插入图片描述
如果这里的birth不是邮箱的格式，那么就会报错。
当然还有很多，除此之外我们还可以自定义数据校验格式。

作用域

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件：
在这里插入图片描述

优先级1：项目路径下的config文件夹配置文件
优先级2：项目路径下配置文件
优先级3：资源路径下的config文件夹配置文件
优先级4：资源路径下配置文件

当然我们也可以自己手动指定

多文件

在application中spring.profiles.active=指定后缀名
在这里插入图片描述
在application中,输入spring.profiles.active=dev，即可使用dev的配置环境

单文件

在这里插入图片描述
通过active来指定环境

指定位置加载配置文件

我们还可以通过spring.config.location来改变默认的配置文件位置

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；这种情况，一般是后期运维做的多，相同配置，外部指定的配置文件优先级最高

结论

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

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

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