yaml的基本用法

1. 简介

YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 的配置文件后缀为 .yml，如：runoob.yml 。

1.1 基本语法

• key: value；kv之间有空格
• 大小写敏感
• 使用缩进表示层级关系
• 缩进不允许使用tab，只允许空格
• 缩进的空格数不重要，只要相同层级的元素左对齐即可
• '#'表示注释
• 字符串无需加引号，如果要加，’'与""表示字符串内容 会被 - 转义/不转义

1.2 数据类型

• 字面量：单个的、不可再分的值。date、boolean、string、number、null

k: v

• 对象：键值对的集合。map、hash、set、object

行内写法：  k: {k1:v1,k2:v2,k3:v3}
#或
k: 
  k1: v1
  k2: v2
  k3: v3

• 数组：一组按次序排列的值。array、list、queue

行内写法：  k: [v1,v2,v3]

#或者

k:
 - v1
 - v2
 - v3

1.3 使用案例

@Component
@ConfigurationProperties(prefix = "person")
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
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;
}

单引号会将\n作为字符参数
双引号会将\n 作为换行输出
双引号不会转义 单引号回转义

person:
  userName: 张三
# 单引号会将\n作为字符参数  双引号会将\n 作为换行输出
# 双引号不会转义  单引号回转义
  boss: true
  birth: 2019/12/9
  age: 18
  #interests[篮球,足球,羽毛球,乒乓球]
  interests:
    - 篮球
    - 足球
    - 羽毛球
    - 乒乓球
  animal: [阿猫,阿狗,啊啊]
#  score:
#    英语: 80
#    数学: 90
#    体育: 90
  score: {英语:80,math:90,tiyu:40}
  salarys:
    - 9999.98
    - 999.99
    - 9999.999
  pet:
    name: 小黄
    weight: 99.99
  allPets:
    sick:
      - {name: 小黄,weight: 99}
      - {name: 小白,weight: 99}
      - {name: 小绿,weight: 99}
    health:
      - {name: 小红,weight: 99}
      - {name: 小粉,weight: 99}
      - {name: 小小,weight: 99}

//controller

@RestController
public class HelloController {

    @Autowired
    Person person;
    @RequestMapping("hello")
    public Person getPerson(){
        return person;
    }
}

结果：

1.4 提示功能

<!--yml的提示jar包类-->
 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

  <!--为了打包程序的时候将yml的提示jar包不进行打包，对程序无影响-->
 <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>