百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

Springboot+Easyexcel将数据写入模板文件并导出Excel

liuian 2025-02-08 11:50 16 浏览

Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存,poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题,但POI还是有一些缺陷,比如07版Excel解压缩以及解压后存储都是在内存中完成的,内存消耗依然很大。easyexcel重写了poi对07版Excel的解析,一个3M的excel用POI sax解析依然需要100M左右内存,改用easyexcel可以降低到几M,并且再大的excel也不会出现内存溢出;03版依赖POI的sax模式,在上层做了模型转换的封装,让使用者更加简单方便。

本文使用easyexcel对excel文件进行操作,来实现数据以excel形式导出的功能。

需求背景:

针对用户选择的数据,利用现有的excel模板,实现批量导出的功能。比如CSDN也有类似的批量导出数据功能,这里需要导出时,按照模板文件的字段导出。

现有模板字段:

实现方式:springboot+easyexcel

一、导入依赖



    org.projectlombok
    lombok




    com.alibaba
    easyexcel
    3.0.5


二、根据excel表头创建对应的实体类Pojo

ExcelTitile实体类

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class ExcelTitle {

    @ExcelProperty(value="事件名称", index=0)
    private String eventName;

    @ExcelProperty(value="需求负责人", index=1)
    private String prdManager;

    @ExcelProperty(value="技术负责人", index=2)
    private String techManager;

    @ExcelProperty(value="文档链接", index=3)
    private String prdDocs;

    @ExcelProperty(value="数据链接", index=4)
    private String statsDocs;

    @ExcelProperty(value="统计口径", index=5)
    private String reportCaliber;

这里采用了@ExcelProperty的注解,其中value表示列名,index表示列名的索引值。@Data 注解的主要作用是提高代码的简洁,使用这个注解可以省去代码中大量的get()、 set()、 toString()等方法;

三、Controller类接收请求

@RequestMapping(value = "/bulkOutput", method = RequestMethod.GET)
    public ResultBean bulkOutput(HttpServletResponse response) {

        // 重要! 设置返回格式是excel形式
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        // 设置编码格式
        response.setCharacterEncoding("utf-8");
        // 设置URLEncoder.encode 防止中文乱码
        String fileName = null;
        try {
            fileName = URLEncoder.encode("数据批量导出", "UTF-8").replaceAll("\\+", "%20");
        // 设置响应头
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");

        List bulkOutputData = wildEventService.getBulkOutputData();

        // 模板文件保存在springboot项目的resources/static下
        Resource resource = new ClassPathResource("static/数据批量导出模板.xlsx");

        ExcelWriter excelWriter = EasyExcel.write(response.getOutputStream())
                                           .withTemplate(resource.getInputStream()) // 利用模板的输出流
                                           .build();
        // 写入模板文件的第一个sheet 索引0    
        WriteSheet writeSheet = EasyExcel.writerSheet(0).build();

        // 将数据写入到模板文件的对应sheet中
        excelWriter.write(bulkOutputData, writeSheet);
        excelWriter.finish();
        } catch (UnsupportedEncodingException e) {
            return ResultBean.errorService(e.getMessage());
        } catch (IOException e) {
            return ResultBean.errorService(e.getMessage());
        }
        return ResultBean.success("数据导出成功!");
    }

上述代码中,首先对response进行了设置,设置了返回类型,响应头,以及导出下载时的文件名称。接下来,利用Resource resource = new ClassPathResource("static/数据批量导出模板.xlsx"); 读取项目下的模板文件,并调用easyexcel的写入方法。这里write(response.getOutputStream())表示写入response的输出流,即将文件返回给客户端进行下载withTemplate(resource.getInputStream())表示读取模板文件进行写入。最后调用 WriteSheet writeSheet = EasyExcel.writerSheet(0).build();将苏剧写入模板文件的第一个sheet中(索引从0开始)。

四、Service层获取待写入数据

这里为了简易期间,构造一些数据如下

import com.example.demo.Pojo.ExcelTitle;
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.List;

@Service
public class BulkOutputService {

    public List getOutputData()
    {

        List resultList = new ArrayList<>();

        // 第一行数据
        ExcelTitle t1 = new ExcelTitle();
        t1.setEventName("测试数据1");
        t1.setTechManager("张三");
        t1.setPrdManager("张三");
        t1.setPrdDocs("http://prdDocs.com");
        t1.setStatsDocs("http://statsDocs.com");
        t1.setReportCaliber("reportCaliber");

        // 第二行数据
        ExcelTitle t2 = new ExcelTitle();
        t2.setEventName("测试数据2");
        t2.setTechManager("李四");
        t2.setPrdManager("李四");
        t2.setPrdDocs("http://prdDocs.com");
        t2.setStatsDocs("http://statsDocs.com");
        t2.setReportCaliber("reportCaliber");

        resultList.add(t1);
        resultList.add(t2);

        return resultList;
    }

}

这里构造了两行简易数据,实际场景中只需要根据自己的数据做替换就可以了。

有了上述步骤,就可以接下来执行代码查看导出效果了。

效果展示

启动springboot程序,在浏览器中输入请求:
http://localhost:8080/bulkOutput, 可以发现返回的excel文件被浏览器下载,打开后内容如下:

可以看到,数据根据模板格式写入了文件,并以excel的形式导出。初步完成了我们预定的场景。

总结

本次实现的功能是利用现有模板,将数据批量导出成excel,借助于easyexcel来实现操作excel的功能。最重要的功能模块是Controller里的内容。

需要注意

  1. 需要加上response的响应类型和响应头来使得返回请求返回excel文件
  2. 写到Web流时,这里的ContentType和CharacterEncoding不要乱码,否则很容易乱码或者文件损坏
  3. 使用EasyExcel.withTemplate引入模板的输入流

相关推荐

基于STM32的四旋翼飞行器控制系统设计

摘要:四旋翼飞行器控制系统的性能决定了飞行效果的优劣,如何改善飞行控制系统使其拥有更良好的表现成为近几年的研究热点。根据四旋翼飞行器的飞行原理,设计了一种新型四旋翼飞行器控制系统。该系统以STM32...

单片机差分升级(STM32,M0,M3,M4适用)

参考文档:https://blog.csdn.net/darling757267/article/details/80652267https://www.cnblogs.com/idreamo/p/9...

STM32入门: Step3 UART简介(stm32的uart和usart)

Step3UART简介UART和新板介绍34分钟目标描述完成本教程后,您将:熟悉L475IoTNodeDiscovery板,了解如何在以下位置对RS232串行链路进行编程和使用:以前使...

如何使用GCC手动编译stm32程序(如何在gcc上编译并运行代码)

如何不使用任何IDE(集成开发环境)编译stm32程序?集成开发环境将编辑器、编译器、链接器、调试器等开发工具集成在一个统一的软件中,使得开发人员可以更加简单、高效地完成软件开发过程。如果我们不使用K...

STM32单片机从零开始使用教程(二) 使用Cube搭建跑马灯工程并下载

通过cube建立工程RCC设置为外部晶振高速晶振对应的引脚会亮起进入clockconfiguration进行时钟配置,输入频率8M盒子PLLSourceMu改为使用外部时钟HSE,系统时钟Sys...

超详细的FreeRTOS移植全教程——基于stm32

准备在移植之前,我们首先要获取到FreeRTOS的官方的源码包。这里我们提供两个下载链接:一个是官网:http://www.freertos.org/另外一个是代码托管网站:https://sourc...

用ESP32和STM32设计了一块主控板,却用来养鱼?

前言我做了一个智能鱼缸系统的控制板。基于ESP32和STM32设计。成本不到200元。全文导航功能描述、电路设计图、主要模块选型、软件说明、获取开源资料、结语。功能描述①自动投食。②自动过滤供氧。③灯...

STM32物联网套件基础版03-控制继电器

前言继电器是一个生活中比较常用的元器件,有了继电器,我们可以使用单片机输出的低电平控制高电平期间工作,比如继电器接到220V用电器上,可通过单片机智能控制用电器,本节我们开始正式学习如何使用继电器。一...

STM32单片机详细教学(三):STM32单片机的开发方法

大家好,今天给大家介绍STM32单片机的开发方法,文章末尾附有本毕业设计的论文和源码的获取方式,可进群免费领取。前言经过前两章节对STM32的简单介绍,在接下来的几个章节中开始进行STM32单片机的软...

原来STM32单片机的开发如此的简单

大家好,我是华维今天我们讲下用STM32CubeMX和Keil5点亮一个LED,这个项目比较简单,大家都可以尝试下。这个就是我们今天的主角,这款单片机芯片是STM32F030K6T6。这个开发板非常简...

STM32 F103 使用HAL库配置PVD(stm32l0 hal库)

PVD(ProgrammableVotageDetector),即可编程电压监测器PVD可以检测电压变化并触发中断,一般用于判断断电并进行数据保存工程是使用STM32CubeMx生成的,在ST...

STM32F4芯片嵌入式学习7(stm32f4芯片包安装)

文档是本人学习总结的文档,有些乱,勿怪。1、STM32F407时钟系统在STM32F4中,有5个最重要的时钟源,为HSI、HSE、LSI、LSE、PLL。其中PLL实际是分为两个时钟源,...

ARM和STM32,嵌入式是什么关系(arm嵌入式和单片机的区别)

ARM,STM和嵌入式的关系就是上图,其中ARM负责内核架构,指令集的设计,提供给IC设计厂商内核和编译器等支持(如ARM11,Cortex-M,Cortex-A系列处理器)STM32是基于ARM...

STM32CUBEMX 使用教程2 — GPIO的使用、输入/输出

学习和使用任何一款MCU,最初开始往往都是从GPIO入手的,学会如何配置IO,能让IO输出想要的电平状态,能读取IO口的电平。本篇介绍一下STM32的GPIO。GPIO(General-Purpose...

入手STM32单片机的知识点总结(stm32单片机的介绍)

文章下方附学习资源,自助领取本文将以STM32F10x为例,对标准库开发进行概览。主要分为三块内容:STM32系统结构寄存器通过点灯案例,详解如何基于标准库构建STM32工程STM32系统结构上图,S...