【EasyExcel】十分钟入门 EasyExcel

EasyExcel快速入门
最新推荐文章于 2024-09-25 14:55:57 发布
原创 最新推荐文章于 2024-09-25 14:55:57 发布 · 2.9k 阅读 · 3 ·
CC 4.0 BY-SA版权
本文为【tanpenggood】原创文章，允许转载，但转载必须注明出处并附带首发链接！

本文介绍如何使用alibaba/easyexcel库高效处理Excel文件，避免内存溢出问题，包括使用对象和列表写入数据，以及异步读取和解析Excel文件的方法。

POI 的 API 较复杂，而且低版本有OOM的风险。
快节奏的互联网时代，使开发效率成了我们技术人追求。
这里带大家十分钟入门 alibaba/easyexcel

alibaba/easyexcel github

alibaba/easyexcel doc

Writer

  • head 方法支持传入参数的格式

    • public ExcelWriterBuilder head(Class clazz)
    • public ExcelWriterBuilder head(List<List<String>> head)

  • doWrite 方法支持传入参数的格式

    • public void doWrite(List<Class> data)
    • public void doWrite(List<List<Object>> data)
      在这里插入图片描述

使用对象写

   /**
     * 最简单的写 使用定义的对象写
     * <p>1. 创建excel对应的实体对象 参照{@link WriteData}
     * <p>2. 获取写入的数据 List<Class>
     * <p>3. 直接写即可
     */
    @Test
    public void simpleWrite() {
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        // 如果这里想使用03 则 传入excelType参数即可
        EasyExcel.write("./test.xlsx", WriteData.class)
                .excelType(ExcelTypeEnum.XLSX)
                .sheet("demoData")
                .doWrite(data());
    }

WriteData.java

@Data
@Builder
@HeadRowHeight(25)
@ContentRowHeight(20)
@ColumnWidth(30)
public class WriteData {

    @ExcelProperty(value = "字符串标题", converter = CustomTitleConverter.class)
    private String string;
    
    @DateTimeFormat("yyyy年MM月dd日 HH时mm分ss秒")
    @ExcelProperty(value = "日期标题")
    private Date date;
    
    @ExcelProperty("数字标题")
    private Double doubleData;
    
    @ExcelProperty(value = "禁用标志", converter = CustomDisabledConverter.class)
    private Boolean disabled;
    
    /**
     * 忽略这个字段
     */
    @ExcelIgnore
    private String ignore;
    
}

使用 list 写

    /**
     * 使用list写
     * <p>1. 定义List<List<String>>结构的表头
     * <p>2. 定义List<List<Object>>结构的数据
     * <p>3. 写数据
     */
    @Test
    public void listWrite() {
        List<List<String>> head = new ArrayList<>();
        head.add(Arrays.asList("head1"));
        head.add(Arrays.asList("head2"));
        head.add(Arrays.asList("head3"));
        head.add(Arrays.asList("head4"));

        List<List<Object>> data = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            data.add(Arrays.asList("字符串" + i, new Date(), 0.56, (i % 2 == 0)));
        }

        EasyExcel.write("./test.xlsx")
                .excelType(ExcelTypeEnum.XLSX)
                .head(head)
                .sheet("demoData")
                .doWrite(data);
    }

Reader

读一个sheet

   /**
     * 异步读
     * <p>
     * 1. 由于默认异步读取excel，所以需要创建excel一行一行的回调监听器，参照{@link ObjectListener}
     * <p>
     * 2. 直接读即可
     */
    @Test
    public void read() {
        ObjectListener listener = new ObjectListener();
        // 这里 需要指定监听器用于存储数据，然后读取第一个sheet 文件流会自动关闭
        EasyExcel.read("./test.xlsx", listener)
                // 0 是第一个sheet的index
				.sheet(0)
                // 同步读 doReadSync()
                // 异步读 doRead()
                .doRead();
        System.out.println(listener.getList().stream().count());
        listener.getList().stream().forEach(System.out::println);
		// 2
		// {0=自定义：字符串0, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=可用}
		// {0=自定义：字符串1, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=禁用}
   }

