使用spring的ResourceUtils.getFile读取jar包内文件失败

本文介绍了解决在Spring框架中从类路径下读取模板文件的问题,特别是当应用部署在Linux服务器上的场景。文章详细分析了使用ResourceUtils.getFile()方法遇到的错误,并提出了一种解决方案,即利用ClassPathResource类来读取资源文件。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

在做模板导出的时候,想要把项目中的excel文件作为模板供用户下载,就这么一个功能,挺简单的,但是遇到了一些问题。本地下载没问题,linux服务器上却报找不到文件错误。

  • 来简单分析下,我是使用spring-core下的ResourceUtils.getFile()工具(这个jar包的util目录下有很多有用的工具),直接来看看它的源码吧。

  • ef5227b0c80bcd124742acd2d22fb2c5.png

  • 从方法的注释来看,入参可以是classpath:、file:或者是普通的路径,至于这classpath:有不明白的,之前的有提到过,可以翻看一下。

  • 然后从代码实现来看呢,总体上有三步,分别对应解析classpath:file:、普通路径。因为从资源目录下读取文件,所以主要来看看对classpath:的解析。

  • 首先通过调用ClassUtils.getDefaultClassLoader()获得默认的类加载器,稍微看看ClassUtils.getDefaultClassLoader()的实现:

  • 4ebc08183a15ab378bd773e1236d990d.png

  • 可以看出先尝试获得当前线程的类加载器,如果失败,就获取当前类的类加载器,再失败的话就获取系统类加载器,关于类加载器的种类问题,以后会总结一下。

  • 拿到类加载器后,就可以去加载资源了,可知是调用getFile(url, description)这个方法来获得File的,来看看它的实现:

  • d80cea8eca9339979afde8bfef2f8b9a.png

  • 从这个方法中看到了之前抛出的错误信息了,cannot be resolved to absolute file path...,从条件判断可以看到resourceUrl.getProtocol()不是file,那么会是什么呢?我猜可能是jar,因为从报错的信息来看,资源的地址直接定位到了jar文件里面去了。

  • ok,让我来验证一下,通过远程调试来看看是不是jar,经过一番配置后,看图:

  • a02353c1e8ee267761006bd2e4aa3663.png

  • 果然是jar,到这里呢,问题就算找到了,可怎么解决呢?接下来提供一种解决办法。

  • 既然不能使用file来获取资源目录下的文件,可以使用类加载器来加载资源文件,不用我们自己来写,spring有个工具类可以读取类路径下的资源文件:ClassPathResource,挺好用的。

  • 这个问题的背景是提供下载的接口,所以有这么些代码片段:

public ResponseEntity<byte[]> test(String templateName) throws IOException {
        String templateName;
        ClassPathResource classPathResource = new ClassPathResource(templateName);
        String filename = classPathResource.getFilename();
        @Cleanup InputStream inputStream = classPathResource.getInputStream();
        byte[] bytes = FileCopyUtils.copyToByteArray(inputStream);
        String fileName = new String(filename.getBytes("UTF-8"), "iso-8859-1");// 为了解决中文名称乱码问题
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
        headers.setContentDispositionFormData("attachment", fileName);
        return new ResponseEntity<>(bytes, headers, HttpStatus.CREATED);
    }
  • 这里面用到了一个流转字节的工具类FileCopyUtils,也挺不错的,不用自己重新写,还有@Cleanup这个注解可以释放流,也挺方便的。
  • 好的,这个读取内嵌servlet容器的jar的文件问题通过以上分析大致可以得到解决,但是里面的原理还需要细细揣摩才行,活到老,学到老。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值