SpringBoot下获取resources目录下文件的常用方法
更新时间：2024年10月30日 10:46:38 作者：常量侠
本文详细介绍了SpringBoot获取resources目录下文件的常用方法,包括使用this.getClass()方法、ClassPathResource获取以及hutool工具类ResourceUtil获取,感兴趣的可以了解一下
今天给大家带来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>到此这篇关于SpringBoot下获取resources目录下文件的常用方法的文章就介绍到这了,更多相关SpringBoot获取resources目录下文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
本篇文章主要介绍了Spring 5.0集成log4j2日志管理的示例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-12-12
MVC 是一种常见的软件设计模式，用于分离应用程序的不同部分以实现松散耦合和高内聚性，这篇文章主要介绍了如何在Spring Boot中使用Spring MVC,需要的朋友可以参考下2023-04-04
本文主要介绍了JVM参数NativeMemoryTracking的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2025-01-01
读万卷书不如行万里路，只学书上的理论是远远不够的，只有在实战中才能获得能力的提升，本篇文章手把手带你用Java实现一个简单的客户选购系统,大家可以在过程中查缺补漏，提升水平2021-10-10
今天小编就为大家分享一篇关于客户端设置超时时间真的很重要，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2018-12-12
这篇文章主要介绍了详解IDEA的快捷键及智能提示,文中有非常详细的快捷键及智能提示的说明,对正在使用IDEA的小伙伴们有很好的帮助,需要的朋友可以参考下2021-05-05
SpringBoot整合Liquibase实现对数据库管理和迁移
Liquibase是一个用于用于跟踪、管理和应用数据库变化的开源工具,通过日志文件(changelog)的形式记录数据库的变更(changeset),然后执行日志文件中的修改,将数据库更新或回滚(rollback)到一致的状态,本文主要介绍SpringBoot与Liquibase的集成,需要的朋友可以参考下2024-11-11
这篇文章主要介绍了如何优雅的实现将Collection转为Map,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2025-03-03
这篇文章主要介绍了Java如何在后端接入微信小程序从而实现登录功能，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起了解一下2023-06-06
延时队列是一种常见的需求,延时队列允许我们延迟处理某些任务,本文主要介绍了Redisson延迟队列的示例,具有一定的参考价值,感兴趣的可以了解一下2024-06-06
最新评论