输出

 2
 {0=自定义：字符串0, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=可用}
 {0=自定义：字符串1, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=禁用}

读全部sheet

   /**
     * @description: 读取所有的sheet数据
     * @author: tanpeng
     * @date : 2020-02-13 10:50 
     * @version: v1.0.0
     */
    @Test
    public void readAll() {
        ObjectListener listener = new ObjectListener();
        // 这里 需要指定监听器用于存储数据，然后读取第一个sheet 文件流会自动关闭
        EasyExcel.read("./test.xlsx", listener)
                .doReadAll();
        System.out.println(listener.getList().stream().count());
        listener.getList().stream().forEach(System.out::println);
    }

输出

 4
 {0=自定义：字符串0, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=可用}
 {0=自定义：字符串1, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=禁用}
 {0=自定义：字符串0, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=可用}
 {0=自定义：字符串1, 1=2020年02月13日 09时32分29秒, 2=0.56, 3=禁用}

Listener

正确使用 Listener

  • invoke 数据校验、数据转换等工作
  • doAfterAllAnalysed 整个excel解析结束时执行
/**
 * 解析监听器，
 * 每解析一行会回调invoke()方法。
 * 整个excel解析结束会执行doAfterAllAnalysed()方法
 * @description:
 * @author: tanpeng
 * @date: 2020-02-07 14:55
 * @version: v1.0.0
 */
@Data
public class ConverterDataListener extends AnalysisEventListener<ConverterData> {

    @Override
    public void invoke(ConverterData data, AnalysisContext context) {
        // 数据校验、数据转换等工作
        if (data != null) {
            if (data.getString().contains("5")) {
                // 不处理本条数据
                // return;
                // 直接结束数据处理，不再处理后面的数据 throw new RuntimeException()
                throw new RuntimeException("包含数字5");
            } else {
                // 处理数据
                System.out.println(data.toString());
            }
        }
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 处理完毕
        System.out.println("done");
    }
}

错误使用 Listener

新同学很容易，会像下面的代码一样使用ObjectListener，声明一个空的list容器用来保存invoke中返回的每条数据，这样其实又是将数据放在了内存中进行计算，当解析大文件时，同样会OOM

实际上easyexcel使用 SAX 模式解析，每次只返回一条数据。
返回的这一条数据就是invoke方法的第一个参数，在invoke方法中应该做数据校验、数据转换等工作，而不是将数据又逐条往内存里放，放到最后说不定又到了OOM的局面。

/**
 * 解析监听器，
 * 每解析一行会回调invoke()方法。
 * 整个excel解析结束会执行doAfterAllAnalysed()方法
 * @description:
 * @author: tanpeng
 * @date: 2020-02-07 13:00
 * @version: v1.0.0
 */
@Data
public class ObjectListener extends AnalysisEventListener<Object> {

    /**
     * @description: 默认范型为 LinkedHashMap<Integer, String> {@link MapCache}
     * @author: tanpeng
     * @date : 2020-02-07 14:33
     * @version: v1.0.0
     */
    private List<Object> list = new ArrayList<>();

    @Override
    public void invoke(Object data, AnalysisContext context) {
        if (data != null) {
            list.add(data);
        }
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {

    }
}

工作原理

easyexcel 的工作原理图，它清楚的告诉了你为什么使用easyexcel可以避免OOM

