学Springboot还不会yaml？看这一篇就够了！带你掌握yaml

程序员文章站 2022-03-04 08:45:56

...

Yaml基本语法

简介

YAML 是 “YAML Ain’t Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。

非常适合用来做以数据为中心的配置文件。

基本语法

大小写敏感
使用缩进代表层级关系
缩进不能使用tab，只允许使用空格（tips：IDEA貌似可以自动转化，所以我们在用IDEA时可以放心大胆的用）
缩进的空格数不重要，只要相同层级的元素左对齐就可以
‘#’标识yaml中的注释

数据类型

纯量：单个，不可划分的值（例如：String，Double，boolean等）
对象：键值对的集合（例如：我们自定义的实体类，map，set）
数组：一组按次序排列的值（例如：list，一维数组等）

需要注意的点

对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。
较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value，类似于Map<List,List>
```
?
	-key1
	-key2
:
	-value1
	-value2
```
以 - 开头的行表示构成一个数组

最佳实践

springboot中推荐使用yaml文件进行配置，本文就拿springboot项目做示例，新建一个SpringBoot项目

Person实体类

@Data//Lombok插件导入，代表自动生成get，set方法
@Component//代表这是一个组件，将其注册入文件中
@ConfigurationProperties(prefix = "person")//表示在配置文件中自动匹配person后的value
public class Person {
    private String userName;
    private Boolean boss;
    private Date birth;
    private Integer age;
    private Pet pet;
    private String[] interests;
    private List<String> animal;
    private Map<String, Object> score;
    private Set<Double> salarys;
    private Map<String, List<Pet>> allPets;
}

Pet实体类

@Data
public class Pet {
  private String name;
  private Double weight;
}

application.yml（yml和yaml后缀的springboot都能识别）

person:
  userName: 张三
  boss: false
  birth: 2021/1/1
  age: 12
  pet:
    name: 佩奇
    weight: 150.5
  interests: [唱,跳,rap,篮球]
  animal:
    - a
    - b
  score:
    english:
      first: 30
      secord: 40
      third: 50
    math: [130,140,150]
    chinese: {first: 128,second: 136}
  salarys: [900,9000,90000]
  allPents:
    sick:
      - {name: tom,weight: 90}
      - {name: jerry,weight: 40}
    health: [{name: tom1,weight: 90},{name: tom2,weight: 90}]

Controller

@RestController
public class HelloController {
    @Autowired//自动装配person，说白了就是把已经赋值的person给传进来
    Person person;

    @RequestMapping("/person")
    public Person person(){
        return person;
    }
}

访问localhost:8080/person:

{"userName":"张三","boss":false,"birth":"2020-12-31T16:00:00.000+00:00","age":12,"pet":{"name":"佩奇","weight":150.5},"interests":["唱","跳","rap","篮球"],"animal":["a","b"],"score":{"english":{"first":30,"secord":40,"third":50},"math":{"0":130,"1":140,"2":150},"chinese":{"first":128,"second":136}},"salarys":[900.0,9000.0,90000.0],"allPets":{"sick":[{"name":"tom","weight":90.0},{"name":"jerry","weight":40.0}],"health":[{"name":"tom1","weight":90.0},{"name":"tom2","weight":90.0}]}}

SpringBoot中yaml的使用

在我们编写yaml的时候，没有提示是不是让人很头疼呢？别担心，springboot也帮我们想到了，我们只需要引入一个依赖就可以在编写yaml文件时写出变量名的前几个单词就能帮我直接提示出整个变量名

导入依赖

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

可是在项目发布的时候我们可不能加载这个进去，这只是方便加快我们编写时的速度，并不影响最终效果，所以打包的时候没有必要加上这个无用的东西，免得启动过慢，于是我们加上这一段

 <build>
        <plugins>
            <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>
        </plugins>
    </build>