SpringBoot 配置文件yaml

最新推荐文章于 2025-03-10 23:17:56 发布

目起

最新推荐文章于 2025-03-10 23:17:56 发布

阅读量158

点赞数 1

分类专栏： springboot学习

本文链接：https://blog.youkuaiyun.com/cs_quan/article/details/117048762

版权

springboot学习专栏收录该内容

16 篇文章

订阅专栏

yaml 简介

YAML（/ˈjæməl/，尾音类似camel骆驼）是一个可读性高，用来表达数据序列化的格式

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

注意

1 空格不能省略

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

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

yaml 的基础语法

字面量：普通的值

k: v

‘’ 单引号，会转义字符串里面的特殊字符

name: “kuang \n shen” 输出：kuang 换行 shen

“"双引号，不会转义字符串里面的特殊字符

name: ‘kuang \n shen’ 输出：kuang \n shen

对象、Map（键值对）


student:
    name: qinjiang
    age: 3

行内写法


student: {name: qinjiang,age: 3}

数组

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


pets:
 - cat
 - dog
 - pig

行内写法


pets: [cat,dog,pig]

YAML的强大特性

注入配置文件将yaml 文件中属性注入到实体类中
松散绑定
jsr303数据校验
多环境配置

1 注入配置文件将yaml 文件中属性注入到实体类中

前面都是使用@Value属性注入的

1 编写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()方法  
}

2 编写yaml配置


/*
@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;
}

测试

@SpringBootTest
class DemoApplicationTests {

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

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

}

2 松散绑定
springboot yaml文件中名字为last-name,实际的Bean类中的属性为lastName也可以完成绑定

3 jsr303数据校验
Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常

public class User {
    @Email(message="邮箱格式错误")
    private String name;
}

常见的参数


@NotNull(message="名字不能为空")
private String userName;
@Max(value=120,message="年龄最大不能查过120")
private int age;
@Email(message="邮箱格式错误")
private String email;

空检查
@Null       验证对象是否为null
@NotNull    验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank   检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty   检查约束元素是否为NULL或者是EMPTY.
    
Booelan检查
@AssertTrue     验证 Boolean 对象是否为 true  
@AssertFalse    验证 Boolean 对象是否为 false  
    
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内  
@Length(min=, max=) string is between min and max included.

日期检查
@Past       验证 Date 和 Calendar 对象是否在当前时间之前  
@Future     验证 Date 和 Calendar 对象是否在当前时间之后  
@Pattern    验证 String 对象是否符合正则表达式的规则

.......等等
除此以外，我们还可以自定义一些数据校验规则

4 多环境配置，以及配置文件的位置

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml , 用来指定多个环境版本；

application-test.properties 代表测试环境配置

application-dev.properties 代表开发环境配置

application-pro.properties 代表生产环境配置

但是Springboot并不会直接启动这些配置文件，它默认使用application.properties主配置

我们需要通过一个配置来选择需要激活的环境：


#比如在配置文件中指定使用dev环境，我们可以通过设置不同的端口号进行测试；
#我们启动SpringBoot，就可以看到已经切换到dev下的配置了；
spring.profiles.active=dev

在这里插入图片描述

yaml 的多文档配置


server:
  port: 8081
#选择要激活那个环境块
spring:
  profiles:
    active: prod

---
server:
  port: 8083
spring:
  profiles: dev #配置环境的名称


---

server:
  port: 8084
spring:
  profiles: prod  #配置环境的名称

配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为

优先级1：项目路径下的config文件夹配置文件
优先级2：项目路径下配置文件
优先级3：资源路径下的config文件夹配置文件
优先级4：资源路径下配置文件
在这里插入图片描述

spring.config.location来改变默认的配置文件位置

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

java -jar spring-boot-config.jar --spring.config.location=F:/application.properties