SpringBoot配置文件笔记:yaml语法,yaml如何写、注入配置文件类(2种方式根据业务场景选择)、多环境切换、配置文件加载优先级、指定位置加载配置文件

一、配置文件

  SpringBoot使用一个全局的配置文件 , 配置文件名称是固定的,有2种方式:

1、application.properties

  语法结构 : key=value

2、application.yml   ——  推荐使用 yaml

  语法结构 :key:空格 value

  注意:空格一定需要,yaml 语法就是通过空格缩进去确定层级关系。

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

二、yaml概述

  yaml以数据为中心,而不是以标记语言为重点!

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

// 传统xml配置:
<server>
    <port>8081<port>
</server>

// yaml配置:
server:
  prot: 8080

1、基础语法

  说明:语法要求严格!

(1)空格不能省略

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

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

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

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

k: v

  注意:

  • “ ” 双引号,不会转义字符串里面的特殊字符 , 特殊字符会作为本身想表示的意思。比如 :name: "kuang shen"   输出 :kuang  换行   shen

  • '' 单引号,会转义特殊字符 , 特殊字符最终会变成和普通字符一样输出。比如 :name: ‘kuang shen’   输出 :kuang     shen

3、对象、Map(键值对)

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

// 在下一行来写对象的属性和值得关系,注意缩进;比如:
student:
    name: qinjiang
    age: 3

// 行内写法
student: {name: qinjiang,age: 3}

4、数组( List、set )

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

pets:
 - cat
 - dog
 - pig

  行内写法

pets: [cat,dog,pig]

三、注入配置文件

1、如果要使用properties配置文件可能导入时存在乱码现象 , 需要在IDEA中进行调整 , 我们这里直接使用yml文件 , 将默认的 application.properties后缀修改为yml

2、导入配置文件处理器

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

3、编写yml 配置文件

person:
  name: Test${random.uuid} // spring的SpEL表达式,调用方法生成uuid
  age: 2
  birth: 2021/06/01
  happy: true
  maps: {k1: v1, K2: v2}
  lists:
    - apple
    - banana
    - orange
  temp: 小 // 可以定义类中没有的属性
  dog:
    name: ${person.temp:temp}旺财 // 表示占位符,表示如果temp为空就不显示,不为空就输出小旺财
    age: 1

4、在SpringBoot的主程序的同级目录下建包,只有这样,主程序才会对这些类生效 ; 我们建一个pojo的包放入我们的Person类和Dog类;

package com.kuang.springbootdemo03.pojo;
​
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
​
import java.util.Date;
import java.util.List;
import java.util.Map;
​
/*
@ConfigurationProperties作用:
将配置文件中配置的每一个属性的值,映射到这个组件中;
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
​
只有这个组件是容器中的组件,才能使用容器提供的@ConfigurationProperties功能
*/
@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;
​
    //get,set方法
    //toString方法
    
}

5、另外一种注入方式,不使用注解

  我们上面采用的方法都是最简单的方式,开发中最常用的;还有另外一种方式,道理都是相同的。

  配置文件除了yml还有我们之前常用的properties,我们没有讲,properties配置文件在写中文的时候,会有乱码,我们需要去IDEA中设置编码格式为UTF-8;

  需要在 settings --> FileEncodings 中配置。

  我们的类和配置文件直接关联着 , 我们使用的是@configurationProperties的方式,还有一种方式是使用@value

@Component //注册bean
public class Person {
    //直接使用@value
    @Value("${person.name}") //从配置文件中取值
    private String name;
    @Value("#{11*2}")  //#{SPEL} Spring表达式
    private Integer age;
    @Value("true")  // 字面量
    private Boolean happy;
    ...
}

  这个使用起来并不友好!我们需要为每个属性单独注解赋值,比较麻烦,并且没法批量设置;我们来看个功能对比图

  ConfigurationProperties只需要写一次即可 , value则需要每个字段都添加。

  松散绑定:这个什么意思呢? 比如我的yml中写的last-name,在java类的属性中用驼峰命名lastName是一样的, - 后面跟着的字母默认是大写的。这就是松散绑定,可以注入值。

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

  复杂类型封装,yml中可以封装对象 , 使用@value就不支持

6、结论:

  配置yml和配置properties都可以获取到值,可以根据业务场景进行选择:

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

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

7、加载指定配置文件注入值

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

// 我们在resources目录下新建一个person.properties文件
name=kuangshen

// 然后在我们的代码中指定加载person.properties文件
@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
​
    @Value("${name}")
    private String name;
    ......  
}

四、多环境切换

  profile是Spring对不同环境提供不同配置功能的支持,可以通过激活不同的环境版本,实现快速切换环境;

1、方式一:多配置文件

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

  例如:

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

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

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

  比如:在resources文件夹下有多个环境配置,默认会运行application.properties文件

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

// 比如在配置文件中指定使用application-dev.properties环境,那么需要profiles指定到-后面的单词就可以了
spring.profiles.active=dev

2、方式二:yml的多文档块

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

server:
  port: 8081
// 选择要激活那个环境块
spring:
  profiles:
    active: prod
​
---
server:
  port: 8083
// 配置环境的名称
spring:
  profiles: dev
​

---
​
server:
  port: 8084
spring:
  profiles: prod // 配置环境的名称

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

五、配置文件加载位置

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

1、配置文件的优先级

  文件在项目中的哪个位置SpringBoot优先扫描哪个文件?

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

  优先级由高到底,高优先级的配置会覆盖低优先级的配置;

  SpringBoot会从这四个位置全部加载主配置文件,互补配置。

2、指定位置加载配置文件

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

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

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

  外部加载配置文件的方式十分多,我们选择最常用的即可,在开发的资源文件中进行配置!

  官方外部配置文件说明参考文档

原文地址:https://www.cnblogs.com/goloving/p/14837771.html