Spring-Boot 配置文件

Spring Boot简化了XML配置，但还是需要配置一些基本的配置，如数据库连接、tomcat端口等。而SpringBoot提供了2种配置文件的使用。

一种是properties配置文件，一种是YAML简称YML配置文件。

点击进入官方配置API文档说明 (opens new window)

Properties配置文件

在SpringBoot中，默认读取application.properties配置文件。

该配置文件是SpringBoot的全局配置文件。

注意：配置文件的名称必须是application.properties,这是官方约定的。

具体配置节点的解释可查看官方文档。

YAML简称YML配置文件

在SpringBoot中，配置文件支持使用YAML进行全局配置.

配置文件名必须为application.yml

1.什么是YAML

YAML是YAML Ain't a Markup

yaml是专门用来写配置文件的语言。使用yaml来写配置文件扩展性比较强而且十分方便。spring boot支持使用yaml语言来写配置文件，使用snakeyaml库来读取配置文件。spring boot关于yaml详细用法可以参考官方文档。 YML又被称为“やめる”（雅麦噜）文件，

下面是三种格式的配置文件的对比。当然，在数据量比较少的时候感觉不明显，但是在数据量大的时候，YML就有明显的优势。因为YML可以省略大量的前缀。

YML：

server:
  port:8080
  url:192.168.1.1

XML：

<server>
      <port>8080</port>
      <url>192.168.1.1</url>
</server>

.properties:

server.port=8080
server.url=192.168.1.1

2.YML基本语法

YML是一个大小写以及空格敏感的语言。以空格的缩进来控制层级关系。空格的个数不重要，只要对齐就表示在同一个层级。

语法约定

1. 层级关系用缩进表示，相同的缩进表示的层级关系相同。

2. 缩进只能使用空格，不能使用tab键。

3. 冒号:后必须加上空格在书写值

如下：

server: 
  port: 80

语法案例

普通值：

字符串默认不用加引号

双引号：不会转义特殊字符

name:"test \n test2"
输出:
test
test2

单引号：会转义特殊字符

name:'test \n test2'
输出：test \n test2

对象(两种方式)

user:
  username: 张三
  password: 123456

user: { username: 张三, password: 123456}

数组(List Set)

user
 - zhangsan
 - lisi
 - wangwu

user: {zhangsan,lisi,wangwu}

3.SpringBoot案例

创建application.yml:

person:
  lastName: zhangsan
  age: 18
  boss: false
  birth: 2018/05/04
  map: {k1: v1,k2: v2}
  list:
    - lisi
    - good
  dog:
    name: moggy
    age: 2

创建Person类:

/**
 * 这个类文件中的属性是配置文件中的设定
 */
@Component
@ConfigurationProperties(prefix = "person")
//需要使用以上两个注解，person可以替换成你配置文件中的名字。
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;

    @Override
    public String toString() {
        return "Person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", map=" + map +
                ", list=" + list +
                ", 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> getMap() {
        return map;
    }

    public void setMap(Map<String, Object> map) {
        this.map = map;
    }

    public List<Object> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog getDog() {
        return dog;
    }

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

Dog类随意定义，这里就不贴代码了。

建立测试类：

/**
 * SpringBoot单元测试
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootConfigApplication {
    @Autowired
    Person person;

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

这里person类就通过YML文件注入了

4.运行测试结果

运行后可以看到person输出内容