SpringBoot项目打成jar后加载外部配置文件 - 第463篇
创始人
2024-06-02 22:05:56
0

历史文章(文章累计450+)

《国内最全的Spring Boot系列之一》

《国内最全的Spring Boot系列之二》

《国内最全的Spring Boot系列之三》

《国内最全的Spring Boot系列之四》

《国内最全的Spring Boot系列之五》

《国内最全的Spring Boot系列之六》

SpringBoot使用ChatGPT Api开发一个聊天机器人 - 第460篇

Idea启动多个SpringBoot项目的3种方案

SpringBoot版的低代码开发平台,关联无 SQL - 第462篇

悟纤:芭比Q,这人怎么头疼,一整就让我修改配置信息。

师傅:徒儿,这是怎么了?

悟纤:师傅,师傅,你救救徒儿,我们公司的那个人老是让我修改application.properties的配置信息,修改完之后还得打包部署,烦死人了。

师傅:那这个简单呢,把配置文件外置就可,他爱怎么改,自己改去。

悟纤:师傅这是一语惊醒梦中人呢。

师傅:碰到问题要多动脑,每个问题的背后都是成长。

悟纤:还是师傅好,为我排忧解难了。

导读

有些时候,我们的一些配置信息需要比较频繁的修改,如果这些配置信息是放在项目中的话,那么就需要经常进行打包部署,所以我们就思考是否可以把这个配置文件外置呢?

一、application.properties外置

大部分的配置信息,我们都是配置在application.properties,那么这个文件是否可以外置呐?这个当然是可以的。

首先在application.preperties定义一个属性:

demo.name = hello.01

在Controller进行使用:

@Value("${demo.name}")private String demoName;@RequestMapping("/test")public String test(){    return this.demoName;}

将项目打成jar包,使用java -jar的方式进行启动:

java -jar springboot-out-properties-0.0.1-SNAPSHOT.jar

此时读取的值是:hello.01。

将项目中的application.properties拷贝出来,放到和jar包同路径下,修改属性值为:

demo.name = hello.02

然后使用上面的命令重新启动,看下效果读取的值就是hello.02了,惊不惊喜意不意外,Spring Boot太牛了,jar包同路径下就直接读取了。

如果我们在jar下新建一个config,然后把application.properties放进去的话,使用上面的命令可以识别吗 ?答案是可以的,

SpringApplication 将从 application.properties 以下位置的文件中加载属性并且将其添加到 Spring 的环境当中:

l当前目录下的 /config 子目录

l当前目录

lclasspath中的 /config 目录

lclasspath根目录

如果自定义的目录,比如conf的话,这个时候就不能识别了,但可以使用--spring.config.location进行指定路径,执行命令如下:

java -jar springboot-out-properties-0.0.1-SNAPSHOT.jar--spring.config.location=conf/application.properties

当然也可以使用绝对路径进行指定:

java -jar springboot-out-properties-0.0.1-SNAPSHOT.jar--spring.config.location=/Users/linxiangxian/Downloads/conf/application.properties

二、@PropertySource外置

在项目中,有些配置会自定义propreties文件进行使用,比如定义了demo.properties:

demo.nickname = hello.10demo.weixin = springboot

使用@PropertySource指定配置文件:

/** * @PropertySource的例子 * 

* author:悟纤「公众号SpringBoot」 * date:2023/3/10 * slogan:大道至简 悟在天成 */@Configuration@ConfigurationProperties(prefix = "demo")@PropertySource(value = {"classpath:demo.properties"})public class DemoProperties { private String nickname; private String weixin; public String getNickname() { return nickname; } public void setNickname(String nickname) { this.nickname = nickname; } public String getWeixin() { return weixin; } public void setWeixin(String weixin) { this.weixin = weixin; } @Override public String toString() { return "DemoProperties{" + "nickname='" + nickname + '\'' + ", weixin='" + weixin + '\'' + '}'; }}

那么此时是可以访问到这个配置文件的,打成jar包,执行命令:

​java -jar springboot-out-properties-0.0.1-SNAPSHOT.jar

此时返回的值是:hello.10

将demo.properties放到和jar包同路径下,修改demo.name的值为hello.11,执行上面的命令,芭比Q了,结果还是hello.10,说明Spring Boot对于自定义的properties文件并不能自己从外部去寻找。

那对于这个问题咱么破呢?

很简单,@PropertySource支持多配置多个路径,可以这么配置:

@PropertySource(value = {"classpath:demo.properties","file:./demo.properties"},ignoreResourceNotFound = true)

当我们配置多路径,且多路径下配置文件都存在时,SpringBoot会都加载且会覆盖相同内容。所以当我们配置信息只区分外部和内部路径、内容完全相同时,将file路径写在后面就可以了。当我们本地启动时,因为不存在file路径,所以会加载classpath;当jar启动时,file路径会覆盖classpath路径下的内容;

ignoreResourceNotFound = true 一定要加上,否则找不到会报错。加上之后会忽略找不到的配置文件。

此时将配置文件demo.properties放到和jar包同级下就可以了。

总结

对于application.properties文件:

(1)默认是读取classpath下的application.properties文件。

(2)jar包同级下的application.properties可以直接读取,启动命名不需要做调整。

(3)jar包同级下的config/application.properties,可以直接读取,启动命令不需要调整。

(4)jar包同级下的conf/application.properties,不可以直接读取,需要通过参数--spring.config.location进行指定。

对于自定义的.properties文件:

(1)默认是读取classpath下的xxx.properties文件。

(2)jar包同级下的xxx.properties不可以直接读取,需要修改代码的配置@PropertySource指定多个路径,期望最终被使用的路径放到最后,因为会覆盖之前读取的配置信息。

Spring Boot将从 application.properties 以下位置的文件中加载属性并且将其添加到 Spring 的环境当中:

l当前目录下的 /config 子目录

l当前目录

lclasspath中的 /config 目录

lclasspath根目录

相关内容

热门资讯

监控摄像头接入GB28181平... 流程简介将监控摄像头的视频在网站和APP中直播,要解决的几个问题是:1&...
Windows10添加群晖磁盘... 在使用群晖NAS时,我们需要通过本地映射的方式把NAS映射成本地的一块磁盘使用。 通过...
protocol buffer... 目录 目录 什么是protocol buffer 1.protobuf 1.1安装  1.2使用...
Fluent中创建监测点 1 概述某些仿真问题,需要创建监测点,用于获取空间定点的数据࿰...
educoder数据结构与算法...                                                   ...
MySQL下载和安装(Wind... 前言:刚换了一台电脑,里面所有东西都需要重新配置,习惯了所...
MFC文件操作  MFC提供了一个文件操作的基类CFile,这个类提供了一个没有缓存的二进制格式的磁盘...
在Word、WPS中插入AxM... 引言 我最近需要写一些文章,在排版时发现AxMath插入的公式竟然会导致行间距异常&#...
有效的括号 一、题目 给定一个只包括 '(',')','{','}'...
【Ctfer训练计划】——(三... 作者名:Demo不是emo  主页面链接:主页传送门 创作初心ÿ...