阿里巴巴EasyExcel轻松使用（上篇）

已于 2024-06-18 19:41:47 修改
阅读量923 收藏 20
点赞数 12
分类专栏： 后端 文章标签： java excel
于 2024-06-15 21:29:45 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_40484820/article/details/139708662
版权

一、业务背景

​       项目组维护系统接到一个excel导出的功能，要求导出模板带有用户基础信息，管理员将其他信息补充完整后再次导入到系统当中，然后在列表展示相关信息。初次接到需求后想到使用Apache POI、jxl等框架来实现，但是考虑到表结构比较复杂，用这些框架会写大量的代码，再者，我们的业务系统数据量非常庞大，他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。那有没有一种开源的、使用轻便的、且不会OOM的excel处理工具呢？，没错，就是EasyExcel！
​      EasyExcel是阿里巴巴开源的一款excel处理框架，它重写了poi对07版Excel的解析，一个3M的excel用POI sax解析需要100M左右内存，改用easyexcel可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便

二、使用过程

2.1 jar包引入

​       使用EasyExcel只需引入一个jar包就可以，非常简单。EasyExcel导出有很多方式，这里我们讲解常用的web直接导出和web模板填充导出。这里的jar包版本请根据自己需要选择合适的版本，一般选择最新版本。

 <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>easyexcel</artifactId>
        <version>x.x.x</version>
    </dependency>
2.2 实体类

 ​      这里的实体类是与excel表头字段是一一对应的，通过@ExcelProperty(value = “”, index = ) 和excel表头进行关联，value为excel表头字段，index 为excel表头字段下标位置，当存在相同的表头内容，就可以使用index下标进行区分。以下为示例代码：

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

import java.time.LocalDateTime;

@Data
public class DemoDate {
    @ExcelProperty(value = "字符串标题",index = 0)
    private String string;
    @ExcelProperty(value = "日期标题",index = 1)
    private LocalDateTime localDateTime;
    @ExcelProperty(value = "数字标题",index = 2)
    private double doubleValue;
}

​ excel文件示例：
在这里插入图片描述

如果存在复杂表头，也可以使用 @ExcelProperty(value = “xxx”,index = xxx)来完成，复杂表头excel示例：
在这里插入图片描述
对应的实体写法：

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

import java.time.LocalDateTime;

@Data
public class DemoDate {
    @ExcelProperty(value = {"字符串","字符串标题"},index = 0)
    private String string;
    @ExcelProperty(value = {"其他","日期标题"},index = 1)
    private LocalDateTime localDateTime;
    @ExcelProperty(value = {"其他","数字标题"},index = 2)
    private double doubleValue;
}
2.3 直接导出

 ​      直接导出就是不使用提供的模板导出数据到excel，优点是直接导出表头信息灵活可变，可根据实体里面的字段控制导出表头信息。缺点也非常明显，这种导出方式excel样式、公式等信息需要自己用代码去实现，非常繁琐。以下是直接导出的Java代码：

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.alibaba.excel.util.MapUtils;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.fill.FillConfig;
import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.core.io.ClassPathResource;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.net.URLEncoder;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;


@RestController
@RequestMapping("/incomeExcel")
@Slf4j
public class BasicFamilyIncomeExcelController {
    @Resource
    private XXXExcelService XXXExcelService;

    /**
     * 下载模版
     *
     */
    @GetMapping("/download")
    public void exportExcel(HttpServletResponse response) throws Exception {
        try {
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.setCharacterEncoding("utf-8");
            String fileName = URLEncoder.encode("xxxx", "UTF-8").replaceAll("\\+", "%20");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
            // 这里需要设置不关闭流
            try (ExcelWriter excelWriter =
EasyExcel.write(response.getOutputStream(),DemoData.class).excelType(ExcelTypeEnum.XLSX).autoCloseStream(Boolean.FALSE).build()) {
                WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
                // 查询导出总条数
                int totalData = XXXExcelService.getExportCounts();
                //分页查询,每次查询100条
                int totalPages = (int) Math.ceil((double) totalData / 50);
                for (int i = 1; i <= totalPages; i++) {
                    int pageNO = i;
                    int pageSize = 100;
                    List<DemoData> datas = XXXExcelService.selectXXXlist(pageNO,pageSize);
                    excelWriter.fill(datas, fillConfig, writeSheet);
                }
            }
        } catch (Exception e) {
            log.error("下载模板文件失败", e);
            // 重置response
            response.reset();
            response.setContentType("application/json");
            response.setCharacterEncoding("utf-8");
            Map<String, String> map = MapUtils.newHashMap();
            map.put("status", "failure");
            map.put("message", "下载模板文件失败" + e.getMessage());
            response.getWriter().println(JSON.toJSONString(map));
        }
    }
}

       这里是写回浏览器的代码部分，固定的格式，fileName为导出模板的名称，使用了UTF8编码，避免了乱码。

