部署在Windows Server 2019 Tomcat的Spring Boot应用如何下载Excel到本地
问题描述
- 部署环境:开发的Spring Boot应用部署在运行Windows Server 2019的Tomcat服务器上
- 原有逻辑预期:希望获取访问应用的用户本地设备的主目录路径,将生成的Excel文件存储到用户本地
- 现存问题:代码中使用
System.getProperty("user.home")拼接文件存储路径时,实际获取到的是Tomcat所在服务器的用户主目录,生成的Excel文件被保存在服务器磁盘上,无法触达访问用户的本地设备 - 最终目标:实现调用接口后,生成的Excel文件可直接通过浏览器下载到用户本地设备,而非在服务器侧落盘存储
现有存在缺陷的接口代码
@GetMapping("/generatePetitionExcel/{application}/{dateStart}/{dateEnd}") public String generatorPetitionExcel(@PathVariable(required = false, name = "application") String requestApplication, @PathVariable(required = false, name = "dateStart") Date requestStart, @PathVariable(required = false, name = "dateEnd") Date requestEnd) throws IOException { System.out.println(" ---------------- i'm here :: 1 -------------------"); List<PetitionDTO> petition = petitonService.findPetitionInProgress(requestApplication, requestStart, requestEnd); System.out.println(" -****** petition.siz() == " +petition.size()); JExcelHelper generatorExcel = new JExcelHelper(); System.out.println("[excel_1]::"); String chemin = System.getProperty("user.home")+"\\Downloads"; String excelFilePath =chemin+"\\SEGUIMIENTO_PETICIONES -"+formatter1.format(requestStart)+"-"+formatter1.format(requestEnd)+".xls"; System.out.println("[excel_2]::"); String ret = generatorExcel.writeExcel(petition,excelFilePath); System.out.println("[excel_3]::"); return ret; }
解决方案
核心原理:后端Java代码运行在Tomcat的JVM进程内,所有系统属性读取、文件操作都作用在服务器本机,不存在合法权限途径可以直接读写访问用户的本地磁盘。实现文件下载必须通过HTTP响应流将生成的文件内容推送到客户端,由浏览器触发本地下载逻辑。
具体改造步骤
- 移除原有拼接服务器本地路径、将Excel写入服务器磁盘的逻辑
- 在接口方法中注入
HttpServletResponse对象,用于构建标准的文件下载响应 - 设置符合下载要求的HTTP响应头,明确告知浏览器当前响应为可下载的Excel文件,指定默认下载文件名
- 调整Excel生成工具类的逻辑,新增支持向输出流写入内容的重载方法,避免在服务器磁盘生成临时文件
改造后参考代码
@GetMapping("/generatePetitionExcel/{application}/{dateStart}/{dateEnd}") public void generatorPetitionExcel(@PathVariable(required = false, name = "application") String requestApplication, @PathVariable(required = false, name = "dateStart") Date requestStart, @PathVariable(required = false, name = "dateEnd") Date requestEnd, HttpServletResponse response) throws IOException { // 查询业务数据 List<PetitionDTO> petition = petitonService.findPetitionInProgress(requestApplication, requestStart, requestEnd); // 初始化Excel生成工具 JExcelHelper generatorExcel = new JExcelHelper(); // 构建下载文件名,对特殊字符做URL编码避免跨浏览器乱码 String downloadFileName = "SEGUIMIENTO_PETICIONES -" + formatter1.format(requestStart) + "-" + formatter1.format(requestEnd) + ".xls"; String encodedFileName = URLEncoder.encode(downloadFileName, StandardCharsets.UTF_8.name()).replaceAll("\\+", "%20"); // 设置响应头 response.setContentType("application/vnd.ms-excel"); response.setCharacterEncoding(StandardCharsets.UTF_8.name()); response.setHeader("Content-Disposition", "attachment;filename=" + encodedFileName); response.setHeader("Cache-Control", "no-cache"); // 直接将Excel内容写入响应输出流,不经过服务器磁盘临时文件 try (OutputStream out = response.getOutputStream()) { // 调用JExcelHelper的重载方法,直接将Excel内容写入输出流 generatorExcel.writeExcel(petition, out); out.flush(); } }
注意事项
- 原方法返回值为字符串视图逻辑需调整为void,直接操作响应流完成输出即可
- 文件名需做URL编码处理,避免不同浏览器下中文、空格类文件名出现乱码
- 后续如果使用高版本Excel格式(.xlsx),需将响应的
Content-Type调整为application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
内容的提问来源于stack exchange,提问作者JavaDeveloper
相关产品推荐
相关产品推荐

