springboot配置文件之yml的语法学习

springboot配置文件(.yml/.yaml.properties)

YAML(YAML Ain't Markup Language)
YAML A Markup Language:是一个标记语言
YAML isn't Markup Language:不是一个标记语言;
标记语言:
以前的配置文件;大多都使用的是 xxxx.xml文件;

YAML:以数据为中心,比json、xml等更适合做配置文件;


springboot配置文件的加载有先后顺序:

1.application.yml
2.application.yaml
3.application.properoties
后加载的会把先加载的给覆盖掉,也就是后面的配置会覆盖前面的配置。

1、YAML基本语法

  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键,只允许使用空格
  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
  • 大小写敏感

2、YAML 支持的三种数据结构

  • 对象:键值对的集合
  • 数组:一组按次序排列的值
  • 字面量:单个的、不可再分的值

yaml配置举例

//对象(Map)的写法
people:
	id: 123
   	age: 22
   	name: "jason"
//数组的写法,一组连词线(-)开头的行,构成一个数组
-name: sprinboot yaml
 status: 2
 license: MIT
 language: java
可以任意的组合,只要符合语法规范即可。
---------------------------------
字面量
•数字、字符串、布尔、日期
•字符串
–默认不使用引号
–可以使用单引号或者双引号,单引号会转义特殊字符
–字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格。

–文档
•多个文档用---隔开
注意:
Spring Boot使用snakeyaml 解析yml文件;https://bitbucket.org/asomov/snakeyaml/wiki/Documentation#markdown-header-yaml-syntax参考语法
#普通数据的配置(冒号之后要有空格)
name: jason
#对象的配置
person:
   name: jason
   age:22
   addr:chengdu
#对象的行内配置(行内对象冒号之后也要有空格)
person: {name: jason,age: 18,addr: chengdu}

#配置数据、集合(配置普通字符串),记得中间加空格
city:
  - beijing
  - tianjin
  - shanghai
  - chongqing
#或者是行内配置
city: [beijing,tianjin,shanghai,chongqing]

#配置对象数据,一个 - 代表一个对象
person:
  - name: tom
    age: 18
    addr: beijing
  - name: lucy
    age: 17
    addr: shanghai
#或者是行内配置
person: [{name: tom,age: 18,addr: beijing},{name: lucy,age: 17,addr: shanghai}]

#配置Map集合
map:
  key1: value1
  key2: value2

配置文件值注入到组件中

@Value@ConfigurationProperties为属性注值区别

Feature @ConfigurationProperties @Value
Relaxed binding yes no
Meta-data suport yes no
SpEL evaluation no yes

使用@Value注解从配置文件中获取值

@Controller
public class GetParamWithYml {
    @Value("${person.name}")//通过@Value注解来获取yml配置文件中的值
    String name;
    @Value("${city.[0]}") //数组还是以数组下标来进行取值
    String cityname;
    @Value("${people.[0].age}")
    int age;
    @Value("${people.[0].name}") //获取数组对象里面的值
    String peoplename;
    @Value("${hellomap.value2}") //获取map对象的值
    String v2;
    
    @RequestMapping("/getinfo")
    @ResponseBody
    public String print() {
        System.out.println(name);
        System.out.println(age);
        System.out.println(peoplename);
        System.out.println(v2);
        return name + cityname;
    }
}
//yml配置文件中的配置
#普通对象的配置
person:
  name: jason
  age: 22
  addr: chengdu
#普通字面量的配置
name: hellojason
#配置数组,集合等信息
city:
  - beijing
  - tinajing
  - guangzhou
  - xian
#配置对象数据
people:
  - name: tom
    age: 22
  - name: lucy
    age: 23
#配置map对象
hellomap:
  value1: v1
  value2: v2
/*
总结:使用@Value从yml配置文件中获取值,比较精准的就可以获取到值,但是当值较多的时候,书写麻烦,比较累赘,而且当配置文件中层级很多的时候比较麻烦。所以@Value注解适合值较少的情况使用
*/

通过@ConfigurationProperties编写配置类进行注入

/*
 * person的配置类,从yml配置文件中获取值
 */
@ConfigurationProperties(prefix = "person")
@Component//将这个配置类注册为容器组件
public class PersonConf {
    String name;
    int age;
    String addr;
	setter/getter方法
}

//获取配置文件的控制器
@RestController
public class PersonConfController {
    @Autowired//将配置类自动注入进来
    private PersonConf personConf;

    @RequestMapping("/getconfInfo")
    public String getInfo() {
        String name = personConf.getName();
        int age = personConf.getAge();
        System.out.println(age);
        return name;
    }
}
/*
使用@ConfigurationProperties注解编写配置类从yml配置文件中获取值,优点如下:适合于需要获取大量的配置信息,方便复用,其他控制器需要使用直接通过注入进去就可以使用了。他也可以自成一个组件。方便其他使用。
*/

/*
*@Value和@ConfigurationProperties从配置文件中获取值,总结:
*@Value获取值比较精准,适合于取值比较少的情况
*@ConfigruationProperties用于编写配置类,通过组件注入的形式获取配置文件中的值,适合于需要大量获取配置文件中的值的情况,比较灵活,可以实现多复用。它是作为一个组件来使用的,通过@Auotware自动注入到控制器中
*/

配置文件的占位符

  • 随机数

    //例如
    ${random.value}、${random.int}、${random.long}
    ${random.int(10)}、${random.int[1024,65536]}
    
  • 占位符获取之前配置的值,如果没有可以用:指定默认值

person.last‐name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

多个Profile文件

我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用application.properties的配置;使用时可以激活想使用的那个配置文件,比较灵活

yml支持多文档块方式

server:
port: 8081
spring:
profiles:
active: prod
‐‐‐##使用-号表示多文档块
server:
port: 8083
spring:
profiles: dev
‐‐‐
server:
port: 8084
spring:
profiles: prod #指定属于哪个环境

激活指定profile
1、在配置文件中指定 spring.profiles.active=dev
2、命令行:
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev;
可以直接在测试的时候,配置传入命令行参数
3、虚拟机参数;
-Dspring.profiles.active=dev

配置文件的加载顺序

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

–file:./config/
–file:./
–classpath:/config/
–classpath:/
优先级由高到底,高优先级的配置会覆盖低优先级的配置;

SpringBoot会从这四个位置全部加载主配置文件;互补配置;所谓互补配置,就是说如果你的这配置文件中没有配置 ,而在另一个配置文件配置了,那么将会综合在一个然后生效。

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

项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;例如:
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

原文地址:https://www.cnblogs.com/jasonboren/p/11395372.html