SpringBoot学习笔记-06 yaml基础语法

最新推荐文章于 2024-05-02 00:11:51 发布
最新推荐文章于 2024-05-02 00:11:51 发布
阅读量647 收藏 1
点赞数
分类专栏： Java开发-SpringBoot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_39304630/article/details/113146370
版权

        我们自动构建的SpringBoot初始项目，使用的配置文件是 application.properties ；但其实官方更推荐我们使用yaml，需要注意配置文件名必须是application.yaml，否则会无法读取（通过前面的学习，读者应该明白，这边之所以规定了读取的文件名，是在自动配置的相关规范中定义的默认值）。

1.配置文件语法格式对比

application.properties语法结构： key = value

server.port=8080

application.yaml语法结构： key:(空格)value

server:
  port: 8080

以前的时候，还使用过xml配置：

<server>
    <port>8080<port>
</server>

2.yaml语法入门

A.yaml语法规范

1）大小写敏感

2）使用空格缩进表示层级所属关系

3）缩进只能用空格，不允许tab（类比py，py只能选择4个空格或者1个tab，不允许混用）

4）属于同一个层级的元素要求必须左对齐

a:
 bc:
  d:
#表示 a.bc.d

a:
 bc:
 d:
#表示 a.bc 和 a.d

5）用#表示注释

B.用yaml赋值

yaml的强大之处在于，可以直接为我们的实体类赋值。yaml支持的数据类型：键值对、数组、普通变量：

