1 配置文件

SpringBoot使用一个全局配置文件
- application.properties
- application.yml　
配置文件的作用就是修改SpringBoot的默认值（因为SpringBoot在底层给我们配置好了）。　
配置文件放在src/main/resources目录或者类路径/config下。
.yml是YAML语言的文件，以数据为中心，比JSON、XML等更适合做配置文件

YAML示例如下：

server:
  port :8081

XML的示例如下：

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

2 YAML的语法

2.1 基本语法

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

server:
    port: 8081
    path: /hello

属性和值是大小写敏感的

2.2 值得写法

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

k： v：字面量直接来写
字符串默认不用加单引号或者双引号
""：双引号，不会转义字符串里面的特殊字符
''：单引号，会转义特殊字符，特殊字符最终只是一个普通的字符串输出

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

k: v ：在下一行来写对象的属性和值得关系；注意缩进
    对象还是以k: v的方式
 
比如：
      friends:
        lastName: zhangsan
        age: 20

对象的行内写法
friends: {lastName: zhangsan,age: 20}

数组（List、Set）

用-值表示数组中的一个元素
pets:
    - cat
    - dog
    - pig

数组的行内写法
pets: [cat,dog,pig]

2.3 配置文件注入

2.3.1 .yml配置文件注入

在pom.xml文件中增加如下的依赖

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

application.yml

person:
  lastName: zhangsan
  age: 20
  boss: false
  birth: 2018/4/26
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - wangwu
    - zhaoliu
    - tianqi
    - wangba
  dog:
    name: 小狗
    age: 2

Dog.java

package com.example.demo.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 +
                '}';
    }
}

Person.java

package com.example.demo.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功能
 */
@ConfigurationProperties(prefix = "person")
@Component
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

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

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

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

2.3.2 .properties配置文件注入

person.last-name=张三
person.age=20
person.boss=false
person.birth=2018/4/26
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=dog
person.dog.age=15

2.4 @Value和@ConfigurationProperties注解的区别

@Value
- 功能：一个个的指定
- 松散语法：不支持
- SPEL：支持　
- JSR303数据校验：不支持　
- 复杂类型封装：不支持
@ConfigurationProperties
- 功能：批量注入配置文件中的属性
- 松散语法：支持
- SPEL：不支持
- JSR303数据校验：支持　　
- 复杂类型封装：支持

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value注解；
如果说，我们专门编写一个javabean来和配置文件进行映射，我们使用@ConfigurationProperties注解；

2.5 配置文件数据校验

application.yml

person:
  lastName: zhangsan
  age: 20
  boss: false
  birth: 2018/4/26
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - wangwu
    - zhaoliu
    - tianqi
    - wangba
  dog:
    name: 小狗
    age: 2
  email: [email protected]

Dog.java

package com.example.demo.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 +
                '}';
    }
}

Person.java

package com.example.demo.bean;

import org.hibernate.validator.constraints.Email;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

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

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties 告诉SpringBoot将本类中的所有属性和配置文件中的配置进行绑定
 *  prefix 配置文件中的那个属性进行一一映射
 *
 *  只有这个组件是容器中的组件，容器才能提供@ConfigurationProperties功能
 */
@ConfigurationProperties(prefix = "person")
@Component
@Validated
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    @Email
    private String email;

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

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

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

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

测试

package com.example.demo;

import com.example.demo.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 DemoApplicationTests {

    @Autowired
    private Person person;

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

}

SpringBoot （二）

1 配置文件

2 YAML的语法

2.1 基本语法

2.2 值得写法

2.3 配置文件注入

2.3.1 .yml配置文件注入

2.3.2 .properties配置文件注入

2.4 @Value和@ConfigurationProperties注解的区别

2.5 配置文件数据校验

猜你喜欢