SpringBoot 项目打成 jar 后,如何加载外部的配置文件?

简介: SpringBoot 项目打成 jar 后,如何加载外部的配置文件?

导读

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


一、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 的环境当中:


当前目录下的 /config 子目录

classpath根目录


classpath中的 /config 目录


当前目录


如果自定义的目录,比如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:

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

使用@PropertySource指定配置文件:

/**
 * @PropertySource的例子
 * <p>
 */
@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 的环境当中:


当前目录下的 /config 子目录

classpath根目录


classpath中的 /config 目录


当前目录

目录
打赏
0
0
0
0
12
分享
相关文章
如何实现上传jar直接部署成功,这篇文章直接带你上手springboot实现jar包热更新!
本文详细讲解了在Spring Boot应用中实现Jar包热更新的实践方法。通过自定义类加载器(`HotClassLoader`),动态加载和卸载指定目录下的Jar包,结合Spring Bean动态注册机制,使新加载的类能够被Spring容器管理。同时,提供了文件上传接口,方便用户手动触发Jar包更新。文章还强调了安全性、依赖管理和线程安全等注意事项,并给出了测试步骤和总结,帮助开发者高效实现热更新功能,减少服务中断和提升开发效率。
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— logback.xml 配置文件解析
本文解析了 `logback.xml` 配置文件的详细内容,包括日志输出格式、存储路径、控制台输出及日志级别等关键配置。通过定义 `LOG_PATTERN` 和 `FILE_PATH`,设置日志格式与存储路径;利用 `&lt;appender&gt;` 节点配置控制台和文件输出,支持日志滚动策略(如文件大小限制和保存时长);最后通过 `&lt;logger&gt;` 和 `&lt;root&gt;` 定义日志级别与输出方式。此配置适用于精细化管理日志输出,满足不同场景需求。
325 1
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
111 0
|
7月前
|
java项目中jar启动执行日志报错:no main manifest attribute, in /www/wwwroot/snow-server/z-server.jar-jar打包的大小明显小于正常大小如何解决
在Java项目中,启动jar包时遇到“no main manifest attribute”错误,且打包大小明显偏小。常见原因包括:1) Maven配置中跳过主程序打包;2) 缺少Manifest文件或Main-Class属性。解决方案如下:
1909 8
java项目中jar启动执行日志报错:no main manifest attribute, in /www/wwwroot/snow-server/z-server.jar-jar打包的大小明显小于正常大小如何解决
|
8月前
|
如何在无需重新启动服务器的情况下在 Spring Boot 上重新加载我的更改?
如何在无需重新启动服务器的情况下在 Spring Boot 上重新加载我的更改?
551 8
Maven的三种项目打包方式——pom,jar,war的区别
Maven 提供了多种打包方式,分别适用于不同类型的项目。pom 用于父项目或聚合项目,便于项目的结构和依赖管理;jar 用于Java类库或可执行的Java应用程序;war 则专用于Java Web应用程序的部署。理解这些打包方式的用途和特点,可以帮助开发者更好地配置和管理Maven项目,确保构建和部署过程的顺利进行。无论是单模块项目还是多模块项目,选择合适的打包方式对于项目的成功至关重要。
955 3
springboot启动配置文件-bootstrap.yml常用基本配置
以上是一些常用的基本配置项,在实际应用中可能会根据需求有所变化。通过合理配置 `bootstrap.yml`文件,可以确保应用程序在启动阶段加载正确的配置,并顺利启动运行。
717 2
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
558 3
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
这篇文章介绍了Spring Boot中配置文件的语法、如何读取配置文件以及如何通过静态工具类读取配置文件。
653 0
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等

登录插画

登录以查看您的控制台资源

管理云资源
状态一览
快捷访问