  • 1、文件解压文件读取通过文件形式
    在这里插入图片描述
  • 2、避免将全部全部数据一次加载到内存
    在这里插入图片描述
  • 3、抛弃不重要的数据
    Excel解析时候会包含样式，字体，宽度等数据，但这些数据是我们不关心的，如果将这部分数据抛弃可以大大降低内存使用。Excel中数据如下Style占了相当大的空间。

工程结构

在这里插入图片描述

其他

实体类可使用的注解

在这里插入图片描述

Excel 限制

版本最大行最大列
Excel 2003 .xls65536256
Excel 2007 .xlsx104857616384
不支持csv的读写--

CellDataTypeEnum枚举类 学习

枚举类 可以看作是关系型数据库中的一张表

package com.alibaba.excel.enums;

import java.util.HashMap;
import java.util.Map;

import com.alibaba.excel.util.StringUtils;

/**
 * excel internal data type
 *
 * @author Jiaju Zhuang
 */
public enum CellDataTypeEnum {
    /**
     * string
     */
    STRING,
    /**
     * This type of data does not need to be read in the 'sharedStrings.xml', it is only used for overuse, and the data
     * will be stored as a {@link #STRING}
     */
    DIRECT_STRING,
    /**
     * number
     */
    NUMBER,
    /**
     * boolean
     */
    BOOLEAN,
    /**
     * empty
     */
    EMPTY,
    /**
     * error
     */
    ERROR,
    /**
     * Images are currently supported only when writing
     */
    IMAGE;

    private static final Map<String, CellDataTypeEnum> TYPE_ROUTING_MAP = new HashMap<String, CellDataTypeEnum>(16);
    static {
        TYPE_ROUTING_MAP.put("s", STRING);
        TYPE_ROUTING_MAP.put("str", DIRECT_STRING);
        TYPE_ROUTING_MAP.put("inlineStr", STRING);
        TYPE_ROUTING_MAP.put("e", ERROR);
        TYPE_ROUTING_MAP.put("b", BOOLEAN);
        TYPE_ROUTING_MAP.put("n", NUMBER);
    }

