SpringBoot下获取resources目录下文件的常用方法

已于 2024-08-29 11:47:27 修改
阅读量884 收藏 7
点赞数 4
分类专栏： java 文章标签： spring boot 后端 java
于 2024-08-29 11:45:59 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010479989/article/details/141674584
版权

哈喽，大家好，今天给大家带来SpringBoot获取resources目录下文件的常用方法，示例中的方法是读取resources目录下的txt和xlsx文件，并将xlsx导出到excel的简单写法。完整代码放在最后。

通过this.getClass()方法获取

method1 - method4都是通过这个方法获取文件的写法，这四种写法在idea中都可以正常运行，jar包执行后method1和method2报错，提示找不到文件，method3和method4可以正常运行

通过ClassPathResource获取

method5是通过这种方法实现，idea中可以正常运行，打包后的jar中提示找不到文件

通过hutool工具类ResourceUtil获取

method6是通过这种方法实现，和method情况一样，同样是idea中可以正常运行，导出的jar中提示找不到文件

总结

不想折腾的同学可以直接用method3和method4的方法来使用，也可以将模板和资源文件外置，通过绝对路径获取对应文件。有好的方法也欢迎大家一起交流沟通~

代码

import cn.hutool.core.io.FileUtil;
import cn.hutool.core.io.resource.ClassPathResource;
import cn.hutool.core.io.resource.ResourceUtil;
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.enums.WriteDirectionEnum;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.fill.FillConfig;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.List;

@RestController
@RequestMapping("/temp")
public class TemplateController {


