news 2026/4/19 23:51:46

Spring Boot 项目使用 EasyExcel 实现导出功能

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
Spring Boot 项目使用 EasyExcel 实现导出功能

你想要在 Spring Boot 项目中基于 EasyExcel 完整实现 Excel 导出功能,我会为你梳理一套标准化、可直接落地的实现方案,包含基础导出、字段控制、异常处理等核心内容,确保功能健壮且符合开发规范。
一、完整实现步骤

  1. 环境准备(引入依赖)
    在 pom.xml 中添加 EasyExcel 核心依赖(已兼容 Spring Boot 2.x/3.x):
<!-- EasyExcel 核心依赖 --><dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>3.3.2</version></dependency><!-- Lombok(简化实体类,可选) --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><!-- Web 依赖(Spring Boot 基础,若已引入可忽略) --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency>
  1. 定义导出实体类(控制导出字段)
    创建与 Excel 列映射的实体类,通过注解控制哪些字段导出、哪些忽略:
importcom.alibaba.excel.annotation.ExcelIgnore;importcom.alibaba.excel.annotation.ExcelProperty;importlombok.Data;/** * 导出实体类:用户信息 * 注解说明: * - @ExcelProperty:标注需要导出的字段,指定列名和列顺序 * - @ExcelIgnore:标注需要忽略的字段(不导出) */@DatapublicclassUserExportVO{// 导出:用户ID(第0列)@ExcelProperty(value="用户ID",index=0)privateLongid;// 导出:用户名(第1列)@ExcelProperty(value="用户名",index=1)privateStringusername;// 导出:用户状态(第2列)@ExcelProperty(value="用户状态",index=2)privateStringstatus;// 忽略:密码(不导出)@ExcelIgnoreprivateStringpassword;// 忽略:创建人(不导出)@ExcelIgnoreprivateStringcreateBy;}
  1. 编写业务层(模拟数据查询)
    模拟从数据库查询导出数据(实际项目替换为真实 DAO/MyBatis 查询):
importorg.springframework.stereotype.Service;importjava.util.ArrayList;importjava.util.List;@ServicepublicclassUserExportService{/** * 查询待导出的用户数据 * @return 导出数据列表 */publicList<UserExportVO>listExportData(){// 模拟数据库查询结果(实际项目替换为真实查询逻辑)List<UserExportVO>dataList=newArrayList<>();UserExportVOuser1=newUserExportVO();user1.setId(1L);user1.setUsername("张三");user1.setStatus("正常");user1.setPassword("123456");// 该字段会被忽略,不导出UserExportVOuser2=newUserExportVO();user2.setId(2L);user2.setUsername("李四");user2.setStatus("禁用");user2.setCreateBy("admin");// 该字段会被忽略,不导出dataList.add(user1);dataList.add(user2);returndataList;}}
  1. 编写导出接口(核心)
    通过 HttpServletResponse 将 Excel 流直接返回给前端,实现文件下载:
importcom.alibaba.excel.EasyExcel;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.bind.annotation.RestController;importjavax.annotation.Resource;importjavax.servlet.http.HttpServletResponse;importjava.net.URLEncoder;@RestController@RequestMapping("/api/export")publicclassExportController{@ResourceprivateUserExportServiceuserExportService;/** * 导出用户列表为 Excel 文件 * @param response 响应对象,用于输出 Excel 流 */@GetMapping("/user")publicvoidexportUserExcel(HttpServletResponseresponse){try{// 1. 设置响应头:告诉浏览器返回的是 Excel 文件,解决中文文件名乱码response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");response.setCharacterEncoding("UTF-8");// 文件名编码处理(兼容各浏览器)StringfileName=URLEncoder.encode("用户列表_"+System.currentTimeMillis(),"UTF-8").replaceAll("\\+","%20");response.setHeader("Content-Disposition","attachment;filename*=utf-8''"+fileName+".xlsx");// 2. 查询导出数据List<UserExportVO>exportData=userExportService.listExportData();// 3. 写入 Excel 并通过响应流返回EasyExcel.write(response.getOutputStream(),UserExportVO.class).sheet("用户数据")// Excel 工作表名称.doWrite(exportData);// 写入数据}catch(Exceptione){// 异常处理:返回友好提示(实际项目建议用全局异常处理器)response.reset();response.setContentType("application/json");response.setCharacterEncoding("UTF-8");try{response.getWriter().write("{\"code\":500,\"msg\":\"导出失败:"+e.getMessage()+"\"}");}catch(Exceptionex){ex.printStackTrace();}}}}
  1. 全局异常处理(可选,优化体验)
    创建全局异常处理器,统一处理导出过程中的异常:
importorg.springframework.web.bind.annotation.ExceptionHandler;importorg.springframework.web.bind.annotation.RestControllerAdvice;importjavax.servlet.http.HttpServletResponse;importjava.io.IOException;@RestControllerAdvicepublicclassExportExceptionHandler{/** * 处理导出相关异常 */@ExceptionHandler(Exception.class)publicvoidhandleExportException(HttpServletResponseresponse,Exceptione)throwsIOException{response.reset();response.setContentType("application/json");response.setCharacterEncoding("UTF-8");response.getWriter().write("{\"code\":500,\"msg\":\"Excel 导出失败:"+e.getMessage()+"\"}");}}

二、测试导出功能
启动 Spring Boot 项目;
访问接口:http://localhost:8080/api/export/user;
浏览器会自动下载名为「用户列表_时间戳.xlsx」的文件;
打开文件,仅包含「用户 ID」「用户名」「用户状态」3 列,password 和 createBy 字段未导出。
三、进阶优化(可选)

  1. 大数据量导出(避免内存溢出)
    若导出数据量超过 1 万条,使用「分批查询 + 数据监听器」:
// 替换 Controller 中的写入逻辑EasyExcel.write(response.getOutputStream(),UserExportVO.class).sheet("用户数据").doWrite(()->{// 分批查询数据(示例:每次查1000条)returnuserExportService.listExportDataByPage(1,1000);});
  1. 自定义 Excel 样式(表头 / 内容)
// 自定义样式示例WriteCellStyleheadStyle=newWriteCellStyle();headStyle.setFillForegroundColor(IndexedColors.LIGHT_BLUE.getIndex());// 表头背景色WriteFontheadFont=newWriteFont();headFont.setFontName("微软雅黑");headFont.setFontHeightInPoints((short)12);headStyle.setWriteFont(headFont);// 写入时指定样式EasyExcel.write(response.getOutputStream(),UserExportVO.class).registerWriteHandler(newHorizontalCellStyleStrategy(headStyle,newWriteCellStyle())).sheet("用户数据").doWrite(exportData);

总结
EasyExcel 实现导出的核心是:实体类注解映射列 + 响应流输出文件,未标注 @ExcelProperty 或标注 @ExcelIgnore 的字段会被忽略;
关键配置:必须设置正确的响应头(Content-Type/Content-Disposition),解决文件类型识别和中文文件名乱码问题;
健壮性优化:添加异常处理避免接口报错,大数据量场景需分批查询写入,防止内存溢出。
以上代码可直接复制到项目中,替换 UserExportService 中的模拟数据为真实业务查询,即可快速实现生产级的 Excel 导出功能。

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

[Web自动化] 爬虫之网络请求

9.4 爬虫之网络请求 9.4.1 使用requests库发送HTTP请求 requests库提供了丰富的功能来发送HTTP请求&#xff0c;并处理响应。以下是一些额外的示例和说明。 发送带参数的GET请求&#xff1a; 如果你需要向服务器发送查询参数&#xff0c;可以将它们作为字典传递给params参数。 …

作者头像 李华
网站建设 2026/4/19 1:35:49

08.05.01.tiptop webserver接口篇(制作接口:自定义查询)

本页目录&#xff1a; 1、写代码2、配置3、测试 写代码 修改注册服务接口代码&#xff1a;/u1/topprod/tiptop/aws/4gl/aws_ttsrv2_service.4gl 添加發佈 Service Function 段落 ----------------------- begin waichi001 --------------WHEN "aws_customizeQueryData&…

作者头像 李华
网站建设 2026/4/16 13:02:51

05. 如何实现原理图比较?| OrCAD X Capture CIS 设计小诀窍第二季

OrCAD X Capture CIS设计小诀窍系列--如何实现原理图比较背景介绍&#xff1a;我们在进行原理图设计时&#xff0c;经常需要对原理图进行版本更新。而如果设计师对最新版本的原理图不满意&#xff0c;想要回溯原理图修改了哪些内容&#xff0c;则需要进行原理图比较。而通过Cap…

作者头像 李华
网站建设 2026/4/18 6:15:18

Spring Boot的多环境配置

在开发Spring Boot项目中&#xff0c;如果我们想把自己的项目开源到Github仓库&#xff0c;application.yml中的某些配置比如MySQL、Redis的账户密码&#xff0c;还有的就是现在引入AI之后的一些密钥&#xff0c;可能都不太愿意推送到仓库去。 这个时候&#xff0c;可以通过配…

作者头像 李华
网站建设 2026/4/16 3:42:18

【双指针】判断是否为回文字符串

求解代码 public boolean judge(String str) {int n str.length(); // 获取字符串长度&#xff0c;用于定义右指针初始位置// 双指针遍历for (int i 0, j n - 1; i < j; i, j--) {// 逐位对比首尾字符&#xff0c;只要有一位不一致&#xff0c;直接判定不是回文if (str.c…

作者头像 李华
网站建设 2026/4/19 19:42:42

=========

---------

作者头像 李华