Spring Boot全局配置文件详解

一. 全局配置文件概述及优先级

全局配置文件能够对一些默认配置值进行修改及自定义配置。

Spring Boot 使用一个 application.properties 或者 application.yaml 的文件作为全局配置文件

也可以从 ConfigFileApplicationListener 这类便可看出，其中 DEFAULT_SEARCH_LOCATIONS 属性设置了加载的目录：

翻译成文件系统：

–file: ./config/

–file: ./

–classpath: /config/

–classpath: /

翻译成语言如下（ 按照优先级从高到低的顺序 ）：

1. 先去项目根目录找 config 文件夹下找配置文件件

2. 再去根目录下找配置文件

3. 去 resources 下找 cofnig 文件夹下找配置文件

4. 去 resources 下找配置文件

 

 

整个设计非常巧妙。 SpringBoot 会从这四个位置全部加载主配置文件，如果高优先级中配置文件属性与低优先级配置文件不冲突的属性，则会共同存在 — 互补配置 。

SpringBoot 会加载全部主配置文件；互补配置；

备注：

这里说的配置文件，都还是项目里面。最终都会被打进 jar 包里面的，需要注意。

1 、如果同一个目录下，有 application.yml 也有 application.properties ，默认先读取

application.properties 。

2 、如果同一个配置属性，在多个配置文件都配置了，默认使用第 1 个读取到的，后面读取的不覆盖前面读取到的。

3 、创建 SpringBoot 项目时，一般的配置文件放置在 “ 项目的 resources 目录下 ”

如果我们的配置文件名字不叫 application.properties 或者 application.yml ，可以通过以下参数来指定

配置文件的名字， myproject 是配置文件名

$ java -jar myproject.jar --spring .config .name = myproject

我们同时也可以指定其他位置的配置文件来生效

指定配置文件和默认加载的这些配置文件共同起作用形成互补配置。

java -jar run-0.0.1-SNAPSHOT.jar --

spring .config .location = D:/application.properties

接下来，将针对这两种全局配置文件 application.properties 及 application.yml 进行讲解 ：

知识点补充！

Spring Boot 2.4 改进了处理 application.properties 和 application.yml 配置文件的方式，

如果是 2.4.0 之前版本，优先级 properties>yaml

但是如果是 2.4.0 的版本，优先级 yaml>properties

如果想继续使用 Spring Boot 2.3 的配置逻辑，也可以通过在 application.properties 或者

application.yml 配置文件中添加以下参数：

spring.config.use-legacy-processing = true

二. application.properties配置文件

使用 Spring Initializr 方式构建 Spring Boot 项目时，会在 resource 目录下自动生成一个空的

application.properties 文件， Spring Boot 项目启动时会自动加载 application.properties 文件。

我们可以在 application.properties 文件中定义 Spring Boot 项目的相关属性，当然，这些相关属性可以是系统属性、环境变量、命令参数等信息，也可以是自定义配置文件名称和位置

server.port = 8081

spring.datasource.driver-class-name = com.mysql.jdbc.Driver

spring.config.name = application

接下来，通过一个案例对 Spring Boot 项目中 application.properties 配置文件的具体使用进行讲解

演示：

（1 ）先在项目的 com.lagou 包下创建一个 pojo 包，并在该包下创建两个实体类 Pet 和 Person

package com.lagou.pojo;

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

import java.util.Arrays;
import java.util.List;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "person")   //实现批量注入（set方法）
public class Person {

    private int id;            //id
    private String name;      //名称
    private List hobby;       //爱好
    private String[] family; //家庭成员
    private Map map;
    private Pet pet;          //宠物

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public List getHobby() {
        return hobby;
    }

    public void setHobby(List hobby) {
        this.hobby = hobby;
    }

    public String[] getFamily() {
        return family;
    }

    public void setFamily(String[] family) {
        this.family = family;
    }

    public Map getMap() {
        return map;
    }

    public void setMap(Map map) {
        this.map = map;
    }

    public Pet getPet() {
        return pet;
    }

    public void setPet(Pet pet) {
        this.pet = pet;
    }

    @Override
    public String toString() {
        return "Person{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", hobby=" + hobby +
                ", family=" + Arrays.toString(family) +
                ", map=" + map +
                ", pet=" + pet +
                '}';
    }
}

package com.lagou.pojo;

public class Pet {

    // 类型
    private String type;
    // 名称
    private String name;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Pet{" +
                "type='" + type + '\'' +
                ", name='" + name + '\'' +
                '}';
    }
}

