此文要从SpringBoot打包后不能读取classpath下文件说起

简介: 您好,我是码农飞哥,感谢您阅读本文!如果此文对您有所帮助,请毫不犹豫的给个一键三连吧。

您好,我是码农飞哥,感谢您阅读本文!如果此文对您有所帮助,请毫不犹豫的给个一键三连吧。

此文要从SpringBoot打成jar之后不能读取classpath下文件说起,并由此作为一个切入点,思考如何正确的读取jar包中的文件。

问题复现

事情是这样的,昨天快下班了时候,测试小姐姐突然说(PS: 有些测试小姐姐上班的时候不提啥BUG,下班的时候给你提一堆BUG,不知道大家有没有这种感觉)。

有个图片下载的接口不能用了。害,本想6点钟下班走人的我瞬间懵逼了,这下走不了。老规矩,先查错误日志。

还是那个熟悉的FileNotFoundException异常。

2021-04-21 09:43:59.715  INFO 16896 --- [nio-8383-exec-1] com.jay.ImgDownloadController            : qr_code-icon path is: file:/D:/workspace/file_dow
nload_demo/target/file_download_demo-0.0.1-SNAPSHOT.jar!/BOOT-INF/classes!/img/qr_code-icon.png
java.io.FileNotFoundException: file:\D:\workspace\file_download_demo\target\file_download_demo-0.0.1-SNAPSHOT.jar!\BOOT-INF\classes!\img\qr_code-icon.
png (文件名、目录名或卷标语法不正确。)
        at java.io.FileInputStream.open0(Native Method) ~[na:1.8.0_60]
        at java.io.FileInputStream.open(Unknown Source) ~[na:1.8.0_60]
        at java.io.FileInputStream.<init>(Unknown Source) ~[na:1.8.0_60]
  at com.jay.ImgDownloadController.downloadImage(ImgDownloadController.java:35) ~[classes!/:0.0.1-SNAPSHOT]

很明显这是一个无效的文件路径,根据这个错误路径程序肯定不能找到指定的文件咯。

再回头定位到报错的代码

//读取文件的路径
        String path = Thread.currentThread().getContextClassLoader().getResource("").getPath()
                + "img/qr_code-icon.png";
        LOGGER.info("qr_code-icon path is: " + path);
  InputStream is = new FileInputStream(new File(path));

这段代码在本地调试的时候明明是没有问题的呀,单元测试都跑过了,本地调试时输入的路径如下:。

13df44613c3417aa7764d478cf16240c_20210421103609496.png

打印的路径地址是:D:/workspace/file_download_demo/target/classes/img/qr_code-icon.png

这个路径是一个有效的路径。

这又是一个我本地明明没问题,到服务器就有问题了。锅是甩不出去了

问题思考

我们都知道JAVA是一门静态语言,先编译再运行也就是先将java文件编译成class文件,然后在用虚拟机来执行class文件的。SpringBoot在编译打包后会生成target目录,class文件,资源文件还有jar包都会被放在这个目录下。如下图所示:

0042bcdbd13e80a4c2c75d36ed2d9298_20210421105019635.png

其中所有的class文件以及资源文件都放在了classes文件夹中。在本地运行时 Thread.currentThread().getContextClassLoader().getResource("").getPath()

其中Thread.currentThread().getContextClassLoader()返回的是当前线程的类加载器(默认是AppClassLoader类加载器),类加载器可以加载类也可以加载资源。类加载器有很多,具体可以参考双亲委派模型以及SpringFactoriesLoader详解(最全最简单的介绍)

读取到的路径是D:/workspace/file_download_demo/target/classes,classes文件夹所在的路径也就是我们熟悉的classpath 路径 。

而通过jar包来运行时,上面的代码读取的是jar的绝对路径,而jar是一个压缩包,直接读取其包内的绝对路径是有问题的。 也就是会报上面的错误。

问题解决

既然不能通过路径的方式来获取jar中文件,那么该通过何种方式来获取呢?这里有两种写法。

1.通过ClassPathResource获取输入流的方式

InputStream is = new ClassPathResource("img/qr_code-icon.png").getInputStream();

2.通过getResourceAsStream方法获取输入流

InputStream is = Thread.currentThread().getContextClassLoader()
                .getResourceAsStream("img/qr_code-icon.png");

可以看出上面两种都是直接获取文件流的方式获取文件,那么问题来了,为啥这种方式可以呢?因为在jar文件中不能直接通过资源路径的方式获取文件,但是可以在jar包中拿到文件流。

测试结果

总结

本文从SpringBoot打成jar之后不能读取classpath下文件说起,介绍了为啥打成jar之后不能通过路径的方式访问classpath下的文件,接着说明了如何处理这个问题,最后介绍了通过流的方式来处理这个问题。

