Kite的学习历程之SpringBoot中的配置文件

Kite学习框架的第十五天

1. 配置文件

注意： SpringBoot中的yml配置文件SpringBoot使用一个全局的配置文件，配置文件名是固定的；

application.properties
application.yml
配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好；

YAML（YAML Ain’t Markup Language）

​ YAML A Markup Language：是一个标记语言

​ YAML isn’t Markup Language：不是一个标记语言；

标记语言：

​ 以前的配置文件；大多都使用的是 xxxx.xml文件；

​ YAML：以数据为中心，比json、xml等更适合做配置文件；

yml配置文件的例子

server:
  port: 8081
​

xml配置文件的例子

<server>
	<port>8081</port>
</server>

2、YAML语法：

1、基本语法

k:(空格)v：表示一对键值对（空格必须有）；

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
port: 8081
path: /hello
属性和值也是大小写敏感；

2、值的写法

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

​ k: v：字面直接来写；

​ 字符串默认不用加上单引号或者双引号；

​ “”：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

​ name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi

​ ‘’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

​ name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

对象、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. 配置演示

3.1 先创建一个person类，以及dog类

person类

package cn.kitey.demo02_config.bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

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

/**
 * 将配置文件中配置的每一个属性，都映射到组件中
 * ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中的相关配置进行绑定
 * prefix: 将该属性下的属性进行一一映射
 *
 * 只有这个组件时容器中的组件，才能提供@ConfigurationProperties功能
 */

@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String, Object> maps;
    private List<Object> lists;

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

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

package cn.kitey.demo02_config.bean;

public class Dog {
    private String name;
    private Integer 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 +
                '}';
    }
}

3.2 导入文件之处理器依赖

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

3.2 创建一个appliaction.yml的配置文件进行数据注入

person:
  age: 19
  boss: true
  birth: 2017/12/22
  maps: {key1: value1, key2: value2}
  lists:
    - list1
    - list2
    - list3
  dog:
    name: 小白
    age: 5
  name: kite

3.3 在person上添加注解

/**

• 将配置文件中配置的每一个属性，都映射到组件中
• ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中的相关配置进行绑定
• prefix: 将该属性下的属性进行一一映射
• 只有这个组件时容器中的组件，才能提供@ConfigurationProperties功能
  */
  @Component
  @ConfigurationProperties(prefix = “person”)

3.4 在test类中进行测试

这里我们采用了Autowired自动注入person数据

package cn.kitey.demo02_config;

import cn.kitey.demo02_config.bean.Person;
import org.junit.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;


/**
 * SpringBoot单元测试
 *
 * 可以在测试期间很方便的类似编码一样的进行自动注入等操作
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class Demo02ConfigApplicationTests {

    @Autowired
    Person person;

    @Test
    public void contextLoads() {

        System.out.println(person);
    }

}

运行结果截图