SpringBoot中读取jar包中的resources目录下的文件的三种方式

 更新时间:2023年06月26日 11:26:19   作者:sco5282  
这篇文章给大家总结了SpringBoot读取 jar 包中的 resources 目录下的文件的三种方式,文中有详细的代码示例供大家参考,,需要的朋友可以参考下

读取 resources 目录下的文件路径时,需要注意一点:在本地开发时,我们是能够通过代码获取到这个文件的绝对路径的(如:在 c 盘下或者 d 盘下的);但部署后,项目是通过打成 jar 包运行的,里面的文件是没有实际路径的(只有相对于项目名的相对路径)。

因为最后肯定是打包部署的,所以掌握针对后者的这种方式来读取文件是很有必要的。

代码图如下:

方式一:(重要)

通过 T.class.getClassLoader().getResourceAsStream() 方法。如:我要读取 config 文件夹下的 test.properties 文件:

这是一个公共方法,用来读取文件中的内容的方法,下面就不再重复了:

public static void printFileContent(Object obj) throws IOException {
    if (null == obj) {
        throw new RuntimeException("参数为空");
    }
    BufferedReader reader = null;
    // 如果是文件路径
    if (obj instanceof String) {
        reader = new BufferedReader(new FileReader(new File((String) obj)));
    // 如果是文件输入流
    } else if (obj instanceof InputStream) {
        reader = new BufferedReader(new InputStreamReader((InputStream) obj));
    }
    String line = null;
    while ((line = reader.readLine()) != null) {
        System.out.println(line);
    }
    reader.close();
}

读取方法:

public class ResourceUtil {
    public void getResource(String fileName) throws IOException{
        InputStream in = this.getClass().getClassLoader().getResourceAsStream(fileName);
        printFileContent(in);
    }
    public static void main(String[] args) throws IOException {
        new ResourceUtil().getResource("config/test.properties");
    }
}

即使是一个 jar 包,也依旧能读取到。

此方法默认是从 classpath 路径(即:src 或 resources 路径下)下查找文件的,所以,路径前不需要加 “/”。

方式二:(重要)

通过 T.class..getResourceAsStream() 方法。

public void getResource2(String fileName) throws IOException{
    InputStream in = this.getClass().getResourceAsStream("/" + fileName);
    printFileContent(in);
}
public static void main(String[] args) throws IOException {
    new ResourceUtil().getResource2("config/test.properties");
}

方法默认也是从 classpath 路径(即:src 或 resources 路径下)下查找文件的,但它的路径前为什么需要加 “/” 呢?

这个是跟要读取的文件与当前.class 文件的位置有关。

看看编译后的文件路径:

当前文件 ResourceUtil.class 与要加载的文件 test.properties 的位置如上:
很显然 test.properties 和 ResourceUtil.class 不在同一个文件夹下。

那读取的时候是要带上相对路径的,那么,这会有两种情况:

  • 相对于当前类 ResourceUtil,路径前是不需要加 “/”
  • 相对于项目名(即:编译后的 classes 文件夹),路径前是需要加 “/”

举例:

  • 如果 test.properties 和 ResourceUtil 在同一个文件夹下,那么:this.getClass().getResourceAsStream(“test.properties”)
  • 如果 test.properties 和 ResourceUtil 不在同一个文件夹下,那么:this.getClass().getResourceAsStream(“/config/test.properties”)

如果测试,不要在源文件下添加配置文件,因为编译后,在相应的路径下看不见此配置文件。可以使用 Test.java 代替。

即使是一个 jar 包,也依旧能读取到。

方式三:(重要)

通过 ClassPathResource 方法:

public void getResource3(String fileName) throws IOException{
    ClassPathResource classPathResource = new ClassPathResource(fileName);
    printFileContent(classPathResource.getInputStream());
}
public static void main(String[] args) throws IOException {
    new ResourceUtil().getResource3("config/test.properties");
}

path 前加不加 “/” 无所谓。

即使是一个 jar 包,也依旧能读取到。

到此这篇关于SpringBoot中读取jar包中的resources目录下的文件的三种方式的文章就介绍到这了,更多相关SpringBoot读取resources文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java高并发的并发级别详解

    java高并发的并发级别详解

    这篇文章主要介绍了java高并发的并发级别,内容十分丰富,在这里分享给大家,需要的朋友可以参考,希望能够给你带来帮助
    2021-10-10
  • Java中常见的XML解析方法与应用详解

    Java中常见的XML解析方法与应用详解

    XML(eXtensible Markup Language)是一种用于存储和传输数据的标记语言,被广泛应用于表示和交换独立于应用程序和硬件平台的结构化信息,下面我们就来看看它的常见解析方法有哪些吧
    2024-01-01
  • Java日常练习题,每天进步一点点(10)

    Java日常练习题,每天进步一点点(10)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-07-07
  • Java JDK1.8 安装和环境配置教程详解

    Java JDK1.8 安装和环境配置教程详解

    文章简要介绍了JDK 1.8的安装流程,包括官网下载对应系统版本、安装时选择非系统盘路径、配置JAVA_HOME、CLASSPATH和Path环境变量,最后通过命令行验证安装是否成功,感兴趣的朋友一起看看吧
    2025-07-07
  • SpringBoot结合Swagger2自动生成api文档的方法

    SpringBoot结合Swagger2自动生成api文档的方法

    这篇文章主要介绍了SpringBoot结合Swagger2自动生成api文档的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-05-05
  • 使用Java实现在Excel中添加动态数组公式

    使用Java实现在Excel中添加动态数组公式

    动态数组公式是 Excel 引入的一项重要功能,它允许用户从单个单元格中的公式返回多个结果值,并将这些值自动填充到与公式单元格相邻的单元格中,本文主要介绍了如何使用Java实现在Excel中添加动态数组公式,x需要的可以参考下
    2023-12-12
  • Java实现RedisUtils操作五大集合(增删改查)

    Java实现RedisUtils操作五大集合(增删改查)

    本文主要介绍了Java实现RedisUtils操作五大集合,文中通过示例代码介绍的非常详细,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-07-07
  • 解决@Validated对List对象验证失效问题

    解决@Validated对List对象验证失效问题

    文章指出@Validated注解无法验证List数组参数,建议手动逐项验证或封装List为对象进行验证,前者代码冗余但直接,后者需调整JSON结构但更简洁,根据需求选择方案,权衡灵活性与参数改造成本
    2025-09-09
  • Java多线程中Callable和Future的解读

    Java多线程中Callable和Future的解读

    这篇文章主要介绍了Java多线程中Callable和Future的解读,Callable接口类似于Runnable,从名字就可以看出来了,但是Runnable不会返回结果,并且无法抛出返回结果的异常,而Callable功能更强大一些,被线程执行后,可以返回值,这个返回值可以被Future拿到,需要的朋友可以参考下
    2023-09-09
  • 解决SpringBoot中MultipartResolver和ServletFileUpload的冲突问题

    解决SpringBoot中MultipartResolver和ServletFileUpload的冲突问题

    这篇文章主要介绍了解决SpringBoot中MultipartResolver和ServletFileUpload的冲突问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10

最新评论