response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
String fileName = URLEncoder.encode("xxxx", "UTF-8").replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");

       这块代码是实现文件导出的核心功能，首先使用 try() 将流包起来，这样就不用去主动关闭了。DemoData.class为实体类，里面的字段一一对应excel头部字段。excelType(ExcelTypeEnum.XLSX)为导出excel的后缀类型。为了避免一次性查询出太多数据量造成OOM，这里使用了分页查询，每次分页查询出的数据分批量写入excel从而减轻内存压力。

// 这里需要设置不关闭流
            try (ExcelWriter excelWriter =
EasyExcel.write(response.getOutputStream(),DemoData.class).excelType(ExcelTypeEnum.XLSX).autoCloseStream(Boolean.FALSE).build()) {
                WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
                // 查询导出总条数
                int totalData = XXXExcelService.getExportCounts();
                //分页查询,每次查询100条
                int totalPages = (int) Math.ceil((double) totalData / 50);
                for (int i = 1; i <= totalPages; i++) {
                    int pageNO = i;
                    int pageSize = 100;
                    List<DemoData> datas = XXXExcelService.selectXXXlist(pageNO,pageSize);
                    excelWriter.write(datas, writeSheet);
                }
            }
2.3 模板填充导出

       所谓模板填充导出就是自己原先将excel模板写好，然后将查出数据直接填充到模板excel对应的列当中就行了，这样做的好处就是可以不用去设置模板excel样式，公式等内容，直接把数据灌入就行。缺点就是不够灵活，只能按照预先设定好的模板进行导出。但是一般情况下，系统业务稳定后，模板也不会发生变化。故推荐这种导出方式。

下面是模板excel导出的代码：

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.alibaba.excel.util.MapUtils;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.fill.FillConfig;
import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.core.io.ClassPathResource;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.net.URLEncoder;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;


@RestController
@RequestMapping("/incomeExcel")
@Slf4j
public class BasicFamilyIncomeExcelController {
    @Resource
    private XXXExcelService XXXExcelService;

