研究一下springboot配置文件加载顺序

在使用springboot进行项目开发中，我们一般会把项目中的配置信息写到配置文件中方便程序读取，也方便我们修改，springboot的配置文件是application.yml或者application.properties。下面我们研究一下springboot项目加载配置文件的顺序是什么：
首先我们创建一个springboot项目，pom.xml中的配置：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.xingo.test</groupId>
    <artifactId>spring-test</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.target>1.8</maven.compiler.target>
        <maven.compiler.source>1.8</maven.compiler.source>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

写一个controller获取配置文件中的值：

package org.xingo.test.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

/**
 * @author xingo
 * @date 2021/2/10
 */
@RestController
@RequestMapping("/test")
public class TestController {

    @Value("${testVal}")
    private String testValue;

    /**
     * 获取配置文件中的配置值：testVal
     * @return
     */
    @GetMapping("/value")
    public Map<String, String> testValue() {
        Map<String, String> map = new HashMap<>();
        map.put("test-value", testValue);

        System.out.println(testValue);

        return map;
    }
}

（1）当项目中同时存在application.yml和application.properties时（当然在真正项目中大家也不会做这种无聊的事情），application.properties中的配置信息会覆盖application.yml中的配置信息：

在application.yml中的配置信息：

server:
  port: 8080
spring:
  application:
    name: spring-test
testVal: value-1

在application.properties中的配置信息：

server.port=8080
spring.application.name=spring-test
testVal=value-2

准备就绪，在浏览器中访问项目，查看返回结果：

可见项目中读取到的值是application.properties中的配置。

（2）使用springboot框架，大多都是将项目打包成jar包部署上线，这样的话如果我们要设置配置文件中的值就必须要在打包前设置好，这样的话不是很方便，springboot是允许我们在打包后将配置文件放在jar包目录下，这样我们就可以做到线上线下配置文件分开来；配置文件可以放在jar同目录下，也可以放在同目录下的config目录下，如果同时存在着两个配置文件，config目录下的配置文件会覆盖jar同目录下的配置文件：

jar包同目录下的配置文件：

server:
  port: 8080
spring:
  application:
    name: spring-test
testVal: value-3

jar包同目录下config目录中的配置文件：

server:
  port: 8080
spring:
  application:
    name: spring-test
testVal: value-4

同样发送请求：

config目录下的配置中的值覆盖了jar目录下的配置文件值，同样，properties会覆盖同优先级的yml配置文件。
我想这种配置方式的使用场景更多用于发布的公开项目，比如我们打包好jar包发布出去，使用该项目的人需要按照真实情况修改配置信息（如：端口号，数据库配置等），修改配置时不必打开我们的jar包，而是将配置信息修改好放到他们的jar目录下就可以了。

（3）其实在我开发项目过程中，一般不会使用上面的方式进行配置，我更多的是分别设置不同后缀的配置文件，然后在项目启动时通过环境变量指定使用哪个配置文件。
我们稍微修改一下上面的项目，将application.yml拆分为三个，如图：

application-dev.yml配置信息：

server:
  port: 8080
spring:
  application:
    name: spring-test
testVal: value-dev

application-prod.yml配置信息：

server:
  port: 8080
spring:
  application:
    name: spring-test
testVal: value-prod

application-test.yml配置信息：

server:
  port: 8080
spring:
  application:
    name: spring-test
testVal: value-test

现在启动项目，指定使用dev结尾的配置文件：

java -Dspring.profiles.active=dev -jar spring-test-1.0-SNAPSHOT.jar

访问项目，可见使用了dev结尾的配置信息：

本文通过springboot配置文件展开了探讨，以及在项目开发中使用配置文件的方式；在同一级目录下，application.properties的配置信息会覆盖application.yml的配置信息；不同优先级覆盖顺序是：jar包config目录下application.yml > jar包目录下application.yml > 项目resource目录下application.yml，同一优先级层次下application.properties覆盖application.yml文件。但是更多时候我们不使用这种优先级关系，而是通过将application.yml配置文件设置为不同的后缀名进行区分，启动时通过指定环境变量： -Dspring.profiles.active=dev 告诉springboot使用哪个配置文件。