yaml语法

目录

一、配置文件

application.properties

application.yml

🐟配置文件的作用

二、yaml

1.基本语法

2.数据类型

3.Yaml 对象

⭐yaml与properties对比

三、 给属性赋值的方式

⚪创建实体类

💧原生方式实现对象赋值

🔥使用yaml配置的方式进行注入    

​编辑⚪加上@ConfigurationProperties注解后出现的问题及解决方法

🔥使用properties配置的方式进行注入     

四、@Value 与@ConfigurationProperties的对比

---

一、配置文件

SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的

• application.properties

  • 语法结构 ：key=value

  • （修改默认端口号）

  • 

• application.yml

  • 语法结构 ：key：空格 value

  • 

     

🐟配置文件的作用

修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

二、yaml

YAML_百度百科 (baidu.com)

YAML是"YAML Ain't a Markup Language"（YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言），但为了强调这种语言以数据做为中心，而不是以标记语言为重点，而用反向缩略语重命名。

1.基本语法

1. 大小写敏感
2. 使用缩进表示层级关系
3. 缩进不允许使用tab，只允许空格
4. 缩进的空格数不重要，只要相同层级的元素左对齐即可

2.数据类型

YAML 支持以下几种数据类型：

• 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
• 纯量（scalars）：单个的、不可再分的值（字符串、布尔值、整数、浮点数、Null、时间、日期）

3.Yaml 对象

• 对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。
• 也可以使用 key:{key1: value1, key2: value2, ...}。
• 还可以使用缩进表示层级关系；
• 较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value： 意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]

⭐yaml与properties对比

三、 给属性赋值的方式

⚪创建实体类

Dog类：

package com.zz.springboot02config.pojo;

import org.springframework.stereotype.Component;

@Component
public class Dog {
    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 +
                '}';
    }
}

Person类： 

package com.zz.springboot02config.pojo;

import java.util.Date;
import java.util.List;
import java.util.Map;

@Component
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;

    public Person() {
    }

    public Person(String name, Integer age, Boolean happy, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
        this.name = name;
        this.age = age;
        this.happy = happy;
        this.birth = birth;
        this.maps = maps;
        this.lists = lists;
        this.dog = dog;
    }

    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> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Dog getDog() {
        return dog;
    }

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

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

💧原生方式实现对象赋值

运行测试代码： 

🔥使用yaml配置的方式进行注入    

测试方法： 

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    //@Qualifier 指定具体某一个
    private Person person;

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

在实体类上加上 @ConfigurationProperties注解

/*
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@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;
}

运行结果

⚪加上@ConfigurationProperties注解后出现的问题及解决方法

在pom.xml中添加依赖 

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

🔥使用properties配置的方式进行注入     

在实体类上添加注解，加载指定的配置文件

//加载指定的配置文件
@PropertySource(value = "classpath:application.properties")
public class Person{
    //SPEL表达式取出配置文件的值
    @Value("${name}")
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    //@Qualifier 指定具体某一个
    private Person person;

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

运行结果： 

 

 

四、@Value 与@ConfigurationProperties的对比

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	依次指定
松散绑定（松散语法）	支持	支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

1、@ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加

2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。

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

4、复杂类型封装，yml中可以封装对象 ， 使用value就不支持