    /**
     * 下载模版
     *
     */
    @GetMapping("/download")
    public void exportExcel(HttpServletResponse response) throws Exception {
        try {
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.setCharacterEncoding("utf-8");
            String fileName = URLEncoder.encode("xxxx", "UTF-8").replaceAll("\\+", "%20");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
            //获取模版
            ClassPathResource classPathResource = new ClassPathResource("/template/xxx.xlsx");
            InputStream templateInputStream = classPathResource.getInputStream();
            // 这里需要设置不关闭流
            try (ExcelWriter excelWriter =
EasyExcel.write(response.getOutputStream()).withTemplate(templateInputStream).excelType(ExcelTypeEnum.XLSX).autoCloseStream(Boolean.FALSE).build()) {
                //配置多组数据填充完后，需要换行，防止覆盖模板中的单组数据模板
                FillConfig fillConfig = FillConfig.builder().forceNewRow(true).build();
                WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
                // 查询导出总条数
                int totalData = XXXExcelService.getExportCounts();
                //分页查询,每次查询100条
                int totalPages = (int) Math.ceil((double) totalData / 50);
                for (int i = 1; i <= totalPages; i++) {
                    int pageNO = i;
                    int pageSize = 100;
                    List<DemoData> datas = XXXExcelService.selectXXXlist(pageNO,pageSize);
                    excelWriter.fill(datas, fillConfig, writeSheet);
                }
            }
        } catch (Exception e) {
            log.error("下载模板文件失败", e);
            // 重置response
            response.reset();
            response.setContentType("application/json");
            response.setCharacterEncoding("utf-8");
            Map<String, String> map = MapUtils.newHashMap();
            map.put("status", "failure");
            map.put("message", "下载模板文件失败" + e.getMessage());
            response.getWriter().println(JSON.toJSONString(map));
        }
    }
}

       这里是获取模板流的过程:

	ClassPathResource classPathResource = new ClassPathResource("/template/xxx.xlsx");
	InputStream templateInputStream = classPathResource.getInputStream();

       这里是填充模板的过程，和直接导出不同的是，创建excelWriter 多了.withTemplate(templateInputStream)这句话，最后填充模板的方法使用fill(datas, fillConfig, writeSheet)来完成，而直接导出使用 excelWriter.write(datas, writeSheet);fillConfig用来填充数据的时候,如果模版里面有事先写好的数据,为了避免模版填充的时候覆盖原来的数据,故使用fillConfig,每次填充完,写有数据的一行会往下走一行。

             // 这里需要设置不关闭流
            try (ExcelWriter excelWriter =
EasyExcel.write(response.getOutputStream()).withTemplate(templateInputStream).excelType(ExcelTypeEnum.XLSX).autoCloseStream(Boolean.FALSE).build()) {
                //配置多组数据填充完后，需要换行，防止覆盖模板中的单组数据模板
                FillConfig fillConfig = FillConfig.builder().forceNewRow(true).build();
                WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
                // 查询导出总条数
                int totalData = XXXExcelService.getExportCounts();
                //分页查询,每次查询100条
                int totalPages = (int) Math.ceil((double) totalData / 50);
                for (int i = 1; i <= totalPages; i++) {
                    int pageNO = i;
                    int pageSize = 100;
                    List<DemoData> datas = XXXExcelService.selectXXXlist(pageNO,pageSize);
                    excelWriter.fill(datas, fillConfig, writeSheet);
                }
            }

       填充模版示例。如下图所示，在对应的表头下面用{.xxx}方式填充模板，xxx是实体对应的字段，这种方式适用于返回数据是集合的形式。如果返回的是单个实体数据，那么使用{xxx}的方式，和前面的区别就是少了一个 .
在这里插入图片描述

三、使用总结

       EasyExcel是一款简单易用的excel处理框架，有着非常优秀的数据流处理能力，它帮我屏蔽了底层处理excel的复杂API，让excel处理变的高效。我出的这篇教程希望能帮助到大家，后面我将出EasyExcel的导入功能，敬请期待。。。

