一些Java小知识点 - SpringBoot配置优先级梳理

最新推荐文章于 2025-03-10 08:39:36 发布

原创最新推荐文章于 2025-03-10 08:39:36 发布 · 1k 阅读

16 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring boot #spring #Spring变量查找顺序 #外部配置优先级 #系统变量 #Java环境变量优先级

1、前言

在某些SpringBoot项目中，有时会看到在配置文件中使用 ${xxx} 取值的情况，但是这些 xxx 变量在哪里进行设置呢？比如下面的端口号使用server.port=${PORT} 。

2、官网说明

在Spring官网上有针对性的介绍：Core Features (spring.io) ，下面是官网上列出的15中设置外部属性配置的方式。

上图列出了有15中方式设置外部属性变量的方式，从上到下优先级依此增加（即：如果通过多种方式设置了同一个外部属性变量，则后面设置的值会覆盖前面的）。本篇博客主要介绍上图中标记的6中方式，这6种设置方式也是实际工作中最为常用的方式。介绍的方向是：

（1）如何通过不同的方式设置外部的属性变量；

（2）通过实验体现优先级的效果。

3、几种设置方式

为了进行实验，首先要新建一个最普通的SpringBoot项目。此处说明一些内容，开始我使用的是SpringBoot 2.5.0 （配合jdk1.8）版本，在测试过程中发现此版本并不是按照官网给定的优先级去查找外部配置信息（可能此版本有BUG），然后我换了高版本的SpringBoot 3.3.4 (JDK也要换成17)再测试，发现优先级加载正确了。所以如果你的项目使用的是较低版本的SpringBoot，可能会存在一些问题。
项目的pom文件如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.4</version>
        <relativePath/>
    </parent>
    <groupId>com.shg</groupId>
    <artifactId>Externalized_configuration</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>Externalized_configuration</name>
    <description>Externalized_configuration</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

项目的目录结构如下：

3.1、默认设置的属性变量

在项目的启动类中，通过设置默认的属性变量的方式如下:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

@SpringBootApplication
public class ExternalizedConfigurationApplication {

    public static void main(String[] args) {
        
        // SpringApplication.run(ExternalizedConfigurationApplication.class, args);

        SpringApplication app = new SpringApplication(ExternalizedConfigurationApplication.class);
        Map<String, Object> defaultProperties = new HashMap<>();
        defaultProperties.put("PORT", 8081);
        app.setDefaultProperties(defaultProperties);
        app.run(args);
    }

}

在项目的 application.properties 配置文件中使用如下方式取得变量PORT的值，如下：

server.port=${PORT}

启动项目，发现项目的端口号是8081

3.2、通过@PropertySource设置的属性变量

在项目的resources目录下，新建一个port.properties属性文件，然后在其中配置变量信息：

PORT=8082

在标注有 @Configurations的配置类上，通过@PropertySource引入外部的配置文件，因为主启动类也是一个标注了@Configuration的配置类，所以就直接在主启动类上标注如下信息：

@PropertySource(value = {"classpath:port.properties"})

启动项目（注意：保留之前启动类里面的8081配置），发现端口号变成了8082，这就说明高优先级的配置信息覆盖了低优先级的配置。即：3.2优先级覆盖了上面的3.1优先级

3.3、通过配置文件设置的属性变量

在项目的配置文件application.properties文件里面配置PORT=8083。注意：此处我们暂不讨论一个项目中同时存在application.properties和application.yml这两种配置文件的情况。此处我们先假设项目中使用的只有一种配置文件：application.properties，其中的配置信息如下：

启动项目（注意：保留之前启动类里面的8081配置和port.properties里面的8082配置信息），发现端口号变成了8083，说明3.3的优先级覆盖了上面的3.2优先级。如下图：