springboot 项目加载resource下的文件

最新推荐文章于 2025-06-22 11:48:39 发布

原创最新推荐文章于 2025-06-22 11:48:39 发布 · 3k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#java

springboot 专栏收录该内容

8 篇文章

订阅专栏

本文介绍了在SpringBoot项目中如何正确读取resource目录下的文件，特别是在文件被打包进jar后仍能正常读取的方法。通过四种不同的读取方式的测试，包括ClassPathResource、线程上下文类加载器、当前类类加载器和ResourceUtils，得出结论前三者在开发和生产环境中都能读取到文件，而第四种方式只适用于开发环境。问题的关键在于，SpringBoot内置的Tomcat和jar包结构，使得直接通过文件路径访问在生产环境中无效，而应通过类加载器读取文件流。

最近使用free marker制作word模板。；这里模板文件位置resource/ftl/test.ftl，

测试类中：

File file = ResourceUtils.getFile(ResourceUtils.CLASSPATH_URL_PREFIX + "ftl/test.ftl");

test.ftl文件在resource下的ftl文件夹

此种方法在本地可用。当文件打入jar包后无法读取到

解决方案：

1.  ResourceFinder.getResourceAsStream("")；

2. 建议使用此种方法

File file = new File(getClass().getClassLoader().getResource("ftl/test.ftl").getFile());

网上给了四种读取方式，
第一种：

ClassPathResource classPathResource = new ClassPathResource("excleTemplate/test.xlsx");
InputStream inputStream =classPathResource.getInputStream();

第二种：

InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("excleTemplate/test.xlsx");

第三种：

InputStream inputStream = this.getClass().getResourceAsStream("/excleTemplate/test.xlsx");

第四种：

File file = ResourceUtils.getFile("classpath:excleTemplate/test.xlsx");
InputStream inputStream = new FileInputStream(file);

经测试：
前三种方法在开发环境(IDE中)和生产环境(linux部署成jar包)都可以读取到，第四种只有开发环境时可以读取到，生产环境读取失败。
推测主要原因是springboot内置tomcat，打包后是一个jar包，因此通过文件读取获取流的方式行不通，因为无法直接读取压缩包中的文件，读取只能通过流的方式读取。
前三种都可以读取到其实殊途同归，直接查看底层代码都是通过类加载器读取文件流，类加载器可以读取jar包中的编译后的class文件，当然也是可以读取jar包中的文件流了。
用解压软件打开jar包查看结果如下：

.class文件与资源文件在一起，使用类加载器可读取到。

可参考此文档 https://blog.youkuaiyun.com/hero272285642/article/details/85119778