SpringBoot 如何将配置文件挂到 jar 包外面？

Posted 2023-04-08 ACGkaka_

目录

• • 一、SpringBoot 指定配置文件路径：
  • • 1）使用命令行参数：
    • 2）使用环境变量：
    • 3）使用外部配置文件：
  • 二、SpringBoot 配置文件生效的优先级排序：

一、SpringBoot 指定配置文件路径：

在 SpringBoot 中，可以将配置文件放在 jar 包外面，这样可以方便地修改配置而不需要重新打包和部署。

下面是指定配置文件目录的 几 种方法： （按生效优先级从高到低排序）

1）使用命令行参数：

在启动应用程序时，可以使用 --spring.config.location 或 -Dspring.config.location 命令行参数来指定配置文件的路径，例如：（config 后面的 / 不可省略）

java -jar test.jar --spring.config.location=/opt/app/config/

补充：FHS将/opt定义为 “为安装附加应用软件包而保留”。所以这里选择 /opt 文件夹来存放应用程序的配置文件。

2）使用环境变量：

可以设置 SPRING_CONFIG_LOCATION 环境变量来指定配置文件的路径，例如：

export SPRING_CONFIG_LOCATION=/opt/app/config/
java -jar test.jar

3）使用外部配置文件：

• 方法一： 在应用程序（jar包）启动命令执行目录下 创建一个名为 config 的文件夹，然后将配置文件放在该文件夹中。

• 方法二： 在应用程序（jar包）同级目录下 创建一个名为 config 的文件夹，然后将配置文件放在该文件夹中。在代码的配置文件 application.properties 或 application.yml 中添加以下行：

spring.config.name=application
spring.config.location=classpath:/,file:./config/

• 方法三： 在应用程序（jar包）同级目录下 直接放 properties 或 yml 配置文件。

• 方法四： 在应用程序（jar包）内部的 classpath 的 同级目录下，创建 config 文件夹，然后放 properties 或 yml 配置文件。

• 方法五： 在应用程序（jar包）内部的 classpath 的 同级目录下，然后直接放 properties 或 yml 配置文件。

注意：以上方法可以组合使用，例如，可以在命令行参数和环境变量中同时指定配置文件的路径，执行时命令行参数的优先级最高。

二、SpringBoot 配置文件生效的优先级排序：

1. java -jar 命令行中，通过 --spring.config.location 参数指定的方式优先级最高。

2. 设置 SPRING_CONFIG_LOCATION 环境变量来指定配置文件的路径是次优先级。

3. 在执行 java -jar 命令同级目录下的 config 文件夹是第三优先级。

   注意：如果 java -jar 命令不是在项目 jar 包 同级目录执行的话，在项目 jar 包同级目录下的 config 文件夹是不生效的。

4. 项目 jar 包中 properties 或 yml 文件中指定 spring.config.location 配置文件夹是第四优先级。

5. 项目 jar 包同级下直接放 properties 文件是第五优先级，直接把配置文件放到 jar 包的同级目录。

6. 项目内部的 classpath 同级 config 文件夹是第六优先级，在 classpath 下建一个 config 文件夹，然后把配置文件放进去。

7. 项目内部的 classpath 同级放 properties 文件是最低优先级，是在 classpath 下直接放配置文件。

SpringBoot 默认是优先读取java -jar 命令同级目录下的一个 config/application.properties 文件的。

在项目内 src/main/resources 文件夹下创建的 application.properties 文件的优先级是最低的。

整理完毕，完结撒花~ 🌻

参考地址：

1.java配置文件放置到jar外_Spring Boot配置文件放在jar外部，https://blog.csdn.net/weixin_39885690/article/details/114888138

2.Spring Boot 把配置文件和日志文件放到jar外部，https://blog.csdn.net/weixin_45433031/article/details/127279358

Spring Boot配置文件放在jar外部

Spring Boot程序默认从application.properties或者application.yaml读取配置，如何将配置信息外置，方便配置呢？

查询官网，可以得到下面的几种方案:

通过命令行指定

SpringApplication会默认将命令行选项参数转换为配置信息
例如，启动时命令参数指定：

java -jar myproject.jar --server.port = 9000

从命令行指定配置项的优先级最高，不过你可以通过setAddCommandLineProperties来禁用

SpringApplication.setAddCommandLineProperties(false).

外置配置文件

Spring程序会按优先级从下面这些路径来加载application.properties配置文件

• 当前目录下的/config目录
• 当前目录
• classpath里的/config目录
• classpath 跟目录

因此，要外置配置文件就很简单了，在jar所在目录新建config文件夹，然后放入配置文件，或者直接放在配置文件在jar目录

自定义配置文件

如果你不想使用application.properties作为配置文件，怎么办？完全没问题

java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties

或者

java -jar -Dspring.config.location=D:\\config\\config.properties springbootrestdemo-0.0.1-SNAPSHOT.jar 

当然，还能在代码里指定

@SpringBootApplication
@PropertySource(value={"file:config.properties"})
public class SpringbootrestdemoApplication {

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

按Profile不同环境读取不同配置

不同环境的配置设置一个配置文件，例如：

• dev环境下的配置配置在application-dev.properties中；
• prod环境下的配置配置在application-prod.properties中。

在application.properties中指定使用哪一个文件

spring.profiles.active = dev

当然，你也可以在运行的时候手动指定：

java -jar myproject.jar --spring.profiles.active = prod

参考：
1 参见Externalized Configuration

---

作者：Jadepeng
出处：jqpeng的技术记事本--http://www.cnblogs.com/xiaoqi
您的支持是对博主最大的鼓励，感谢您的认真阅读。
本文版权归作者所有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。