news 2026/4/27 7:13:50

springboot controller返回的是HttpServletResponse成功返回excel文件流,失败就返回失败参数

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
springboot controller返回的是HttpServletResponse成功返回excel文件流,失败就返回失败参数

下面是一个完整的 Spring Boot Controller 示例,根据业务逻辑判断返回 Excel 文件流或失败参数:

方案一:使用 HttpServletResponse 直接输出

import org.springframework.web.bind.annotation.*; import javax.servlet.http.HttpServletResponse; import java.io.OutputStream; import java.net.URLEncoder; import java.nio.charset.StandardCharsets; import java.util.HashMap; import java.util.Map; @RestController @RequestMapping("/api/excel") public class ExcelExportController { @PostMapping("/export") public void exportExcel(@RequestBody ExportRequest request, HttpServletResponse response) { try { // 1. 业务逻辑判断是否成功 BusinessResult result = processBusiness(request); if (!result.isSuccess()) { // 2. 失败时返回 JSON 格式的错误信息 response.setContentType("application/json"); response.setCharacterEncoding("UTF-8"); Map<String, Object> errorResponse = new HashMap<>(); errorResponse.put("code", 500); errorResponse.put("message", result.getErrorMessage()); errorResponse.put("data", result.getErrorData()); // 设置 HTTP 状态码 response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); // 写入错误信息 response.getWriter().write( new com.fasterxml.jackson.databind.ObjectMapper() .writeValueAsString(errorResponse) ); return; } // 3. 成功时返回 Excel 文件 byte[] excelData = generateExcel(result.getData()); // 设置响应头 String fileName = URLEncoder.encode("报表.xlsx", StandardCharsets.UTF_8.name()); response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"); response.setHeader("Content-Disposition", "attachment; filename*=UTF-8''" + fileName); response.setHeader("Pragma", "no-cache"); response.setHeader("Cache-Control", "no-cache"); // 写入 Excel 文件流 try (OutputStream os = response.getOutputStream()) { os.write(excelData); os.flush(); } } catch (Exception e) { // 异常处理 handleException(response, e); } } // 业务处理方法 private BusinessResult processBusiness(ExportRequest request) { // 模拟业务逻辑 if (request.getData() == null || request.getData().isEmpty()) { return BusinessResult.failure("导出数据不能为空", null); } // 其他业务逻辑... return BusinessResult.success("处理成功", request.getData()); } // 生成 Excel private byte[] generateExcel(List<Data> data) { // 使用 Apache POI 或其他库生成 Excel // 这里简化为示例 try (ByteArrayOutputStream baos = new ByteArrayOutputStream(); XSSFWorkbook workbook = new XSSFWorkbook()) { XSSFSheet sheet = workbook.createSheet("Sheet1"); // 填充数据... workbook.write(baos); return baos.toByteArray(); } catch (Exception e) { throw new RuntimeException("生成Excel失败", e); } } // 异常处理方法 private void handleException(HttpServletResponse response, Exception e) { try { response.setContentType("application/json"); response.setCharacterEncoding("UTF-8"); response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); Map<String, Object> error = new HashMap<>(); error.put("code", 500); error.put("message", "服务器内部错误"); error.put("detail", e.getMessage()); response.getWriter().write( new com.fasterxml.jackson.databind.ObjectMapper() .writeValueAsString(error) ); } catch (Exception ex) { // 处理异常时的异常 } } }

方案二:使用 ResponseEntity 统一返回

import org.springframework.http.*; import org.springframework.web.bind.annotation.*; import org.springframework.core.io.ByteArrayResource; @RestController @RequestMapping("/api/excel") public class ExcelExportController2 { @PostMapping("/export2") public ResponseEntity<?> exportExcel(@RequestBody ExportRequest request) { try { BusinessResult result = processBusiness(request); if (!result.isSuccess()) { // 返回失败的 JSON 响应 Map<String, Object> errorResponse = new HashMap<>(); errorResponse.put("code", 400); errorResponse.put("message", result.getErrorMessage()); errorResponse.put("timestamp", System.currentTimeMillis()); return ResponseEntity .status(HttpStatus.BAD_REQUEST) .contentType(MediaType.APPLICATION_JSON) .body(errorResponse); } // 生成 Excel byte[] excelData = generateExcel(result.getData()); // 设置响应头 String fileName = "export_" + System.currentTimeMillis() + ".xlsx"; HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_OCTET_STREAM); headers.setContentDisposition( ContentDisposition.attachment() .filename(fileName, StandardCharsets.UTF_8) .build() ); headers.setCacheControl("no-cache"); ByteArrayResource resource = new ByteArrayResource(excelData); return ResponseEntity.ok() .headers(headers) .contentLength(excelData.length) .body(resource); } catch (Exception e) { Map<String, Object> error = new HashMap<>(); error.put("code", 500); error.put("message", "导出失败"); error.put("detail", e.getMessage()); return ResponseEntity .status(HttpStatus.INTERNAL_SERVER_ERROR) .contentType(MediaType.APPLICATION_JSON) .body(error); } } }

辅助类定义

// 请求参数类 @Data public class ExportRequest { private String startDate; private String endDate; private List<Data> data; @Data public static class Data { private String name; private Integer value; } } // 业务结果类 @Data @AllArgsConstructor public class BusinessResult { private boolean success; private String errorMessage; private List<Data> data; public static BusinessResult success(String message, List<Data> data) { return new BusinessResult(true, message, data); } public static BusinessResult failure(String errorMessage, List<Data> data) { return new BusinessResult(false, errorMessage, data); } }

使用建议

  1. 方案一​ 更适合需要精细控制 HTTP 响应的场景

  2. 方案二​ 更符合 Spring 的编程风格,代码更简洁

  3. 文件命名:使用filename*=UTF-8''编码文件名,支持中文

  4. 响应头设置

    • 成功时设置application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    • 失败时设置application/json

  5. 异常处理:确保异常时也能返回规范的错误信息

客户端调用示例

// 前端调用 fetch('/api/excel/export', { method: 'POST', headers: { 'Content-Type': 'application/json', }, body: JSON.stringify({ startDate: '2024-01-01', endDate: '2024-12-31', data: [...] }) }) .then(async response => { const contentType = response.headers.get('content-type'); if (contentType.includes('application/json')) { // 错误响应 const error = await response.json(); console.error('导出失败:', error.message); } else if (contentType.includes('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')) { // Excel 文件 const blob = await response.blob(); const url = window.URL.createObjectURL(blob); const a = document.createElement('a'); a.href = url; a.download = '报表.xlsx'; a.click(); } });

这样设计可以确保:

  1. 成功时正确下载 Excel 文件

  2. 失败时返回结构化的错误信息

  3. 客户端可以根据 Content-Type 区分处理结果

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/23 13:49:03

TensorFlow在水资源管理中的智能调度

TensorFlow在水资源管理中的智能调度 当一场突如其来的暴雨即将侵袭某流域时&#xff0c;传统水利系统可能还在等待值班人员查看水位报表、召开调度会议、层层上报决策——而此时&#xff0c;下游的防洪准备或许已错过黄金窗口。但在一个基于TensorFlow构建的智能调度系统中&am…

作者头像 李华
网站建设 2026/4/25 12:03:14

揭秘MCP如何革命性提升RAG:从工具单一到智能选择

MCP驱动的智能体化RAG系统解决了传统RAG工具单一、缺乏判断的痛点。通过统一接口、模块化设计和智能路由机制&#xff0c;赋予AI"工具选择大脑"&#xff0c;使其能根据问题性质自动选择最佳工具链。该架构显著提升开发效率、优化性能&#xff0c;并拓展应用场景&…

作者头像 李华
网站建设 2026/4/26 17:56:28

基于STM32陀螺仪角度检测阈值报警水平仪系统设计

第一章 系统整体方案规划 本系统以STM32F103C8T6单片机为控制核心&#xff0c;融合陀螺仪角度检测、阈值设定、声光报警与水平状态显示功能&#xff0c;旨在实现物体水平度的精准监测与异常预警&#xff0c;适用于机械安装、建筑施工、设备校准等场景。核心目标是通过陀螺仪传感…

作者头像 李华
网站建设 2026/4/21 23:44:50

这个五层结构AI Enablement Stack,把真正可用的AI Agent技术栈生态讲透了

尽管已在AI开发领域投入了数十亿美元&#xff0c;但编码Agents仍受制于原始的工具。AI技术堆栈不断涌现&#xff0c;却没有一个是专门为编码Agents脱颖而出量身打造的。 如今&#xff0c;这些Agents面临着两大关键挑战。其一&#xff0c;Agents的编码方式就如同人类使用记事本…

作者头像 李华
网站建设 2026/4/22 20:18:08

AI Agent卡壳?不是模型不行,而是数据没准备好!AI-ready data全攻略

AI Agent落地应用遇到数据难题&#xff0c;AI-ready data提供新思路数据难题成为AI Agent应用拦路虎&#xff0c;AI-ready data为数据高效应用铺路AI-ready data成AI Agent落地最大障碍&#xff0c;技术供应商们怎么解决这个难题&#xff1f;解决了智能体数据安全问题&#xff…

作者头像 李华
网站建设 2026/4/26 9:20:22

2025最新!8个AI论文工具测评:研究生开题报告神器大公开

2025最新&#xff01;8个AI论文工具测评&#xff1a;研究生开题报告神器大公开 2025年AI论文工具测评&#xff1a;精准匹配学术需求的实用指南 在科研日益数字化的今天&#xff0c;研究生群体面临写作效率低、资料查找繁琐、格式规范难掌握等多重挑战。尤其在开题报告阶段&…

作者头像 李华