SpringBoot读取Resource下文件的几种方式读取jar里的excel，文件损坏

在项目中涉及到Excle的导入功能，通常是我们定义完模板供用户下载，用户按照模板填写完后上传；
这里待下载模板位置为resource/template/员工基础信息导入模板.xlsx，
分别尝试了四种读取方式，并且测试了四种读取方式分别的windows开发环境下(IDE中)读取和生产环境(linux下springboot 的 jar包运行读取)。

文件后缀也正确 ，就是打不开

第一种：

# 注意是 Springboot 下的 ClassPathResource ， 而不是hutool 下的，否则报错，下载下来excel 后打不开

# 注意是 Springboot 下的 ClassPathResource ， 而不是hutool 下的，否则报错，下载下来excel 后打不开 
ClassPathResource classPathResource = new ClassPathResource("template/员工基础信息导入模板.xlsx");
InputStream inputStream =classPathResource.getInputStream();
1
2
3

第二种：

InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("template/员工基础信息导入模板.xlsx");
1

第三种：

InputStream inputStream = this.getClass().getResourceAsStream("template/员工基础信息导入模板.xlsx");
1

第四种：

File file = ResourceUtils.getFile("classpath:template/员工基础信息导入模板.xlsx");
InputStream inputStream = new FileInputStream(file);
1
2

经测试：

前三种方法在开发环境(IDE中)和生产环境(linux部署成jar包)都可以读取到；

第四种只有开发环境 时可以读取到，生产环境读取失败。

推测

主要原因是springboot内置tomcat，打包后是一个jar包，Resource下的文件是存在于jar这个文件里面，在磁盘上是没有真实路径存在的，它其实是位于jar内部的一个虚拟路径。所以通过ResourceUtils.getFile或者this.getClass().getResource(“”)方法无法正确获取文件。

只能通过类加载器读取。
前三种都可以读取到其实殊途同归，直接查看底层代码都是通过类加载器读取文件流，类加载器可以读取jar包中的编译后的class文件，当然也是可以读取jar包中的excle模板了。
用解压软件打开jar包查看结果如下：

其中cst文件中是编译后class文件存放位置，excleTemplate是模板存放位置，类加载器读取的是cst下class文件，同样可以读取excleTemplate下的模板的文件流了。

总结一下：

假如文件是在jar包中，读取方式应当使用基于类加载器读取文件流的方式，比如前三种方法；使用基于java中File方式的读取，在jar包情况下是读取不到的，比方说第四种。

    /**
     *  下载模板
     *
     * @param fileName          文件名称
     * @param response
     * @return
     * @author wangl
     * @date 2023-10-23
     */
    public static void downloadExcelTemplate(String fileName, HttpServletResponse response) {
        //方法一：直接下载路径下的文件模板（这种方式貌似在SpringCloud和Springboot中，打包成JAR包时，可能会无法读取到指定路径下面的文件）
        try {
            //设置要下载的文件的名称
            resetResponse(fileName, response);
            //通知客服文件的MIME类型
//            response.setContentType("application/vnd.ms-excel;charset=UTF-8");
            // 获取文件的路径
            // 注意是 Springboot 下的 ClassPathResource ， 而不是hutool 下的，否则报错，下载下来excel 后打不开 
            ClassPathResource classPathResource = new ClassPathResource("/template/" + fileName);
            InputStream inputStream = classPathResource.getInputStream();
            OutputStream out = response.getOutputStream();
            byte[] b = new byte[2048];
            int len;
            while ((len = inputStream.read(b)) != -1) {
                out.write(b, 0, len);
            }
            //修正 Excel在“xxx.xlsx”中发现不可读取的内容。是否恢复此工作薄的内容？如果信任此工作簿的来源，请点击"是"
            response.setHeader("Content-Length", String.valueOf(inputStream.readAllBytes().length));
            inputStream.close();
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35