    /**
     * this.getClass()方法获取
     * @param response
     * @throws IOException
     */
    @RequestMapping("/method1")
    public void method1(HttpServletResponse response) throws IOException {
        System.out.println("----------method1 start");
        String filename = "template.xlsx";
        String bashPatch = this.getClass().getClassLoader().getResource("").getPath();
        System.out.println(bashPatch);

        String textFile = "template.txt";
        String textPath = this.getClass().getClassLoader().getResource("").getPath();
        List<String> dataList = FileUtil.readUtf8Lines(textPath + "/template/" + textFile);
        for (String data : dataList) {
            System.out.println(data);
        }

        try (ExcelWriter excelWriter =
                     EasyExcel.write(response.getOutputStream())
                             .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
//                             .withTemplate(resource.getFile().getAbsolutePath())
                             .withTemplate(bashPatch + "/template/" + filename)
                             .build()
        ) {
            WriteSheet writeSheet = EasyExcel.writerSheet(0).build();
            FillConfig userFillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            
            FillConfig titleFillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            excelWriter.finish();
        }
        try {
            response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, StandardCharsets.UTF_8.name()));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
        response.setContentType("application/vnd.ms-excel;charset=UTF-8");
    }


    @RequestMapping("/method2")
    public void method2(HttpServletResponse response) throws IOException {
        System.out.println("----------method2 start");
        String filename = "template.xlsx";
        String bashPatch = this.getClass().getClassLoader().getResource("template").getPath();
        System.out.println(bashPatch);

        String textFile = "template.txt";
        String textPath = this.getClass().getClassLoader().getResource("template").getPath();
        List<String> dataList = FileUtil.readUtf8Lines(textPath + "/" + textFile);
        for (String data : dataList) {
            System.out.println(data);
        }

        try (ExcelWriter excelWriter =
                     EasyExcel.write(response.getOutputStream())
                             .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
//                             .withTemplate(resource.getFile().getAbsolutePath())
                             .withTemplate(bashPatch + "/" + filename)
                             .build()
        ) {
            WriteSheet writeSheet = EasyExcel.writerSheet(0).build();
            FillConfig userFillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            
            FillConfig titleFillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            excelWriter.finish();
        }
        try {
            response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, StandardCharsets.UTF_8.name()));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
        response.setContentType("application/vnd.ms-excel;charset=UTF-8");
    }


    @RequestMapping("/method3")
    public void method3(HttpServletResponse response) throws IOException {
        System.out.println("----------method3 start");
        String filename = "template.xlsx";
        InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("template" + "/" + filename);
//        System.out.println(inputStream);

        String textFile = "template.txt";
        InputStream textStream = this.getClass().getClassLoader().getResourceAsStream("template" + "/" + textFile);
        BufferedReader reader = new BufferedReader(new InputStreamReader(textStream));
        String line;
        try {
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        } catch (IOException e) {
            e.printStackTrace(); // 异常处理
        }

        try (ExcelWriter excelWriter =
                     EasyExcel.write(response.getOutputStream())
                             .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
//                             .withTemplate(resource.getFile().getAbsolutePath())
                             .withTemplate(inputStream)
                             .build()
        ) {
            WriteSheet writeSheet = EasyExcel.writerSheet(0).build();
            FillConfig userFillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            
            FillConfig titleFillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            excelWriter.finish();
        }
        try {
            response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, StandardCharsets.UTF_8.name()));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
        response.setContentType("application/vnd.ms-excel;charset=UTF-8");
    }


    @RequestMapping("/method4")
    public void method4(HttpServletResponse response) throws IOException {
        System.out.println("----------method4 start");
        String filename = "template.xlsx";
        InputStream inputStream = this.getClass().getResourceAsStream("/template" + "/" + filename);
//        System.out.println(inputStream);

        String textFile = "template.txt";
        InputStream textStream = this.getClass().getResourceAsStream("/template" + "/" + textFile);
        BufferedReader reader = new BufferedReader(new InputStreamReader(textStream));
        String line;
        try {
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        } catch (IOException e) {
            e.printStackTrace(); // 异常处理
        }
        try (ExcelWriter excelWriter =
                     EasyExcel.write(response.getOutputStream())
                             .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
//                             .withTemplate(resource.getFile().getAbsolutePath())
                             .withTemplate(inputStream)
                             .build()
        ) {
            WriteSheet writeSheet = EasyExcel.writerSheet(0).build();
            FillConfig userFillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            
            FillConfig titleFillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            excelWriter.finish();
        }
        try {
            response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, StandardCharsets.UTF_8.name()));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
        response.setContentType("application/vnd.ms-excel;charset=UTF-8");
    }


    /**
     * 通过ClassPathResource获取
     * @param response
     * @throws IOException
     */
    @RequestMapping("/method5")
    public void method5(HttpServletResponse response) throws IOException {
        System.out.println("----------method5 start");
        String filename = "template.xlsx";
        ClassPathResource classPathResource = new ClassPathResource("template" + "/" + filename);

        String textFile = "template.txt";
        ClassPathResource textResource = new ClassPathResource("template" + "/" + textFile);
        List<String> dataList = FileUtil.readUtf8Lines(textResource.getAbsolutePath());
        for (String data : dataList) {
            System.out.println(data);
        }

        try (ExcelWriter excelWriter =
                     EasyExcel.write(response.getOutputStream())
                             .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
                             .withTemplate(classPathResource.getAbsolutePath())
                             .build()
        ) {
            WriteSheet writeSheet = EasyExcel.writerSheet(0).build();
            FillConfig userFillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            
            FillConfig titleFillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            excelWriter.finish();
        }
        try {
            response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, StandardCharsets.UTF_8.name()));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
        response.setContentType("application/vnd.ms-excel;charset=UTF-8");
    }

    /**
     * 通过hutool工具类ResourceUtil获取
     * @param response
     * @throws IOException
     */
    @RequestMapping("/method6")
    public void method6(HttpServletResponse response) throws IOException {
        System.out.println("----------method6 start");
        String filename = "template.xlsx";
        String filePath = ResourceUtil.getResource("template" + "/" + filename).getPath();

        String textFile = "template.txt";
        String textPath = ResourceUtil.getResource("template" + "/" + textFile).getPath();
        List<String> dataList = FileUtil.readUtf8Lines(textPath);
        for (String data : dataList) {
            System.out.println(data);
        }

        try (ExcelWriter excelWriter =
                     EasyExcel.write(response.getOutputStream())
                             .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
                             .withTemplate(filePath)
                             .build()
        ) {
            WriteSheet writeSheet = EasyExcel.writerSheet(0).build();
            FillConfig userFillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            
            FillConfig titleFillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            excelWriter.finish();
        }
        try {
            response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, StandardCharsets.UTF_8.name()));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
        response.setContentType("application/vnd.ms-excel;charset=UTF-8");
    }

}

pom依赖

        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.9</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>3.3.3</version>
        </dependency>

