SpringBoot 学习日志2.yaml/yml配置文件详解+JSR303数据校验+多环境切换(使用IDEA)

参考博客

配置文件

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

# 配置文件到底能配置什么?与spring.factories联系巨大
# 我们能在配置文件中配置的东西,都存在一个固有的规律:xxxAutoConfiguration  xxxProperties(与配置文件中能配置的属性绑定,一一对应)
# xxxAutoConfiguration中配置了默认值,然后xxxProperties和配置文件中能配置的属性绑定,我们就可以配置了

(application.properties/application.yml/application.yaml)

  • application.properties

    • 语法结构 :key=value

  • application.yml/application.yaml

    • 语法结构 :key:空格 value

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

YAML(YAML Ain't a Markup Language)概述

传统xml配置

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

yaml配置

server:
  port: 8081

yaml基础语法:

语法要求严格!

1、空格不能省略

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

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

# 语法标准
# 以前:key=value
# 现在:key: value(中间有一个空格,一定要记得)
# yaml:除了存键值对,还可以存对象

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

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

key: value

注意:

  • "" 双引号不会转义字符串里面的特殊字符 , 特殊字符会作为本身想表示的意思;

    比如 :name: "kuang \n shen"   输出 :kuang  换行   shen

  • '' 单引号,会转义特殊字符 , 特殊字符最终会变成和普通字符一样输出

    比如 :name: ‘kuang \n shen’   输出 :kuang  \n   shen

对象、Map(键值对)

对象的属性和值得关系,注意缩进。

多行写法: 

#对象
student:
  name: qqa
  age: 21

行内写法(类似json):

# 行内写法
student: {name: qqa,age: 21}

数组( List、set )

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

多行写法:

# 数组
pets:
  - cat
  - dog
  - pig

行内写法:

pets: [cat,dog,pig]

修改SpringBoot的端口号

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

server:
  port: 8081

注意:一定别忘记赋值时要有空格

yaml依赖注入

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

2、编写一个实体类 Dog

另外,以前使用Spring时,我们是如何给bean注入属性值的?使用注解@Value

package com.qqa.pojo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
//组件
@Component
public class Dog {

    @Value("小花")
    private String name;
    @Value("2")
    private Integer age;

    public Dog() {
    }

    public Dog(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

3、编写一个复杂的实体类:Person 类(其中包括了)

@ConfigurationProperties(prefix = "person")

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

加载指定的配置文件

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

(1)在resources目录下新建一个person.properties文件

(2)在我们的代码中指定加载person.properties文件


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

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

    ......  
}

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

JSR303数据校验 , 这个就是在字段复制前增加一层过滤器验证 , 可以保证数据的合法性例如注解@Email。

常见注解:


@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 对象是否符合正则表达式的规则
package com.qqa.pojo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;

//注册bean
@Component
/*
@ConfigurationProperties作用:
将配置文件中配置的所有属性的值,映射到这个组件中;
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@ConfigurationProperties(prefix = "person")

//以javaConfig的方式(注解的方式),加载指定的配置文件
//@PropertySource(value = "classpath:qqa.properties")

//数据校验
@Validated
public class Person {
    //使用Spring EL表达式
    //@Value("${name}")

    //@Email(message = "邮箱格式错误")
    private String name;
    private Integer age;
    private boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

    public Person() {
    }

    public Person(String name, Integer age, boolean happy, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
        this.name = name;
        this.age = age;
        this.happy = happy;
        this.birth = birth;
        this.maps = maps;
        this.lists = lists;
        this.dog = dog;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public boolean isHappy() {
        return happy;
    }

    public void setHappy(boolean happy) {
        this.happy = happy;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", happy=" + happy +
                ", birth=" + birth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", dog=" + dog +
                '}';
    }
}

4、来使用yaml配置的方式进行注入,注意区别和优点,我们编写一个yaml配置!

配置文件占位符

松散绑定:这个什么意思呢? 比如在yaml中写的first-name,和firstName是一样的, - 后面跟着的字母默认是大写的。这就是松散绑定。

person:
#   使用Spring的EL表达式
  name: qqa${random.int}
  age: 3
  happy: true
  birth: 1998/12/30
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - music
  dog:
    # 条件表达式,如果person.hello存在就赋其值,否则赋值hello
    name: 小黑${person.hello:hello}_小花
    age: 10

# 松散绑定:在bean中的属性可以为firstName
dog:
  first-name: xxx

5、前提是要导入配置文件处理器依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

注意:

1、将配置文件的key 值 和 属性的值设置为不一样,则结果输出为null,注入失败

2、再配置一个person2,然后将 @ConfigurationProperties(prefix = "person2") 指向我们的person2

对比properties配置

1、新建一个实体类User

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

2、在resources目录下新建配置文件 user.properties

user.name=xxx
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;
}

结论:

配置yaml和配置properties都可以获取到值;

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

如果专门编写了一个JavaBean来和配置文件进行一一映射,直接使用@ConfigurationProperties+yaml的形式,不要犹豫!

多环境切换

使用properties

在编写主配置文件时,文件名可以是 application-{profile}.properties/yaml , 用来指定多个环境

例如:

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

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

application-pro.properties 代表发布环境配置

但是Springboot并不会使用这些配置文件,它默认使用application.properties为主配置文件。

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

# springboot的多环境配置:可以选择激活哪一个配置文件
spring.profiles.active=dev

使用yaml

和properties配置文件一样,但是使用yaml实现不需要创建多个配置文件,更加方便了 !

要用“---”隔开

# 多文档模块
server:
  port: 8081
spring:
  profiles:
    active: dev

---
server:
  port: 8082
spring:
  profiles: dev

---
server:
  port: 8083
spring:
  profiles: test

注意:如果yaml和properties同时配置了端口,并且没有激活环境 , 默认会使用properties配置文件的端口!

配置文件加载位置

springboot 启动时会扫描以下位置的application.properties或者application.yaml文件作为Spring boot的默认配置文件:

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

优先级由高到底,高优先级的配置会覆盖低优先级的配置,SpringBoot会从这四个位置全部加载主配置文件,互补配置。

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值