1.记住由于我们使用yaml配置文件，因此别忘了在pom.xml配置编译时包含

            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <!--记住一定要配置SpringBoot主配置文件的过滤-->
                    <include>**/*.yaml</include>
                    <include>**/*.properties</include>
                    <include>**/*.txt</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>

2.Spring建议我们使用yaml注入值时，增加依赖以便提示是否有错

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

引入该依赖后，重启ideal，就会发现我们在用配置文件设置属性时，只要绑定了prefix，就会有提示：

[注]：这只是SpringBoot提供了便利性功能，与业务无关，因此打包的时候最好不要包含它，避免打包出的jar包内多出了一些不影响运行的jar包：

<build>
        <plugins>
            <!--SpringBoot打包-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
</build>

3.构建实体类进行实验

dogbean: &dogbean
  name: 小白 #单个不可再分的值:date、boolean、string、null(用~表示)、number等
  age: 4 #

personbean:
  name: zzt
  age: 22
  happy: true
  birth: 1999/4/14
  maps: {k1: v1,k2: v2} #键值对集合 map、set、hash、对象
  list: #数组 array、list、queue
    - code
    - music
  #多维数组简单值
  mulArr:
    -
      - zzt
      - zjm
    -
      - zjm
      - zzt
  #数组复杂对象
  dogs:
    -
      name: 小白
      age: 4
    -
      name: 小黑
      age: 5
  #值引用
  dog:
    <<: *dogbean

Dog.java

package com.zzt.vo;

public class Student {
    private Integer id;
    private String name;
    private Integer age;

    public Student() {
    }

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

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    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 "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}
 

Person.java

@Component
@ConfigurationProperties(prefix = "personbean")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> list;
    private String[][] mulArr;
    private Dog[] dogs;
    private Dog dog;

    public Person() {
    }

    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 getHappy() {
        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> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog[] getDogs() {
        return dogs;
    }

    public void setDogs(Dog[] dogs) {
        this.dogs = dogs;
    }

    public Dog getDog() {
        return dog;
    }

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

    public String[][] getMulArr() {
        return mulArr;
    }

    public void setMulArr(String[][] mulArr) {
        this.mulArr = mulArr;
    }

    @Override
    public String toString() {
        System.out.println("多维数组");
        for (String[] strings : mulArr) {
            for (String string : strings) {
                System.out.println(string);
            }
        }
        System.out.println("数组符合对象");
        for (Dog dog1 : dogs) {
            System.out.println(dog1);
        }
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", happy=" + happy +
                ", birth=" + birth +
                ", maps=" + maps +
                ", list=" + list +
                ", dog=" + dog +
                '}';
    }
}

[注]：1.yaml是没有办法像spring配置文件那样做对象引用 -- ref 的，只能做值引用。

          2.@ConfigurationProperties(prefix = "personbean")用于指明从yaml文件中的哪个对象获取值。

          3.yaml可用~表示赋值null。

          4.yaml支持松散绑定，last-name属性等价于lastName。(-符号后紧跟的字母大写)

          5.yaml自动根据字段名匹配赋值，而properties需要配合@Value用SPEL取值后赋值。

          6.一般来说，我们如果确定只要其中一个或几个值而不是全部，会选择用properties+@Value，但是大多数情况下还是会选择yaml。

          7.yaml中可以封装对象（复杂类型），而properties最多支持一个数组，@Value没有办法注入复杂类型。

          8.yaml支持JSR-303数据校验，可以在字段增加一层过滤器验证，保证数据的合法性。

4.构建测试

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    private Person person;

    @Autowired
    private Dog dog;

    @Test
    void contextLoads() {
        System.out.println(person);
        System.out.println(dog);
        System.out.println(person.getDog()==dog);
    }

}

5.执行结果

3.yaml vs propertie

对比一下使用properties赋值：

A.@PropertySource导入properties、使用SPEL配合@Value手动取值并赋值

这中方式可以将实体类赋值与主配置文件解耦，更清晰，但是比较难以使用。

dog_name=小白
dog_age=4
person_name=zzt
person_age=22
happy=true
birth=1999/4/14
list=code,music
@Component
@PropertySource(value = "classpath:bean.properties")
public class Person {
    @Value("${person_name}")
    private String name;
    @Value("${person_age}")
    private Integer age;
    @Value("${happy}")
    private Boolean happy;
    @Value("${birth}")
    private Date birth;
    // 没有办法用properties赋值
    private Map<String,Object> maps;
    @Value("${list}")
    private List<Object> list;
    // 没有办法用properties(正确)赋值
    private String[][] mulArr;
    // 没有办法用properties赋值
    private Dog[] dogs;
    // 没有办法用properties赋值
    private Dog dog;

    public Person() {
    }

    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 getHappy() {
        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> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog[] getDogs() {
        return dogs;
    }

    public void setDogs(Dog[] dogs) {
        this.dogs = dogs;
    }

    public Dog getDog() {
        return dog;
    }

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

    public String[][] getMulArr() {
        return mulArr;
    }

    public void setMulArr(String[][] mulArr) {
        this.mulArr = mulArr;
    }

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

B.@ConfigurationProperties在主配置的properties指定所属对象，并使用prefix指定对象

application.properties

person.name=zjm
person.age=23
person.happy=true
person.birth=1998/5/23
person.list=wwz,zyf,zzt
person.dog.name=小黑
person.dog.age=4
@Component
@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> list;
    private String[][] mulArr;
    private Dog[] dogs;
    private Dog dog;

    public Person() {
    }

    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 getHappy() {
        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> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog[] getDogs() {
        return dogs;
    }

    public void setDogs(Dog[] dogs) {
        this.dogs = dogs;
    }

    public Dog getDog() {
        return dog;
    }

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

    public String[][] getMulArr() {
        return mulArr;
    }

    public void setMulArr(String[][] mulArr) {
        this.mulArr = mulArr;
    }

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

[注]：1.如果一定要使用properties，需要设置文件编码为UTF-8。

执行结果：

2.当同时存在application.properties和application.yaml，如果在两个配置文件中配置了相同的属性，以properties为准，不重复的配置全部采取(SpringBoot先读取properties)。

3.对于字符串类型的值，我们加不加' '和" "都一样，但如果一定要使用，他们之间还是有差距的：单引号具有转义功能，而双引号不具有转义功能

@Component
@ConfigurationProperties(prefix = "personbean")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> list;
    private String[][] mulArr;
    private Dog[] dogs;
    private Dog dog;

    public Person() {
    }

    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 getHappy() {
        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> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog[] getDogs() {
        return dogs;
    }

    public void setDogs(Dog[] dogs) {
        this.dogs = dogs;
    }

    public Dog getDog() {
        return dog;
    }

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

    public String[][] getMulArr() {
        return mulArr;
    }

    public void setMulArr(String[][] mulArr) {
        this.mulArr = mulArr;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", happy=" + happy +
                ", birth=" + birth +
                ", maps=" + maps +
                ", list=" + list +
                ", dog=" + dog +
                '}';
    }
}
personbean:
  name: "zzt \n zjm"

双引号会将原本的转义字符按照转义的含义进行输出。

personbean:
  name: 'zzt \n zjm'

单引号做的操作实际上是，为我们的转义字符\前面加上一个\，也就是单引号实际上的内容是zzt \\n zjm。

4.JSR-303校验(转载:https://www.jianshu.com/p/554533f88370)

JSR-303用于判断数据的合法性，若数据不合法，则不会进行注入。

A.导入依赖

        <!--JSR-303校验-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

B.启动校验 @Validated 

@Component
@ConfigurationProperties(prefix = "dogbean")
@Validated
public class Dog {

    @Email(message = "邮件地址不合法！")
    private String name;

    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 +
                '}';
    }
}

C.执行结果

5.SpringBoot多环境切换

        在实际开发中，我们会采用多环境的方式，做到开发和测试分离。

A.properties切换环境

使用 spring.profiles.active 选择要使用的环境：

.

没有激活其他环境时，使用的是application.properties中的环境

使用spring.profiles.active可以激活其他环境，配置文件名为 application-环境名.properties。

B.yaml切换环境

yaml多环境是不需要编写多个文件分别激活的，没有配置spring.config.activate.on-profile的环境就是默认环境。

 

 

 

 

 

WALL-SQ
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot基础
m0_50756791的博客
03-16 193
SpringBoot启动的时候我们可以看到如下内容，这一块其实是可以自定义的哦，而且在 2.X 版本中，它支持 的格式从文本扩展到**banner.txt、banner.jpg、banner.gif、banner.jpeg等等，只需要在resouces**目 录下添加指定命名的文件即可。
tree-sitter-yaml:用于保姆的YAML语法
04-29
面向YAML（ ）语法 安装 npm install tree-sitter-yaml tree-sitter 用法 const Parser = require ( "tree-sitter" ) ; const YAML = require ( "tree-sitter-yaml" ) ; const parser = new Parser ( ) ; parser . ...
pyyaml-include:yaml包括其他yaml
05-08
pyyaml包括 的扩展构造函数：将文件包含到文档中。 安装 pip install pyyaml-include 用法 考虑我们有这样的YAML文件： ├── 0.yml └── include.d ├── 1.yml └── 2.yml 1.yml的内容： name : " 1 " 2.yml的内容： name : " 2 " 要在0.yml包含1.yml和2.yml ，我们应将YamlIncludeConstructor添加到PyYAML的加载器中，然后在0.yaml添加!include标记： import yaml from yamlinclude import YamlIncludeConstructor YamlIncludeConstructor . add_to_loader_class ( loader_class = yaml . Full
yaml文件嵌套
tanruixing的博客
03-04 6822
python的pyyaml包中yaml嵌套还是基于在load中重载一个钩子类，对yaml的value进行解析处理。 具体的看以下代码： #!/usr/bin/python import os.path import yaml class IncludeLoader(yaml.Loader): def __init__(self, *args, **kwargs): ...
YAML配置文件介绍
最新发布
juan9872的博客
05-02 518
YAML配置文件介绍 一、YAML基础 YAML是专门用来写配置文件的语言，非常简洁和强大，使用比json更方便。它实质上是一种通用的数据串行化格式 YAML语法规则： 大小写敏感 使用缩进表示层级关系 缩进时不允许使用Tab键，只允许使用空格 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可 ”#” 表示注释，从这个字符一直到行尾，都会被解析器忽略 在Kubernetes中，只需要知道两种结构类型即可： Lists Maps Map顾名思义指的是字典，即一个Key:Valu
YAML配置文件基本用法总结
MrYushiwen的博客
01-10 5732
一.简介 YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。 它非常适合用来做以数据为中心的配置文件。 二.基本的语法结构 key: value；key：与value之间有空格 大小写敏感 使用缩进表示层级关系 缩进不允许使用tab，只允许空格(但是在idea中可以放心使用tab来进行缩进，目前还没有出现什么问题)
SpringBoot整理
m0_60027772的博客
08-25 1357
/关闭springboot的启动横幅//一键启动springboot}}
python读取yaml文件
大帅的博客
04-18 1862
1.简介 YAML 是 "YAML Ain't a Markup Language"（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。 YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。 YAML 的
3.SpringBoot配置（yaml，多环境，自动配置原理分析）
heaven_dad的博客
07-23 1095
3.SpringBoot配置 ​ 在哪配置？ SpringBoot指定在resources类路径下配置application.yml或application.properties 在里面进行配置 <includes> <include>**/application*.yml</include> <include>**/application*.yaml</include> <include>**/applicatio
第二周第一天的学习笔记-yaml
03-25
第二周第一天的学习笔记_yaml
springboot-demo-helloworld
03-01
核心 POM，包含自动配置支持、日志库和对 YAML 配置文件的支持。 创建 SpringBoot Web 应用 为快速进行开发，推荐你使用IDEA这类开发工具，它将大大提升你学习和开发的效率。 • 选择 Spring Initialize Spring提供...
springboot-basic-demo：SpringBoot基础特性Demo
02-08
SpringBoot控制器坑 spring的请求正文并不支持空细分，空细分的DTO应属于设计上的问题 PropertySource ProperySource这里有一个坑需要注意，yaml的层级关系，spring不会处理。 Spring从机制上只会处理key：value的...
metrics-server yaml文件
02-16
metrics-server yaml文件
深入Spring Boot (四)：YAML属性配置文件使用详解
weixin_34248487的博客
03-05 2525
Spring Boot弱化配置的特性让属性配置文件的使用也更加便捷，它默认支持对application.properties或application.yml属性配置文件处理，即在application.properties或application.yml文件中添加属性配置，可以使用@Value注解将属性值注入到beans中，或使用@ConfigurationProperties注解将属性值绑定到结...
springboot中yml配置文件属性读取
Leisurelyc的博客
11-18 1021
springboot中yml配置文件属性读取 方式一 : 通过Environment获取 yml文件: goto: server: url: http://10.204.4.186:9010 Environment两种使用方式 Autowired注入 @Autowired private Environment env; // ...... String prefix = env...
SpringBoot yaml配置文件
chy1984的博客
03-07 1049
在创建springboot项目时，可以勾选 Developer Tools -> Spring Configuration Processor，或手动添加依赖
SpringBoot学习：yaml配置
weixin_51624761的博客
04-24 4867
1、前言 在之前的ssm框架的学习中，我们一般使用xml以及properties进行配置，可以很方便的配置资源。在SpringBoot的学习中，我们还将会学习到另外一种配置方式，那就是使用yaml进行配置。 2、几种配置方式的区别 xml配置 xml的配置方式使用相当广泛。在原生的JavaWeb阶段，我们用来配置web.xml，在ssm框架的学习中，我们用来配置mybatis-config.xml，Mapper.xml，applicationContext.xml，在Maven，Tomcat…我们随处可
yaml文件里引用yaml文件
lkr
04-16 4578
yaml文件里引用yaml文件
yaml文件的语法及注意事项
热门推荐
zhengxiangwen的专栏
04-11 2万+
yaml的语法： 1、在yaml里面，结构通过缩进来表示，连续的项目（如：数组元素、集合元素）通过减号“-”来表示，map结构里面的键值对（key/value）用冒号“:”来分割。yaml也有用来描述好几行相同结构数据的缩写语法，数组用“[]”包括起来，hash用“{}”来包括。这几乎就是yaml的全部语法了。 bat: website: baidu: h
springboot学习笔记
06-09
好的，我可以和你分享一些关于Spring Boot的学习笔记。 1. Spring Boot是什么？ Spring Boot是一个基于Spring框架的快速开发框架，它能够帮助开发者快速搭建Spring项目，简化了Spring应用开发的繁琐过程，提高了...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值