Spring boot application.yaml 配置文件语法介绍和单元测试教程

Spring boot application.yaml 配置文件语法介绍和单元测试教程

前言:

各位在学习java web开发的同学应该都用过spring boot 开发 一定配置过application.yaml这个文件 今天我这边简单分享一下application.yaml配置文件编写的语法和单元测试 好了废话不多说，我们正式开始。

1具体实现：

我们创建好spring boot项目之后 需要在reources 目录下创建一个 application.yaml文件

2、YAML语法：

1、基本语法

k:(空格)v：表示一对键值对（空格必须有）；以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:  
  port: 8081 
  path: /hello

属性和值也是大小写敏感；

2、值的写法字面量：普通的值（数字，字符串，布尔）

k:v：字面直接来写；字符串默认不用加上单引号或者双引号；""：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思name:“zhangsan\nlisi”：输出；zhangsan换行lisi’’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据name:‘zhangsan\nlisi’：输出；zhangsan\nlisi

对象、Map（属性和值）（键值对）：

k:v：在下一行来写对象的属性和值的关系；注意缩进对象还是k:v的方式

friends:      
         lastName: zhangsan
         age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

####数组（List、Set）：
用-值表示数组中的一个元素

pets: 
‐ cat  
‐ dog 
 ‐ pig

行内写法

pets: [cat,dog,pig]

3、配置文件值注入

配置文件

person: 
   lastName: hello 
   age: 18   
  boss: false    
  birth: 2017/12/12  
  maps: {k1: v1,k2: 12}  
  lists:      
    ‐ lisi      
    ‐ zhaoliu  
  dog:    
   name: 小狗    
   age: 12

JavaBean:

package com.atguigu.springboot.bean;
import org.hibernate.validator.constraints.Email;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Null;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
//@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

   //lastName必须是邮箱格式
   // @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

    private Date birth;
    //@Value("${person.maps}")
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

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

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Boolean getBoss() {
        return boss;
    }

    public void setBoss(Boolean boss) {
        this.boss = boss;
    }

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

Dog Bean类:

package com.mavenprojectdemo.bean;

public class Dog {
   private  String name;
   private  Integer age;

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", 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;
    }
}

导入配置文件处理器

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

在pom.xml文件添加

配置编写完成我们在test 包下面的 MavenprojectdemoApplicationTests 类中进行单元测试

我们需引入@RunWith(SpringRunner.class) 注解

package com.mavenprojectdemo;

import com.mavenprojectdemo.bean.Person;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
class MavenprojectdemoApplicationTests {
    @Autowired
    Person person;
    @Test
    void contextLoads() {
        System.out.println(person);
    }

}

我们通过 @Autowired 注解把Person 类注入 我们拿到person对象实例我们在contextLoads （） 方法中打印

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

    }

我们鼠标选中contextLoads 方法左边绿色三角形箭头右键 运行run

然后我们在控制台看到打印的日志 把刚才在 application.yaml 配置文件配置的person类里面的值全部都打印出来了

如上图我们到了我们application.yaml 配置文件中的值全部都在控制台中看到了
到此 spring boot application.yaml配置文件编写的语法就讲解完了。
项目地址：https://gitee.com/qiuyu123/spring-boot-application.yaml.git

最后总结 :

这个application.yaml 配合文件的编写在springboot中比较重要 需要注意的是缩进符号对其的问题 所以我们要学好他的正确用法 方便我们以后在实战项目中的配置。文章有不足和错误之处，希望大家能指正,有兴趣的同学可以在博客底下留言 或者加我私人QQ/微信 大家一起学习交流 （QQ/微信）：1693891473

QQ交流群：