结尾彩蛋

1.Thread.currentThread().getContextClassLoader().getResource("").getPath() 这种写法在通过War运行的项目(比如一个Sping MVC项目)中获取classpath下的文件有没有问题呢?欢迎知道的小伙伴积极留言。

2.通过ResouceUtils.getFile()的方式能不能获取到classpath下文件呢?

源码

@RestController
public class ImgDownloadController {
    private static final Logger LOGGER = LoggerFactory.getLogger(ImgDownloadController.class);
    /**
     * 图片下载接口
     *
     * @param response
     * @Author xiang.wei
     */
    @RequestMapping("/download/image")
    public void errorDownloadImage(HttpServletResponse response) throws IOException {
        //读取文件的路径
        String path = Thread.currentThread().getContextClassLoader().getResource("").getPath()
                + "img/qr_code-icon.png";
        LOGGER.info("qr_code-icon path is: " + path);
        InputStream is = new FileInputStream(new File(path));
        downloadFile(is, "qr_code-icon.png", response);
    }
    @RequestMapping("/correct/download/image1")
    public void correctDownloadImage1(HttpServletResponse response) throws IOException {
        InputStream is = new ClassPathResource("img/qr_code-icon.png").getInputStream();
        downloadFile(is, "qr_code-icon.png", response);
    }
    @RequestMapping("/correct/download/image2")
    public void correctDownloadImage2(HttpServletResponse response) throws IOException {
        InputStream is = Thread.currentThread().getContextClassLoader()
                .getResourceAsStream("img/qr_code-icon.png");
        downloadFile(is, "qr_code-icon.png", response);
    }
    private void downloadFile(InputStream is, String name, HttpServletResponse response) throws IOException {
        //设置响应头  "application/octet-stream"
        response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
        response.setHeader("Content-Disposition", "attachment;filename=" + java.net.URLDecoder.decode(name, "ISO-8859-1"));
        //输出流自动关闭
        try (OutputStream os = response.getOutputStream()) {
            byte[] buffer = new byte[1024];
            int len = 0;
            while ((len = is.read(buffer)) != -1) {
                os.write(buffer, 0, len);
                os.flush();
            }
        } finally {
            if (is != null) {
                is.close();
            }
        }
    }
}


相关文章
|
15小时前
|
Java 容器
SpringBoot读取resources下的文件以及resources的资源路径
SpringBoot读取resources下的文件以及resources的资源路径
35 0
|
15小时前
|
Java 开发工具 Maven
springboot项目打包为sdk供其他项目引用
springboot项目打包为sdk供其他项目引用
|
16小时前
|
JavaScript 前端开发 Java
springboot整合minio+vue实现大文件分片上传,断点续传(复制可用,包含minio工具类)
springboot整合minio+vue实现大文件分片上传,断点续传(复制可用,包含minio工具类)
557 0
|
15小时前
|
Java
SpringBoot文件上传单文件多文件上传
SpringBoot文件上传单文件多文件上传
14 0
|
15小时前
|
安全 JavaScript Java
springboot实现文件防盗链设计
`shigen`,一位专注于Java、Python、Vue和Shell的博主,分享成长和技术。近期将探讨SpringBoot实现图片防盗链,通过限制`Referer`防止资源被盗用。基础版通过`WebMvcConfigurer`配置静态资源,升级版添加拦截器检查`Referer`,确保请求来源合法性。详细代码实现和案例可在文中链接找到。一起学习,每天进步!
44 13
springboot实现文件防盗链设计
|
15小时前
|
Java 数据安全/隐私保护 开发者
【SpringBoot】讲清楚日志文件&&lombok
【SpringBoot】讲清楚日志文件&&lombok
22 5
|
15小时前
|
JSON 前端开发 JavaScript
Vue+Axios+SpringBoot后端同时接收文件和json作为请求参数
Vue+Axios+SpringBoot后端同时接收文件和json作为请求参数
38 0
|
15小时前
|
前端开发 Java 开发工具
【SpringBoot】文件分片上传、合并
【SpringBoot】文件分片上传、合并
|
15小时前
|
Java
SpringBoot操作excel文件【工具类】
SpringBoot操作excel文件【工具类】
190 0
|
15小时前
|
SQL 监控 Java
nacos常见问题之dubbo+nacos+springboot3的native打包成功后运行出现异常如何解决
Nacos是阿里云开源的服务发现和配置管理平台,用于构建动态微服务应用架构;本汇总针对Nacos在实际应用中用户常遇到的问题进行了归纳和解答,旨在帮助开发者和运维人员高效解决使用Nacos时的各类疑难杂症。
52 2