编码技巧——Springboot工程打jar包后启动时读取jar包外的资源文件

2024-04-02 19:44
文章标签 java 读取 启动 springboot 技巧 spring 工程 编码 资源 jar 包后 包外

本文主要是介绍编码技巧——Springboot工程打jar包后启动时读取jar包外的资源文件，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1. 背景

基于springboot的工程项目，使用jar方式打包，在打包时将资源文件和配置文件（springboot内置的application.properties/application.yml）单独打出来，方便修改配置而不需要重新编译打jar包；

当然，如果不将配置文件单独打包出来的话，所有的resource目录下的配置文件都会被默认打入jar、包内部，读取路径统一变成：file/:jar包所在目录/xxx-jar.jar!/BOOT-INF/classes!/，如果想修改配置那就只能重新编译打包了；

其实，当下更好的方式是使用配置中心来下发动态配置，如nacos、apollo这类成熟的配置中心中间件，但是本次开发的系统未引入相关的配置中心中间件，采用单机部署，准备快速简单做，所以就准备使用离线的方式来实现配置能实时从配置文件修改；

我们知道，springboot会默认在jar包同目录下的/config或者根目录中找application.yml和application.properties文件（可能是处于安全考虑）；

那么怎么让springboot也能读取到我们自定义的配置文件呢？

2. 方案

方案1：把业务配置写入application.yml/application.properties

理论上可以做到修改配置无需重新编译发版，但是这样做也存在缺点——application.yml / application.properties文件只会在springboot启动时加载一次，若修改了业务配置，则需要重启服务，无法实时生效；

方案2：以读取文件的方式来实时加载配置文件

例如：我们在刚开始学习java io的时候写过过读取系统某目录下txt文件的代码，当修改txt文件内容时，java代码中读取到的文件内容是会实时变化的，那么我们现在的问题就是——怎么指定配置文件的路径？

解决：通过查阅资料，很多帖子都没提到重点只是提了下怎么读取文件，没提到重点，最后终于找到了对应的解决方案——使用 FileSystemResource 类加载资源文件；

原因：在使用springboot的插件打成jar包后，此时启动路径与idea中的路径发生变化，资源文件描述发生变化，但是user.dir并没有发生变化；而FileSystemResouce本来就是相对于启动路径来寻找文件的，刚好和我们的需求匹配；


3. 测试

（1）打包时指定将配置文件helpDocConfig.json打到跟jar包平级的config/biz/目录下；

（2）输出的tar包，解压后目录如下

（3）启动jar包，调用测试接口，查看到此时的输出的内容

（4）修改文件，不重启工程，再次调用测试接口，看到此时输出了我们刚修改后的内容，说明使用FileSystemResource实时读取到了离线配置文件；

4. 代码

你们想要的就是这个吧，不废话，上源码；

    private void testExternalSrc() {String fileName = "config/biz/helpDocConfig.json";// 相对工作目录下面即user.dirFileSystemResource fileSystemResource = new FileSystemResource(fileName);File file = fileSystemResource.getFile();String absolutePath = file.getAbsolutePath();System.out.println("fileName:" + fileName + ",absolutePath:" + absolutePath);if (file.exists()) {StringBuilder sb = new StringBuilder();try (BufferedReader newBufferedReader = Files.newBufferedReader(file.toPath());) {String readLine = null;while ((readLine = newBufferedReader.readLine()) != null) {sb.append(readLine);System.out.println(readLine);}} catch (IOException e) {e.printStackTrace();}System.out.println("text:" + sb);}}

这里再附一下普通的读取jar包中的resource目录下配置文件的代码，因为是打jar包，写法跟本地运行存在点差异：

示例（1）

@Slf4j
@Component
public class PropertyUtils {@Resourceprivate ResourceLoader resourceLoader;public Properties getProperty(String fileName) {try {InputStream in = resourceLoader.getResource(fileName).getInputStream();Properties properties = new Properties();properties.load(in);in.close();return properties;} catch (Exception e) {log.error("读取文件内容到Properties失败! [fileName={}]", fileName, e);throw new RuntimeException("读取文件内容到Properties失败! [fileName=" + fileName + "]");}}public String getProperty2String(String fileName) {try {InputStream in = resourceLoader.getResource(fileName).getInputStream();String content = IOUtils.toString(in, StandardCharsets.UTF_8);in.close();return content;} catch (Exception e) {log.error("读取文件内容到String失败! [fileName={}]", fileName, e);throw new RuntimeException("读取文件内容到String失败! [fileName=" + fileName + "]");}}
}

示例（2）

@Slf4j
public class FileLoaderUtils {/*** 读文件文本到String 根目录为resource** @param fileName* @return*/public static String loadFile2String(String fileName) {ClassLoader loader = Thread.currentThread().getContextClassLoader();URL url = loader.getResource(fileName);if (url == null) {log.error("Cannot_locate_" + fileName + "_as_a_classpath_resource.");throw new RuntimeException("Cannot_locate_" + fileName + "_as_a_classpath_resource.");}try {return IOUtils.toString(url, StandardCharsets.UTF_8);} catch (IOException e) {log.error("读取文件内容为String失败! [fileName={}]", fileName, e);throw new RuntimeException("读取文件内容为String失败! [fileName=" + fileName + "]");}}/*** 读文件文本到Property 根目录为resource** @param fileName* @return*/public static Properties loadFile2Property(String fileName) {ClassLoader loader = Thread.currentThread().getContextClassLoader();InputStream in = loader.getResourceAsStream(fileName);Properties properties = new Properties();try {properties.load(in);if (in != null) {in.close();}} catch (Exception e) {log.error("读取文件内容到Properties失败! [fileName={}]", fileName, e);throw new RuntimeException("读取文件内容到Properties失败! [fileName=" + fileName + "]");}return properties;}}

补充

由于频繁读取系统文件会占用IO资源，可以将上述代码封装，改为定时刷新+懒加载方式，将离线配置文件的内容刷到本地缓存或Redis中，来减小服务器IO压力；

当然——最好的方案还是使用专业的配置中心中间件来实现配置的实时修改，专业的人干专业的事；

参考：

springboot打成jar运行，无法读取配置文件或静态资源的问题

SpringBoot：加载和读取jar包外面的资源文件-华为云开发者联盟

这篇关于编码技巧——Springboot工程打jar包后启动时读取jar包外的资源文件的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/870885。

相关文章

Ilya-AI分享的他在OpenAI学习到的15个提示工程技巧

Ilya-AI分享的他在OpenAI学习到的15个提示工程技巧

Ilya（不是本人，claude AI）在社交媒体上分享了他在OpenAI学习到的15个Prompt撰写技巧。 以下是详细的内容： 提示精确化:在编写提示时,力求表达清晰准确。清楚地阐述任务需求和概念定义至关重要。例:不用"分析文本",而用"判断这段话的情感倾向:积极、消极还是中性"。 快速迭代:善于快速连续调整提示。熟练的提示工程师能够灵活地进行多轮优化。例:从"总结文章"到"用
阅读更多...
JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
MySQL数据库宕机，启动不起来，教你一招搞定！

MySQL数据库宕机，启动不起来，教你一招搞定！

作者介绍：老苏，10余年DBA工作运维经验，擅长Oracle、MySQL、PG、Mongodb数据库运维（如安装迁移，性能优化、故障应急处理等）公众号：老苏畅谈运维欢迎关注本人公众号，更多精彩与您分享。 MySQL数据库宕机，数据页损坏问题，启动不起来，该如何排查和解决，本文将为你说明具体的排查过程。 查看MySQL error日志 查看 MySQL error日志，排查哪个表（表空间
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2