    /**
     * Build data types
     *
     * @param cellType
     * @return
     */
    public static CellDataTypeEnum buildFromCellType(String cellType) {
        if (StringUtils.isEmpty(cellType)) {
            return EMPTY;
        }
        return TYPE_ROUTING_MAP.get(cellType);
    }
}

完整代码

完整代码 请移步gitee

EasyExcel 读取 Excel 文件指南
wobenwoxiangfei的博客
10-09 1048
若 Excel 表头不在第一行，可通过// 表头在第三行。
解析Excel数据如虎添翼：Excel数据监听器助你快速解析数据，轻松驾驭业务需求，一键解析，风云再起，数据处理从未如此简单，事半功倍
hs598375774的博客
03-05 1510
总而言之，该Excel数据监听器可以帮助用户高效、准确地解析和处理Excel数据。它提供了表头校验、数据处理和异常处理等功能，使得数据的导入和处理变得更加简单和可靠。无论是处理大规模数据还是进行数据校验，该监听器都能够帮助用户提升工作效率，减少错误率。以下代码是一个Excel数据监听器，用于监听和处理Excel数据的读取事件。这段代码的作用是根据传入的Excel模板路径和文件名，解析Excel文件，并进行表头校验和数据行处理，文章中只处理了按照模板校验表头是否合法，针对动态传入。形式的表头可自行扩展。
easyExcel
weixin_45223608的博客
03-08 804
EasyExcel阿里巴巴表格使用 一.Excel导入导出的应用场景 1.数据导入：减轻录入的工作量 2.数据导出：统计信息归档 3.数据传输：异构系统之间数据传输 二。EasyExcel简介 1.EasyExcel特点 Java领域解析，生成Excel比较有名的框架有Apache poi,jxl等，但他们都存在一个严重的问题就是非常的耗内存，如果你的系统并发量不大的话可能还行，但是一旦并发上来后一定会OOM或者JVM频繁的full gc. EasyExcel是阿里巴巴开源的一个excel处理框架，以使用简
EasyExcel的使用
weixin_42556307的博客
03-05 2340
EasyExcel能大大减少占用内存的主要原因是在解析excel文件时没有将文件数据一次性全部加载到内存中，而是从磁盘上一行行读取数据，逐个解析。POI与EasyExcel的区别如下：POI是通过WookBook来解析表格文件的，虽然内部有使用到Sax模式，能够大大提高效率，但是要解析大文件（10w、100w行）的话很容易出现OOM（内存溢出）。EasyExcel的解析是在磁盘上进行的，几乎可以将几mb级别的内存压缩到kb级别，几乎不用担心OOM；
java轻松玩转Excel之EasyExcel
weixin_42599693的博客
12-01 5608
项目地址:https://github.com/PiKeZhao/excel-model.git 如果您对该项目有什么问题加群咨询哦978219630(各类电子书籍,学习视频等) 大家常用 Apache POI 的 HSSF(.xsl后缀),XSSF(.xlsl后缀)功能来实现 Excel的读取和写入。今天我们介绍一款超级简单的Excel处理工具，EasyExcel,首先看一下官网介绍: Java...
封装读excel监听器：不创建对象的读
qq_40987844的博客
05-12 1006
封装读excel监听器：主打不创建对象的读 import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.event.AnalysisEventListener; import lombok.SneakyThrows; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.annotation.Resource; import .
SpringBoot集成EasyExcel快速入门Demo
04-07
在本文中，我们将深入探讨如何将SpringBoot框架与流行的Java Excel处理库EasyExcel结合使用，以便轻松实现Excel的上传和下载功能。EasyExcel是阿里巴巴开源的一款轻量级库，专门设计用于处理Excel数据，它避免了内存...
springboot结合Easyexcel的使用（详细介绍Easyexcel）小白入门到精通
12-21
【SpringBoot结合EasyExcel的使用详解】 在Java开发中，处理Excel文件是一项常见的任务，而Apache POI和jxl库由于内存消耗大、处理大量数据时速度慢等问题，已不能满足高效、稳定的需求。这时，阿里巴巴开发的...
easyExcel主子表导出
最新发布
07-02
easyExcel作为一个高效的Java Excel处理库，很好地解决了这一需求。 easyExcel是阿里巴巴开源的一个用于读写Excel文件的Java库。它提供了快速读写Excel文件的API，并且针对大文件、复杂格式的处理提供了性能优化和...
easyexcel代码
06-21
EasyExcel是一款由阿里巴巴开源的Java库，专门用于处理Excel数据，尤其在大数据量读写场景下表现出色。它简化了Excel与Java对象之间的转换，提供了简单易用的API，使得开发者无需关注底层复杂的文件格式，可以更加...
EasyExcel快速入门指南
**介绍EasyExcel** ## 1.1 什么是EasyExcel？ EasyExcel是一个强大的Excel文件操作工具，可以帮助用户快速、简单地处理Excel文件，提供了丰富的API接口，支持各种操作，如读、写、编辑Excel文件，同时支持大数据...
EasyExcel如何读取全部Sheet页数据方法
m0_60769905的博客
11-30 8788
Excel表格里面大约有20个sheet页，每个sheet页65535条数据，需要读取全部数据，并导入至数据库。找了好多种方式，EasyExcel比较符合，下面看代码。
SpringBoot集成阿里easyexcel（二）Excel监听以及常用工具类
是木子啦~
09-25 1464
EasyExcel中非常重要的AnalysisEventListener类使用，继承该类并重写invoke、doAfterAllAnalysed，必要时重写onException方法。
EasyExcel动态生成表头
chenwen0326的专栏
09-23 1330
EasyExcel.write(outputStream).head(List<List<String>> head).registerWriteHandler(HorizontalCellStyleStrategy.class)) .registerWriteHandler(CellWriteHandler.class) .sheet("缴费").doWrite(List<List<O...
轻松玩转Excel，springboot集成easyexcel
Mr_Xu12308的博客
01-07 1311
最近这不又接到一个需求，上游用户想要下载上报给我们的列表数据，用来进行一些简单的线下分析。 用户的需求必须满足啊！于是我就吭哧吭哧的找到俺的chrome大哥，立即所搜”springboot下载json数据“的模板代码，妄图通过CV大法快速实现用户需求。
【EasyExcel&Hutool】excel表格的导入和导出，csv文件的导入导出
热门推荐
weixin_44823875的博客
09-22 1万+
EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。
hutool-poi的一些问题
Kong_a的博客
01-12 621
使用hutool-poi时遇到的一些问题
easypoi必填项_EasyExcel对Excel文件的解析过程
weixin_39926193的博客
12-21 1989
POI与easyExcel的区别：、 POI是通过WorkBook来解析表格文件的，虽然内部有使用到Sax模式，能后大大的提高效率，但是要解析大文件(10w，100w行)的话很容易出现OOM(内存溢出)。相比之下，1、easyExcel解析实在磁盘上进行的，几乎可以将几mb级别的内存压缩到kb级别，几乎不用担心OOM；2、用Java模型进行关系映射，项目中最常用的就Java模型映射，通过 @Exc...
easyexcel 图片_EasyExcel 入门
05-16
EasyExcel 是一个基于阿里巴巴的开源项目 easyexcel 开发的 Excel 工具类库，可以方便快捷地读取、写入 Excel 文件。它支持大批量数据的导入导出，可以读取 Excel 中的复杂表格，并且能够将 Java 对象映射到 Excel 单元格中。 在 EasyExcel 中，图片的导入和导出可以通过一个 POJO 类来实现。下面是一个示例： ```java public class ImageData { //图片文件名 private String fileName; //图片字节数组 private byte[] imageBytes; public String getFileName() { return fileName; } public void setFileName(String fileName) { this.fileName = fileName; } public byte[] getImageBytes() { return imageBytes; } public void setImageBytes(byte[] imageBytes) { this.imageBytes = imageBytes; } } ``` 这个 POJO 类包含了图片文件名和图片字节数组两个属性，分别用于表示图片的文件名和内容。在导入和导出 Excel 文件时，我们可以使用 EasyExcel 提供的注解来指定这个 POJO 类中的属性和 Excel 表格中的列之间的映射关系。 下面是一个示例，演示了如何将 POJO 类中的图片数据导出到 Excel 文件中： ```java public static void writeExcel() throws IOException { //定义 Excel 文件输出流 OutputStream outputStream = new FileOutputStream("test.xlsx"); //创建 EasyExcel 写入器 ExcelWriter excelWriter = EasyExcel.write(outputStream, ImageData.class).build(); //创建一个 Sheet WriteSheet writeSheet = EasyExcel.writerSheet("Sheet1").build(); //创建一个图片 BufferedImage image = new BufferedImage(100, 100, BufferedImage.TYPE_INT_RGB); Graphics2D g = image.createGraphics(); g.setColor(Color.WHITE); g.fillRect(0, 0, 100, 100); g.setColor(Color.BLACK); g.drawString("Hello, EasyExcel", 10, 50); ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); ImageIO.write(image, "png", outputStream); byte[] bytes = outputStream.toByteArray(); //创建一个 ImageData 对象 ImageData imageData = new ImageData(); imageData.setFileName("test.png"); imageData.setImageBytes(bytes); //将 ImageData 对象写入到 Excel 文件中 excelWriter.write(Arrays.asList(imageData), writeSheet); //关闭 Excel 写入器 excelWriter.finish(); } ``` 在这个示例中，我们首先创建了一个 BufferedImage 对象，然后使用 Graphics2D 绘制了一个字符串，并将其转换为了字节数组。接着，我们创建了一个 ImageData 对象，并将图片文件名和字节数组分别设置到了对象的属性中。最后，我们将 ImageData 对象写入到了 Excel 文件中。 导入 Excel 文件中包含图片数据的过程与导出类似，只需要使用 EasyExcel 提供的读取器和监听器，读取 Excel 文件中的数据，并将读取到的数据转换为 POJO 对象即可。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值