@ConfigurationProperties(prefix = "person") 注解的作用是将配置文件中以 person 开头的属性值通过setXX() 方法注入到实体类对应属性中

@Component 注解的作用是将当前注入属性值的 Person 类对象作为 Bean 组件放到 Spring 容器中，只有这样才能被 @ConfigurationProperties 注解进行赋值

（2 ）打开项目的 resources 目录下的 application.properties 配置文件，在该配置文件中编写需要对

Person 类设置的配置属性

 

编写 application.properties 配置文件时，由于要配置的 Person 对象属性是我们自定义的， Spring

Boot 无法自动识别，所以不会有任何书写提示。在实际开发中，为了出现代码提示的效果来方便配置，在使用 @ConfigurationProperties 注解进行配置文件属性值注入时，可以在 pom.xml 文件中添加一个 Spring Boot 提供的配置处理器依赖 :

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

在 pom.xml 中添加上述配置依赖后，还需要重新运行项目启动类或者使用 “Ctrl+F9” 快捷键（即

Build Project ）重构当前 Spring Boot 项目方可生效

（3 ）查看 application.properties 配置文件是否正确，同时查看属性配置效果，打开通过 IDEA 工具创建的项目测试类，在该测试类中引入 Person 实体类 Bean ，并进行输出测试

@RunWith(SpringRunner.class)
@SpringBootTest
class Springboot01DemoApplicationTests {

    @Autowired
    private Person person;


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

打印结果：

可以看出，测试方法 configurationTest() 运行成功，同时正确打印出了 Person 实体类对象。至此，说明application.properties 配置文件属性配置正确，并通过相关注解自动完成了属性注入

三. application.yaml配置文件

YAML 文件格式是 Spring Boot 支持的一种 JSON 超集文件格式，以数据为中心，比 properties 、 xml 等更适合做配置文件

yml 和 xml 相比，少了一些结构化的代码，使数据更直接，一目了然

l 相比 properties 文件更简洁

 YAML文件的扩展名可以使用.yml或者.yaml。

application.yml 文件使用 “key: （空格） value” 格式配置属性，使用缩进控制层级关系。

这里，针对不同数据类型的属性值，介绍一下 YAML

（1）value值为普通数据类型（例如数字、字符串、布尔等）

当 YAML 配置文件中配置的属性值为普通数据类型时，可以直接配置对应的属性值，同时对于字符

串类型的属性值，不需要额外添加引号，示例代码如下

server :

    port : 8080

    servlet :

        context-path : /hello

（2）value值为数组和单列集合

当 YAML 配置文件中配置的属性值为数组或单列集合类型时，主要有两种书写方式：缩进式写法和行内式写法。

其中，缩进式写法还有两种表示形式，示例代码如下

person :

    hobby :

       - play

       - read

       - sleep

或者使用如下示例形式

person :

    hobby :

       play,

       read,

       sleep

上述代码中，在 YAML 配置文件中通过两种缩进式写法对 person 对象的单列集合（或数组）类型的爱好hobby 赋值为 play 、 read 和 sleep 。其中一种形式为 “- （空格）属性值 ” ，另一种形式为多个属性值之前 加英文逗号分隔（注意，最后一个属性值后不要加逗号）。

person :

    hobby : [ play , read , sleep ]

通过上述示例对比发现， YAML 配置文件的行内式写法更加简明、方便。另外，包含属性值的中括

号 “[]” 还可以进一步省略，在进行属性赋值时，程序会自动匹配和校对

（3）value值为Map集合和对象

当 YAML 配置文件中配置的属性值为 Map 集合或对象类型时， YAML 配置文件格式同样可以分为两种书写

方式：缩进式写法和行内式写法。

其中，缩进式写法的示例代码如下

person :

   map :

     k1 : v1

     k2 : v2

对应的行内式写法示例代码如下

person :

    map : { k1 : v1 , k2 : v2 }

在 YAML 配置文件中，配置的属性值为 Map 集合或对象类型时，缩进式写法的形式按照 YAML 文件格式编写即可，而行内式写法的属性值要用大括号 “{}” 包含。

接下来，在 Properties 配置文件演示案例基础上，通过配置 application.yaml 配置文件对 Person 对象进行赋值，具体使用如下

在项目的 resources 目录下，新建一个 application.yaml 配置文件，在该配置文件中编写为 Person 类设置的配置属性

person:
  id: 2
  name: lucy
  hobby: [吃饭,睡觉,打王者]
  family: [father,mother]
  map: {k1: v1,k2: v2}
  pet: {type: pig,name: 佩奇}