屿丶斐然
关注
  • 12
    点赞
  • 踩
  • 20
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
EasyExcel的jar包 和 使用
weixin_72979483的博客
03-01 3283
easyexcel的jar包资源
easyExcel的简单使用
weixin_45441597的博客
02-23 930
【代码】easyExcel的简单使用。
使用 EasyExcel 按模板生成 .xls,在转成PDF文件 附带jar包
zhoulijia666的博客
10-25 1325
excelWriter 如何获取 InputStream 问题。1.导包 meven 库下载不了该jar 所以需要在项目里指定路径。今天有需求做这么个功能，磕磕绊绊，记录一下一后好找。背景：SpringBoot。
easyExcel所需jar包
05-30
easyExcel所需jar包
阿里巴巴EasyExcel使用示例
01-03
该压缩包解压后，含阿里巴巴easyexcel的简单使用示例的部分代码。 含：下载导入模板，通过模板导入（含单元格的合并操作），导出（用指定模板导出），controller，实体，监听等文件 使用说明解压后的文件中已经包含...
使用阿里巴巴的EasyExcel库将数据和图片导出到一个Excel文件
最新发布
05-07
它展示了如何使用EasyExcel库来处理复杂的Excel文件导出任务，包括自定义列宽和图片布局。可以参考博客链接 https://blog.csdn.net/xiaosemei/article/details/127671561 有具体的效果，及代码实例
excel-spring-boot-starter：阿里巴巴Easyexcel Spring Boot Starter
02-05
EasyExcel EasyExcel是一个基于Java的简单，省内存的读写... ，当然还有急速模式能恢复，但是内存占用会在100M多一点Spring Boot Stater依赖方便在web环境下使用easyexcel ，已上传至maven仓库< dependency> < groupId>...
easyexcel-2.2.11.jar
05-10
EasyExcel是阿里巴巴开源的一个Excel处理框架，使用简单、节省内存。节省内存的原理也很简单，在解析Excel时没有将文件数据全部加载到内存当中，而是从磁盘文件中一行行读取。
阿里EasyExcel导出案例
01-19
阿里EasyExcel导出案例
easyexcel需要的jar.zip
04-20
webproject 使用easyexcel 需要放进bin的jar包
easyexcel处理jar包
09-22
ava解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，能够原本一个3M的excel用POI sax依然需要100M左右内存降低到KB级别，并且再大的excel不会出现内存溢出，03版依赖POI的sax模式。在上层做了模型转换的封装，让使用者更加简单方便
easyexcel 简介、中文文档、中英对照文档 下载
寒水馨
01-19 1149
easyexcel 简介、中文文档、中英对照文档 下载；easyexcel、com.alibaba、中文文档、中英对照文档、下载、包含jar包、原API文档、源代码、Maven依赖信息文件、翻译后的API文档、alibaba、easyexcel、jar包、java、中英对照文档；
java如何处理Excel-(easyexcel)
热门推荐
Silas 蝈蝈 博客
11-24 1万+
最近有一个需求需要处理Excel,当初还以为Excel有多难呢，没想到早有人在我们前面就把路给我们铺好了这里给一个官方的git。
通过修改包名解决引用EASYEXCEL的POI版本冲突问题(转载)
topnoble的博客
08-23 693
由于业务需要,引入easyExcel。easyExcel最低依赖版本是3.17,系统中已经存在3.9版本,排除依赖有些类无法找到，导致jar包冲突无法共存。寻求解决方案时，实践可通过修改jar包路径达到目的。在此对过程做一下记录。
maven离线安装easyexcel要把easyexcel内部依赖的jar包一并导入
Leanne111的博客
12-06 2469
以easyexcel2.2.6为例，其内部依赖的jar包包括以下 test注释以上的依赖都需要离线状态下一并导入。此外，还要注意上面的内部依赖是否还有内部依赖，若有也需要一并导入。 在有网状态下的正常运行maven工程可以查看一个依赖的内部依赖。直接按住ctrl+鼠标左键即可。 ...
EasyExcel实现Excel文件多sheet导入导出
笑不语的博客
05-03 6042
一、概述 最近公司需要做一个需求，通过excel上传病例信息，并将病例信息进行归档和整理；该需求可以简化为excel模板下载和excel上传并解析归档。既然知道需求了，找excel的操作工具jar包吧，发现以前常用的poi需要写的代码太多，但是时间紧急，没办法只能找新的工具。easypoi 在读写数据的时候，优先是先将数据写入内存，优点是读写性能非常高，但是当数据量很大的时候，会出现oom，当然它也提供了 sax 模式的读写方式，需要调用特定的方法实现。病例的信息量可能会很大，很有可能会造成内存溢出，没办法
利用阿里EasyExcel实现excel的生成并下载
Peacock__的博客
06-10 2043
Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，能够原本一个3M的excel用POI sax依然需要10...
阿里easyExcel使用—上（1.1.2-beta5版本）
博渊的博客
10-29 3948
源码地址：https://github.com/alibaba/easyexcel 一、jar包依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>1.1.2-beta...
easyexcel 驼峰
04-11
EasyExcel是一款基于Java的开源Excel操作工具，它提供了简单易用的API，可以方便地读取、写入和操作Excel文件。EasyExcel支持驼峰命名方式，即可以通过注解来指定Java对象与Excel文件之间的映射关系，实现对象与Excel数据的互相转换。 使用EasyExcel进行驼峰命名的步骤如下： 1. 在Java对象的属性上使用注解`@ExcelProperty`，指定属性与Excel列的映射关系。例如： ```java public class User { @ExcelProperty("姓名") private String name; @ExcelProperty("年龄") private Integer age; // 其他属性... } ``` 2. 在读取或写入Excel时，通过`EasyExcel`类提供的API来操作。例如： - 读取Excel文件： ```java List<User> userList = EasyExcel.read("user.xlsx").head(User.class).sheet().doReadSync(); ``` - 写入Excel文件： ```java List<User> userList = new ArrayList<>(); // 添加用户数据到userList... EasyExcel.write("user.xlsx", User.class).sheet().doWrite(userList); ``` 这样，就可以通过EasyExcel实现Java对象与Excel文件之间的数据转换，并且支持驼峰命名方式。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

屿丶斐然

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值