小灰灰__
关注
专栏目录
Spring Boot读取resources目录文件方法详解
08-25
主要介绍了Spring Boot读取resources目录文件方法详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Spring Boot 获取 java resources 下文件
热门推荐
Duke的博客
12-04 3万+
Spring Boot 获取 java resources 下文件 前些日子由于项目需要，在项目的 resources 目录里创建了一个 template 目录，用于存放一些 Excel 模板，但在代码里获取 template 目录时，Windows 环境下可以，但 Linux 环境下不行，后来几经波折终于找到一种解决方法，经测试该方法在Windows 环境与Linux 环境都适用。 1、使用 C...
springboot读取jar包resources下的文件
无聊的博客
09-12 3888
如果要在Spring Boot JAR中从类路径加载文件，则必须使用该resource.getInputStream()方法将其作为InputStream进行检索。如果您尝试使用，resource.getFile()您将收到错误，因为Spring尝试访问文件系统路径，但它无法访问JAR中的路径。 //方式1： InputStream inputStream = getClass()....
SpringBoot项目中读取resource目录下的文件（六种方法）
weixin_63742275的博客
05-07 1万+
源码里还是方法三、方法四，只不过做了一些封装，更方便开发。2）启动jar包指令。
SpringBoot读取Resource下文件的方法
kfepiza的博客
09-07 3306
方法1 ClassPathResource classPathResource = new ClassPathResource("excleTemplate/test.xlsx"); InputStream inputStream =classPathResource.getInputStream(); 方法2 InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("exc
spring boot读取resources文件夹下的文件
西京刀客
10-14 5751
springboot读取resources文件夹下边的文件 //获取文件的相对路径 可在控制台打印查看输出结果 String filePath = ResourceUtils.getFile("classpath:xml/custInfo.xml").getPath(); log.info("filePath: {}", filePath); File file = ResourceUtils.getFile("classpath:template/科研项目模板.xlsx"); ...
Springboot获取resources中的文件
纯洁的小魔鬼
02-20 3万+
1.Springboot以文件的形式获取resources中的文件 import com.google.gson.JsonIOException; import com.google.gson.JsonObject; import com.google.gson.JsonParser; import com.google.gson.JsonSyntaxException; import o...
【SpringBoot】四种读取 Spring Boot 项目中 jar 包中的 resources 目录下的文件
06-02 1万+
【SpringBoot】四种读取 Spring Boot 项目中 jar 包中的 resources 目录下的文件
springboot读取resources下文件方式
qq_34565436的博客
04-01 2万+
项目中很多时候需要读取自定义配置文件 1、使用项目内路径读取，只能在开发工具中使用，部署之后无法读取。（不通用） 类似：src/main/resources/default.xml File file = new File("src/main/resources/default.xml"); @Test public void testReadFile2() throws IOException { File file = new File("src/main/
Spring Boot获取resources目录下文件的方式
瓜瓜嘟嘟
06-12 4463
在 Spring Boot 中，获取resources目录下的文件为例，可以通过以下几种方式获取：
SpringBoot读取Resource下文件
qq_42077317的博客
10-11 1702
ResourceLoader接口是Spring框架提供的用于加载各种资源的接口，包括classpath下的资源。有时在项目中，涉及一些导入的功能，那么需要提供一些模板下载，那么就需要读取模板，而模板放在resource下，那么可以通过多种方式读取文件。此方法默认是从 classpath 路径（即：src 或 resources 路径下）下查找文件的，但它的路径前需要加 “/”。相对于项目名（即：编译后的 classes 文件夹），路径前是需要加 “/”。以上是常见的读取方式。
SpringBoot获取resources下的文件
Reid的专栏
12-01 988
例如下载/resources/excel/template.xlsx @GetMapping("/download") public void downloadFile(HttpServletRequest request, HttpServletResponse response) { String fullFileName = "excel/template.xlsx"; ExcelUtils.ex
springboot项目读取 resources 目录下的文件的9种方式
最新发布
dj1955的博客
08-25 1242
案例： 模拟springboot 装配bean。
SpringBoot中获取Resource目录下文件
make_progress的博客
01-01 862
注：在jar包中直接使用路径方式直接读Resource目录下的文件比较难，建议使用流的方式读文件。
获取spring resource目录下的文件
qq_39228264的博客
04-30 330
在Spring框架中，你可以使用Resource接口和ResourceLoader接口来获取位于classpath、文件系统或其他位置的文件。对于resource目录下的文件（这通常指的是类路径下的一个目录），你可以使用ClassPathResource或者直接注入一个Resource类型的bean。
SpringBoot读取Resources文件
myli92的博客
03-31 1888
SpringBoot读取文件一般分为两种，一种是获取文件对象（File/URL）另一种是获取文件的流。
【开发】SpringBoot如何优雅的读取Resources下的文件
Jim.kk的笔记
05-07 1357
如何优雅地读取Resource下的资源文件（以浏览器访问图片资源做示例）
Spring项目读取resource下的资源文件
邢慧鹏的博客
07-18 1547
Spring项目读取resource下的资源文件。
springboot项目读取resources目录下的文件的9种方式
07-15
### 回答1： Spring Boot 项目可以使用如下 9 种方式来读取 resources 目录下的文件： 1. 使用 ClassLoader.getResourceAsStream() 方法： ``` InputStream inputStream = getClass().getClassLoader().getResourceAsStream("file.txt"); ``` 2. 使用 ClassLoader.getSystemResourceAsStream() 方法： ``` InputStream inputStream = ClassLoader.getSystemResourceAsStream("file.txt"); ``` 3. 使用 Class.getClassLoader().getResourceAsStream() 方法： ``` InputStream inputStream = Class.class.getClassLoader().getResourceAsStream("file.txt"); ``` 4. 使用 Thread.currentThread().getContextClassLoader().getResourceAsStream() 方法： ``` InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("file.txt"); ``` 5. 使用 Class.getResourceAsStream() 方法： ``` InputStream inputStream = getClass().getResourceAsStream("/file.txt"); ``` 6. 使用 Class.getResourceAsStream() 方法（不以'/'开头）： ``` InputStream inputStream = getClass().getResourceAsStream("file.txt"); ``` 7. 使用 ClassLoader.getResource() 方法： ``` URL url = getClass().getClassLoader().getResource("file.txt"); ``` 8. 使用 ClassLoader.getSystemResource() 方法： ``` URL url = ClassLoader.getSystemResource("file.txt"); ``` 9. 使用 Class.class.getResource() 方法： ``` URL url = Class.class.getResource("/file.txt"); ``` 注意：上述代码中的 `file.txt` 是 resources 目录下的文件名字，可以根据实际情况替换成其他文件名。 ### 回答2： Spring Boot项目可以使用以下9种方式来读取resources目录下的文件： 1. 使用ClassLoader.getResourceAsStream()方法: ```java InputStream inputStream = getClass().getClassLoader().getResourceAsStream("file.txt"); ``` 2. 使用File类的相对路径： ```java File file = new File("src/main/resources/file.txt"); ``` 3. 使用Spring的ResourceLoader接口： ```java ResourceLoader resourceLoader = new DefaultResourceLoader(); Resource resource = resourceLoader.getResource("classpath:file.txt"); ``` 4. 使用ServletContext.getResourceAsStream()方法： ```java InputStream inputStream = getServletContext().getResourceAsStream("/WEB-INF/classes/file.txt"); ``` 5. 使用Spring的ResourceUtils类： ```java File file = ResourceUtils.getFile("classpath:file.txt"); ``` 6. 使用Spring的Resource接口： ```java ClassPathResource resource = new ClassPathResource("file.txt"); InputStream inputStream = resource.getInputStream(); ``` 7. 使用Spring的ResourcePatternResolver接口： ```java ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(); Resource[] resources = resolver.getResources("classpath*:file.txt"); ``` 8. 使用InputStreamResource类： ```java Resource resource = new InputStreamResource(getClass().getClassLoader().getResourceAsStream("file.txt")); ``` 9. 使用PropertiesLoaderUtils类来加载properties文件： ```java Properties properties = PropertiesLoaderUtils.loadProperties(new ClassPathResource("file.properties")); ``` 以上是部分常用的读取resources目录下文件的方式，可以根据具体需求选择适合的方式。 ### 回答3： Spring Boot项目中可以使用以下9种方式读取resources目录下的文件： 1. 使用ClassPathResource类来获取资源路径，并使用InputStream或File对象进行读取。 2. 使用ResourceUtils类的`getFile()`方法来获取文件对象。 3. 使用ClassLoader类来获取资源路径，并使用InputStream或File对象进行读取。 4. 使用ServletConfig类的`getServletContext().getRealPath()`方法来获取资源路径，并使用InputStream或File对象进行读取。 5. 使用URL类来获取资源路径，并使用InputStream或File对象进行读取。 6. 使用ResourceLoader类的`getResource()`方法来获取资源路径，并使用InputStream或File对象进行读取。 7. 使用自动装配注解@Value来获取资源路径，并使用InputStream或File对象进行读取。 8. 使用PathMatchingResourcePatternResolver类的`getResources()`方法找到匹配的资源路径，并使用InputStream或File对象进行读取。 9. 使用FileUtils类的`readFileToByteArray()`方法将资源文件转换为字节数组进行读取。 以上9种方式都可以根据具体的需求来选择使用，它们提供了灵活和方便的方式来读取resources目录下的文件。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小灰灰__

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值