展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > Java+EasyExcel实现单个接口导出多个Excel的示例详解

Java+EasyExcel实现单个接口导出多个Excel的示例详解

一、核心问题与解决方案 在日常开发中,导出Excel是家常便饭,通常一个接口对应一个文件。但偶尔会遇到一些特殊场景——用户希望一次点击,就能同时拿到“用户列表”和“订单列表”这两份独立的数据报表。这该怎么实现呢? 这里有一个关键的技术前提需要明确:HTTP协议规定,单次响应只能返回一个字节流。这意味

本文目录

    一、核心问题与解决方案

    在日常开发中,导出Excel是家常便饭,通常一个接口对应一个文件。但偶尔会遇到一些特殊场景——用户希望一次点击,就能同时拿到“用户列表”和“订单列表”这两份独立的数据报表。这该怎么实现呢?

    这里有一个关键的技术前提需要明确:HTTP协议规定,单次响应只能返回一个字节流。这意味着,一个接口无法直接返回两个独立的文件。那么,如何绕过这个限制,满足用户“一次下载,多份文件”的需求呢?

    答案其实很经典:打包。将多个Excel文件打包成一个ZIP压缩包,接口返回这个ZIP流。用户下载后解压,就能得到所有独立的文件。这个方案既完全遵守HTTP规范,又完美解决了业务需求,是业界通用且稳妥的做法。

    二、前置准备:引入依赖

    工欲善其事,必先利其器。实现这个功能,我们需要三个核心依赖:处理Excel读写的EasyExcel、负责文件打包的Apache Commons Compress,以及构建Web接口的Spring Boot Web Starter。以下是Ma ven配置,使用Gradle的朋友可以自行转换。版本号建议与示例保持一致,以避免潜在的兼容性问题。

    
    
        com.alibaba
        easyexcel
      	4.0.3
    
    
    
        org.apache.commons
        commons-compress
        1.27.1
    
    
    
        org.springframework.boot
        spring-boot-starter-web
    

    三、步骤1:定义Excel对应的实体类

    数据是Excel的灵魂,而实体类就是数据的蓝图。假设我们要导出用户和订单两份数据,就需要为它们分别创建实体类。通过EasyExcel的@ExcelProperty注解,可以轻松定义最终在Excel表头中显示的名称。这里使用Lombok的@Data注解来简化代码,省去手写getter/setter的麻烦。

    3.1 用户实体类(UserData.ja va)

    import com.alibaba.excel.annotation.ExcelProperty;
    import lombok.Data;
    
    /**
     * 用户列表 Excel 对应的实体类
     */
    @Data
    public class UserData {
        // Excel 表头:用户ID
        @ExcelProperty("用户ID")
        private Long userId;
    
        // Excel 表头:用户名称
        @ExcelProperty("用户名称")
        private String userName;
    
        // Excel 表头:手机号
        @ExcelProperty("手机号")
        private String phone;
    }
    

    3.2 订单实体类(OrderData.ja va)

    import com.alibaba.excel.annotation.ExcelProperty;
    import lombok.Data;
    
    /**
     * 订单列表 Excel 对应的实体类
     */
    @Data
    public class OrderData {
        // Excel 表头:订单ID
        @ExcelProperty("订单ID")
        private String orderId;
    
        // Excel 表头:用户ID(关联用户表)
        @ExcelProperty("用户ID")
        private Long userId;
    
        // Excel 表头:订单金额
        @ExcelProperty("订单金额")
        private Double amount;
    
        // Excel 表头:创建时间
        @ExcelProperty("创建时间")
        private String createTime;
    }
    

    四、步骤2:封装通用工具类(核心)

    为了避免在每一个导出接口里重复编写打包和设置响应头的代码,封装一个通用的工具类是明智之举。这个ExcelZipExportUtil工具类将核心逻辑收拢,后续无论导出多少个Excel文件,都可以直接调用,代码复用率极高。

    import com.alibaba.excel.EasyExcel;
    import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
    import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
    
    import ja vax.servlet.ServletOutputStream;
    import ja vax.servlet.http.HttpServletResponse;
    import ja va.io.ByteArrayOutputStream;
    import ja va.net.URLEncoder;
    import ja va.util.List;
    
    /**
     * EasyExcel 多文件导出 ZIP 工具类(通用可复用)
     */
    public class ExcelZipExportUtil {
    
        /**
         * 将单个 Excel 文件写入 ZIP 输出流
         * @param zipOut ZIP 输出流
         * @param excelFileName 单个 Excel 的文件名(如:用户列表.xlsx)
         * @param data Excel 中的数据列表
         * @param clazz Excel 对应的实体类(用于解析表头)
         */
        public static  void writeExcelToZip(ZipArchiveOutputStream zipOut, String excelFileName,
                                               List data, Class clazz) throws Exception {
            // 1. 临时存储 Excel 内容(内存级,不写入磁盘,性能更高)
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            // 2. 使用 EasyExcel 写入数据(sheet1 是工作表名称,可自定义)
            EasyExcel.write(bos, clazz)
              			// 不要自动关闭,交给 Servlet 自己处理
                    .autoCloseStream(false) 
              			// 基于 column 长度,自动适配。最大 255 宽度
                    .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()) 
              			// 避免 Long 类型丢失精度
                    .registerConverter(new LongStringConverter()) 
              			// 工作表名称
                    .sheet("sheet1") 
                    .doWrite(data);
    
            // 3. 将 Excel 作为 ZIP 的一个条目写入
            zipOut.putArchiveEntry(new ZipArchiveEntry(excelFileName));
            zipOut.write(bos.toByteArray());
            zipOut.closeArchiveEntry(); // 关闭当前 ZIP 条目(必须,否则后续条目无法写入)
    
            // 4. 关闭临时流
            bos.close();
        }
    
        /**
         * 初始化 HTTP 响应头(设置 ZIP 下载、解决中文文件名乱码)
         * @param response 响应对象
         * @param zipFileName 最终下载的 ZIP 压缩包名称(如:用户订单数据.zip)
         */
        public static void initZipResponse(HttpServletResponse response, String zipFileName) throws Exception {
            // 设置响应类型为 ZIP
            response.setContentType("application/zip");
            // 设置下载头,URLEncoder.encode 解决中文文件名乱码(兼容所有浏览器)
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(zipFileName, "UTF-8"));
            // 禁止缓存(避免浏览器缓存旧文件)
            response.setHeader("Pragma", "no-cache");
            response.setHeader("Cache-Control", "no-cache");
        }
    }
    

    五、步骤3:接口层实现(最终落地)

    工具类准备好后,接口层的实现就变得非常清晰。在Controller中,我们模拟构造数据(实际项目替换为数据库查询),然后调用工具类完成打包和响应。整个过程一气呵成,用户通过一次请求就能下载到包含多个Excel的ZIP包。

    import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import ja vax.servlet.http.HttpServletResponse;
    import ja va.util.ArrayList;
    import ja va.util.List;
    
    /**
     * Excel 导出接口控制器
     */
    @RestController
    @RequestMapping("/export")
    public class ExcelExportController {
    
        /**
         * 单个接口导出两个 Excel 文件(打包成 ZIP 下载)
         * 访问地址:http://localhost:8080/export/twoExcel
         */
        @GetMapping("/twoExcel")
        public void exportTwoExcel(HttpServletResponse response) {
            try {
                // 1. 初始化响应头,设置 ZIP 压缩包名称(用户下载时显示的文件名)
                ExcelZipExportUtil.initZipResponse(response, "用户订单数据.zip");
                // 2. 获取 HTTP 响应输出流,关联 ZIP 输出流
                ServletOutputStream servletOut = response.getOutputStream();
                ZipArchiveOutputStream zipOut = new ZipArchiveOutputStream(servletOut);
    
                // 3. 构造第一个 Excel 的数据(用户列表,实际项目中替换为数据库查询)
                List userList = new ArrayList<>();
                // 3.1 完善数据逻辑省略
    
                // 4. 构造第二个 Excel 的数据(订单列表,实际项目中替换为数据库查询)
                List orderList = new ArrayList<>();
    						// 4.1 完善数据逻辑省略
    
                // 5. 关键操作:将两个 Excel 分别写入 ZIP 流
                ExcelZipExportUtil.writeExcelToZip(zipOut, "用户列表.xlsx", userList, UserData.class);
                ExcelZipExportUtil.writeExcelToZip(zipOut, "订单列表.xlsx", orderList, OrderData.class);
    
                // 6. 关闭流(顺序不能错!否则 ZIP 包会损坏,无法解压)
                zipOut.finish(); // 完成 ZIP 写入
                zipOut.close();
                servletOut.flush();
                servletOut.close();
    
            } catch (Exception e) {
                e.printStackTrace();
                // 实际项目中建议自定义异常处理,给前端返回明确的错误提示
                response.setStatus(500);
            }
        }
    }
    

    六、关键注意事项(避坑重点)

    这部分内容至关重要,很多开发者在实现后遇到ZIP包损坏、文件名乱码等问题,根源往往在于忽略了以下细节。

    1. 流的关闭顺序:这是最容易出错的地方。必须严格按照zipOut.closeArchiveEntry() -> zipOut.finish() -> 关闭其他流的顺序操作。顺序一旦颠倒,生成的ZIP包很可能无法正常解压。
    2. 中文文件名乱码:通过URLEncoder.encode(fileName, "UTF-8")对文件名进行编码,这是确保在Chrome、Firefox、Edge等所有主流浏览器中都能正确显示中文名的标准做法。
    3. Excel写入方式:示例中采用了ByteArrayOutputStream在内存中生成Excel内容,避免了不必要的磁盘I/O操作,性能更优。不推荐先写入临时磁盘文件再打包的方式。
    4. 异常处理:示例中的printStackTrace()仅用于演示。在生产环境中,务必使用全局异常处理器或更优雅的方式,向前端返回友好的错误信息,例如“导出失败,请稍后重试”,以提升用户体验。

    七、扩展:导出更多Excel文件

    这个方案的扩展性极佳。如果需要导出三个、四个甚至更多Excel文件,完全无需修改工具类,只需在接口中继续调用ExcelZipExportUtil.writeExcelToZip()方法即可。

    例如,新增一个“商品列表”的导出:

    // 新增商品列表数据(假设已有 GoodsData 实体类)
    List goodsList = new ArrayList<>();
    // ... 构造商品数据
    
    // 新增一个 Excel 写入 ZIP 流
    ExcelZipExportUtil.writeExcelToZip(zipOut, "商品列表.xlsx", goodsList, GoodsData.class);
    

    八、测试效果验证

    代码完成后,可以通过以下几个步骤验证功能是否正常:

    1. 启动Spring Boot项目,访问接口地址:http://localhost:8080/export/twoExcel(端口号请根据实际配置调整);
    2. 浏览器会自动弹出下载对话框,文件名为“用户订单数据.zip”;
    3. 下载完成后解压ZIP包,应该能得到“用户列表.xlsx”和“订单列表.xlsx”两个文件;
    4. 打开Excel文件,核对表头和数据是否与代码中模拟的测试数据一致。

    九、总结

    回顾整个方案,其实可以清晰地归纳为三个步骤:

    1. 准备:引入必要的依赖,定义好数据实体类。
    2. 封装:构建通用的ZIP打包工具类,处理响应头设置和文件写入逻辑。
    3. 调用:在业务接口中组织数据,调用工具类生成并返回ZIP流。

    该方案设计通用,可直接复用于任何Spring Boot项目,能够支持任意数量的Excel文件导出。同时,它已经规避了流关闭顺序、中文乱码等常见“坑点”。如果你在项目中遇到类似的多文件导出需求,不妨直接采用这套经过验证的代码方案。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 Excel
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirServer Windows版
    AirServer Windows版

    AirServer Windows版可把电脑变成AirPlay、Google Cast和Miracast无线投屏接收端,适合会议演示、课堂教学及家庭大屏分享。发送设备通常无需另装客户端,并可同时接收和智能排列多个镜像会话。