Skip to content

🚛 轻量高效的Excel处理工具-EEC

让JAVA操作excel更简单

介绍

EEC的设计初衷是为了解决Apache POI高内存且API臃肿的诟病,EEC的底层并不依赖POI包,所有的底层代码均自己实现,使用EEC基本可以做到一行代码完成Excel文件的读和写操作极易上手。

EEC的最大特点是**“轻量”“高效**”,轻量体现在包体小、接入代码量少以及运行时消耗资源少三个方面,高效指运行效率高

  • 包体小:EEC和必要依赖包共约900K
  • 接入代码量少:无论读写均可以一行代码实现
  • 消耗资源少:单线程设计,极限运行内存小于10M

核心原理:

  • 导出大数据时使用分片处理
  • 单元格样式仅使用一个int值来保存,极大缩小内存使用
  • 使用迭代模式读取行内容,不会将整个文件读入到内存

下面是迭代模式读取文件的示意图

202512062334146522362e3.png

采用“pull”方式的好处是当用户需要某行数据时才去解析它们来实现延迟读取。


EEC极大的简化了java处理excel文件的复杂性,无论是读还是写都可以使用一行代码完成,你可以非常快速的从POI或easyexcel切换到EEC,接下来将介绍如何快速集成EEC。

eec支持xlsx格式读和写,eec-e3-support支持xls格式读,请按需引用。另外eec-e3-support无法单独引用,它依赖于eec

  • 如果你使用maven或gradle等管理工具,你可以在** **Search Maven 搜索关键词org.ttzero或者eec来查找所有版本的eec和eec-e3-support,建议使用最新版本。
  • 如果你没有使用管理工具,那么你可以 点击此处 下载jar包,然后添加到classpath来使用。

eec与eec-e3-support版本兼容性对照参考 这里

快速开始

创建一个 SpringBoot3 项目,本文环境:IDEA2023.1+JDK17+SpringBoot3.4.0+Maven

导入依赖

java
<!-- 注意两个依赖的版本对照关系 -->
<!-- https://mvnrepository.com/artifact/org.ttzero/eec -->
<!-- xlsx格式读和写 -->
<dependency>
    <groupId>org.ttzero</groupId>
    <artifactId>eec</artifactId>
    <version>0.5.20</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.ttzero/eec-e3-support -->
<!-- xls格式读和写 -->
<dependency>
    <groupId>org.ttzero</groupId>
    <artifactId>eec-e3-support</artifactId>
    <version>0.5.19</version>
</dependency>

hello World

java
/**
 * 写文件
 * 一行代码实现excel文件的写入
 * 在D:\baili\test\excel文件夹下生成一个名为<新建文件.xlsx>的excel文件
 * 其中添加了一个空的Sheet页(EmptySheet)
 * @throws IOException
 */
@Test
void excelRead01() throws IOException {
    String path = "D:\\baili\\test\\excel";
    new Workbook().addSheet(new EmptySheet()).writeTo(Paths.get(path));
}

/**
 * 读文件
 * 一行代码实现excel文件的读取
 * 读取D:\baili\test\excel\新建文件.xlsx文件
 */
@Test
void excelWrite01() {
    String path = "D:\\baili\\test\\excel\\";
    String fileName = "新建文件.xlsx";
    try (ExcelReader reader = ExcelReader.read(Paths.get(path.concat(fileName)))) {
        reader.sheets().flatMap(org.ttzero.excel.reader.Sheet::rows).forEach(System.out::println);
    } catch (IOException e) {
        e.printStackTrace();
    }
}

导出Excel

EEC目前支持SimpleSheetListSheetListMapSheetTemplateSheetStatementSheetResultSetSheetCSVSheetEmptySheet几种内置的Worksheet,如果不能满足需求你也可以继承已有的Worksheet来扩展,最常见的就是对于大数据量写入时的分片处理,这个在后面会讲到,目前还是从最简单的ListSheet出发。

将数据导出到excel

数据导出应该是开发过程中比较常见的功能,可就是这种简单功能如果使用Apache POI来开发可不是一件轻松的活,幸好EEC已经为我们做了大量的封装,使我们可以做到开箱即用,下面代码展示如何开发简单的对象数组导出功能

java
/**
 * 导出学生信息
 */
public void exportStudent(List<Student> students) throws IOException {
    new Workbook("二年级学生表") // 新增一个Workbook并指定名称,也就是Excel文件名
    .addSheet(new ListSheet<>(students)) // 添加一个Sheet页,并指定导出数据
    .writeTo(Paths.get("F:/excel")); // 指定导出位置
}

以上writeTo方法指定一个输出位置,不需要指定具体文件名称,名称在实例化Workbook时指定,如果未指定则默认使用“新建文件”做为文件名,如果指定到具体文件而不是文件夹则替换原有文件,没有权限则会抛异常。另外writeTo终止符,调用该方法将触发写操作,在其后设置的所有属性将不生效。

如果是做web开发则可以将writeTo直接输出到Response的Outputstream中,如下代码

java
/**
 * 直接将excel输出到流
 */
@GetMapping("/download")
public void download(HttpServletResponse response) throws IOException {
    String fileName = java.net.URLEncoder.encode("新建文件.xlsx", "UTF-8");
    response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + fileName + "\"; filename*=utf-8''" + fileName);
    // 查询数据
    List<Student> students = studentService.list();

    new Workbook().addSheet(new ListSheet<>(students)).writeTo(response.getOutputStream()); // <- 直接写到Response流
}

添加多个Worksheet

EEC是通过Workbook#addSheet方法添加Worksheet,添加的时候你可以指定Sheet的名称,如果不指定则默认使用Sheet {N}命名。对于导出多个Sheet页只需要多调用几次addSheet方法即可,非常方便。 另外,添加顺序决定导出时各Sheet顺序,如果想调整此顺序可以调用Workbook#insertSheet方法插入到指定下标(从0开始),与普通的Array操作一样。

下面代码演示生成多个Worksheet

java
new Workbook("multi-sheets")
.addSheet(new ListSheet<>("帐单表").setData(checksTestData()))
.addSheet(new ListSheet<>("客户表").setData(customersTestData()))
.addSheet(new ListSheet<>("用户客户关系表").setData(c2CSTestData()))
.writeTo(Paths.get("F:/excel"));

导出文件如下:

2025120623341484f14416d.png

隐藏Sheet

出于某些安全考虑需要隐藏某个或多个Sheet页该如何处理呢?答案是只需要在对应的Sheet上调用#hidden()方法。调用该方法后数据依然会正常写出,只是该页被隐藏。

下面代码演示隐藏某个Worksheet

java
new Workbook("multiSheet")
.addSheet(new ListSheet<>("帐单表").setData(checksTestData()))
.addSheet(new ListSheet<>("客户表").setData(customersTestData()).hidden()) // <- 隐藏该Sheet
.addSheet(new ListSheet<>("用户客户关系表").setData(c2CSTestData()))
.writeTo(Paths.get("F:/excel"));

导出文件如下,点击右键选择“取消隐藏”就可以还原了。

20251206233414f6c1496c6.png

强制导出ForceExport

_为了数据安全_EEC默认只会导出标记有@ExcelColumn的属性,但某些情况不方便在实体中加入注解此时就可以调用forceExport方法全字段导出(标记了@IgnroeExport注解除外)。

Force Export会将实体中所有字段导出,这是非常危险的做法不建议使用。如果其它开发者新增了一些属性且未意识到forceExport则会出现数据泄漏风险,为防止数据泄露推荐手动指定Column,这样的话即使对象被添加了敏感字段也不会被自动导出,降低不可预期风险发生。

示例代码如下

java
// 手动指定Column
new Workbook().addSheet(new ListSheet<>(
    new Column("学号", "id") // "学号"为别名即Excel呈现的表头,"id"为Student实体中的字段
    , new Column("姓名", "name")
    , new Column("成绩", "score")
).setData(Student.randomTestData()))
.writeTo(Paths.get("F:/excel"));

关于自动分页

单个worksheet页有行数上限,xls上限为65,536,xlsx上限为1,048,576,如果数据超过该如何处理呢,需要手动进行截取么,还是抛异常?

EEC是为大数据量而生,所以自然考虑到了这种情况,当数据量超过单sheet上限时会自动进行分页处理,无须用户额外处理,而大多数同类工具均是直接抛异常。

自动分页部分代码解析

java
/**
 * Split worksheet data
 */
@Override
protected void paging() {
    // dataSize()是当前一组数据块的大小,limit是获取单个worksheet的行上限
    int len = dataSize(), limit = getRowLimit();
    // paging
    if (len + rows > limit) {
        // Reset current index
        end = limit - rows + start; // end是标记dataSize的最后位置,因为已经超限了所以当前页只会取未超限的数据
        shouldClose = false;
        eof = true;
        size = limit;

        int n = id;
        for (int i = end; i < len; ) {
            @SuppressWarnings("unchecked")
            ListSheet<T> copy = getClass().cast(clone()); // 复制一个新的worksheet
            copy.start = i;
            copy.end = (i = Math.min(i + limit, len));
            copy.size = copy.end - copy.start;
            copy.eof = copy.size == limit;
            workbook.insertSheet(n++, copy); // 插入到当前worksheet后面
        }
        // Close on the last copy worksheet
        workbook.getSheetAt(n - 1).shouldClose = true; // 如果是最后一个分页则关闭
    } else {
        end = len;
        size += len;
    }
}

大数据量导出请参考 大数据量导出

多行表头

多行表头请参考 如何设置多行表头

忽略表头

EEC提供Sheet#ignoreHeader方法来忽略表头输出,当然你在表头上设置的任何信息依然有效,只在输出的时候跳过表头,注意这里是忽略表头不是隐藏

java
new Workbook("Ignore header")
.addSheet(new ListSheet<>(randomTestData()).ignoreHeader()) // <- 使用#ignoreHeader忽略表头输出
.writeTo(Paths.get("F:/excel"));

简单数据类型导出

有时候仅仅想导出最简单的数据类型,比如Integer,String,如果定义实体就显得过度设计,此时可以像下面示例一样导入简单类型

java
List<Integer> list = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 0);
new Workbook("Integer array")
.addSheet(new SimpleSheet<>(list))
.writeTo(Paths.get("F:/excel"));

未知的数据类型

EEC内置处理如下类型,并按照文本居左,数字居右,日期/bool/char居中输出

StringCharSequenceintIntegershortShort
byteBytelongLongfloatFloat
doubleDoubleBigDecimalbooleanBooleanchar
Characterjava.util.Datejava.sql.Datejava.sql.Timestampjava.sql.Timejava.time.LocalDate
java.time.LocalDateTimejava.time.LocalTime

其余类型均默认调用toString方法输入,如果需要特殊处理则可以使用自定义ICellValueAndStyle类并覆写unknownType方法,示例如下

java
public class MyXMLCellValueAndStyle extends XMLCellValueAndStyle {

    @Override
    public void unknownType(Row row, Cell cell, Object e, Column hc, Class<?> clazz) {
        // 如果认别到自定义枚举则输出枚举desc字段
        if (clazz == PlatformEnum.class) {
            cell.setSv(((PlatformEnum) e).getDesc());
        }
            // 其它情况默认处理
        else {
            super.unknownType(row, cell, e, hc, clazz);
        }
    }
}

// 添加Worksheet时指定自定认MyXMLCellValueAndStyle即可
new Workbook()
.addSheet(new ListSheet<>(data).setCellValueAndStyle(new MyXMLCellValueAndStyle()))
.writeTo(Paths.get("F:/excel"));

以上代码展示了自定义枚举类型的特殊处理,对于没有权限修改(如对象放在公共的jar包中或者多个团队共同使用不能修改)的情况下自定义ICellValueAndStyle就显得特别重要了,当然如果有权限的话你也可以直接在PlatformEnum枚举内添加toString并返回desc属性,但并不建议此类做法

unknownType的优先级最低,所以无法在unknownType方法中处理String等内置类型,如果需要则可以覆写reset方法,像下面示例一样

java
public class MyXMLCellValueAndStyle extends XMLCellValueAndStyle {
    @Override
    public void reset(Row row, Cell cell, Object e, Column hc) {
        // 调用预处理方法
        preCellValue(row, cell, e, hc, hc.getClazz(), hc.processor != null);
        if (hc.processor == null) {
            cell.xf = getStyleIndex(row, hc, e);
        }
    }

    void preCellValue(Row row, Cell cell, Object e, Column hc, Class<?> clazz, boolean hasProcessor) {
        // TODO 前置处理内置类型
        if (isString(clazz)) {
            cell.setSv("##" + e + "##");
            return;
        }
        // 其它类型走原方法
        setCellValue(row, cell, e, hc, clazz, hasProcessor);
    }
}

导出图片

默认情况下EEC总是以"值"的形式导出,即使是byte[]也将进行toString后导出,所以EEC是安全的。

从v0.5.10开始支持导出图片,EEC使用以下双检查以保证安全,避免可执行文件、木马病毒写入Excel

  1. 检查列是否以Media格式导出,用户必须显示的调用writeAsMedia方法指定
  2. 检查FILE SIGNATURES是否为白名单中的图片格式,只有识别到白名单的Signatures才会写出到excel

这里的file signatures检查并非简单的扩展名匹配,而是尝试解析文件头的少量字节进行signatures匹配,更安全的除了文件头还需要匹配文件尾,但图片一般都几百Kb甚至几Mb为了性能EEC牺牲了绝对的安全

默认FILE SIGNATURES白名单格式如下

扩展名Content-type
.pngimage/png
.jpgimage/jpg
.gifimage/gif
.tiffimage/tiff
.bmpimage/bmp
.icoimage/x-ico
.emfimage/x-emf
.wmfimage/x-wmf
.webpimage/webp

EEC支持PathFileURLbyte[]ByteBufferInputStreambase64 image string7种类型的Media,你可以使用Column#writeAsMedia()或者@MediaColumn注解来指定当前列类型为Media,此注解还附加了一个属性presetEffect用于预设图片样式

简单示例代码如下

java
public static class Pic {
    @ExcelColumn("地址")
    private String addr;
    @MediaColumn // 指定以Media形式导出
    private String url;
}

new Workbook()
.addSheet(new ListSheet<>(randomTestData()).setRowHeight(100))
.writeTo(Paths.get("F:/excel"));

202512062334149fd1e93df.png

EEC支持Excel内置的28种预设图片样式,内置样式使用PresetPictureEffect枚举类型获取,枚举的顺序与Excel中的顺序完全一致,预设样式如下:

202512062334142b9c22a83.png

使用presetEffect指定预设样式

java
public static class Pic {
    @ExcelColumn("地址")
    private String addr;
    @MediaColumn(presetEffect = PresetPictureEffect.Rotated_White) // 指定以Media形式导出并添加图片效果
    private String url;
}

2025120623341449488cef0.png

以上是为整列设置样同的图片样式,我们也可以自定义XMLWorksheetWriter为每列设置不同样式

java
new Workbook()
.addSheet(new ListSheet<>(randomTestData())
          .setRowHeight(217.5).autoSize().setSheetWriter(new XMLWorksheetWriter() {
              @Override
              protected Picture createPicture(int column, int row) {
                  Picture picture = super.createPicture(column, row);
                  // 某些效果会加边框、倒影或者旋转所以这里增加padding的大小以显示完整的效果
                  picture.padding = 15 << 24 | 15 << 16 | 35 << 8 | 15;
                  PresetPictureEffect[] effects = PresetPictureEffect.values();
                  // 添加效果
                  picture.effect = effects[row - 2].getEffect();
                  return picture;
              }
          })).writeTo(Paths.get("F:/excel"));

如下图展示 A列是枚举值,B列是对应的效果

20251206233414a4187b04a.png

PresetPictureEffect枚举中英文对照表

中文枚举值
None
简单框架,白色SimpleFrame_White
棱台亚光,白色BeveledMatte
金属框架MetalFrame
矩形投影DropShadowRectangle
映像圆角矩形ReflectedRoundedRectangle
柔化边缘矩形SoftEdgeRectangle
双框架,黑色DoubleFrame
厚重亚光,黑色ThickMatte
简单框架,黑色SimpleFrame_Black
棱台形椭圆,黑色BeveledOval
复杂框架,黑色CompoundFrame
中等复杂框架,黑色ModerateFrame
居中矩形阴影CenterShadowRectangle
圆形对角,白色RoundedDiagonalCorner
剪去对角,白色SnipDiagonalCorner
中等复杂框架,白色ModerateFrame
旋转,白色Rotated
透视阴影,白色PerspectiveShadow
松散透视,白色RelaxedPerspective
柔化边缘椭圆SoftEdgeOval
棱台矩形BevelRectangle
棱台透视BevelPerspective
映像右透视ReflectedPerpsectiveRight
棱台左透视,白色BevelPerspectiveLeft
映像棱台,黑色ReflectedBevel
映像棱台,白色ReflectedBevel_White
金属圆角矩形MetalRoundedRectangle
金属椭圆MetalOval

注意:自适应列宽对**Media**列无效,它总是以固定宽度显示

关于图片下载

虽然EEC支持远程图片下载但能力较弱,内置下载工具仅使用java.net.HttpURLConnection类,它不会使用连接池也没有支持ftp以及身份鉴权, 所以在集成的过程中如果有图片下载的话最好使用已有下载器,然后使用InputStream,byte[]或者ByteBuffer传入EEC,这样的话你可能需要修改实体对代码有一定的破坏性,当然你也可以自定义XMLWorksheetWriter 将下载器集成进EEC,这样就不需要修改已有Java对象了。

下面展示一段使用OkHttp做为下载器替换java.net.HttpURLConnection的示例,你可以使用已有任何工具替换

java
new Workbook().addSheet(new ListSheet<>(getRemoteUrls())
            .setColumns(new Column().setWidth(20).writeAsMedia()).setRowHeight(100)
            .setSheetWriter(new XMLWorksheetWriter() {
                @Override public void downloadRemoteResource(Picture picture, String uri) throws IOException {
                    // http or https
                    if (uri.startsWith("http")) {
                        try (Response response = OkHttpClientUtil.client().newCall(new Request.Builder().url(uri).get().build()).execute()) {
                            ResponseBody body;
                            if (response.isSuccessful() && (body = response.body()) != null) {
                                downloadCompleted(picture, body.bytes());
                            }
                        } catch (IOException ex) {
                            downloadCompleted(picture, null);
                        }
                    }
                        // ftp or ftps
                    else if (uri.startsWith("ftp")) {
                        // TODO download from ftp server
                    }
                }
            })).writeTo(Paths.get("F:/excel"));

通过downloadCompleted方法告诉EEC图片数据已准备好,此方法会进行文件签名检查通过后才会将图片数据写到excel中去,在捕获异常代码块中传入null告诉EEC下载失败。

上面代码可以看到只需要在完成下载后调用downloadCompleted方法通知EEC,那是否可以替换为异步下载呢?答案是"YES"。以上代码只需要将#execute()改为#enqueue(new Callback() {}并在onResponse和onFailure方法中调用downloadCompleted即可实现异步下载。

注意:目前来说异步下载并未通过充分测试和优化,至少v0.5.10版本不要在生产环境使用

读取 Excel

像TXT文件一样读Excel

使用EEC读取Excel和读取文本文件一样简单,其设计思路和Files.lines(Path)一样,EEC使用ExcelReader#read静态方法读文件,其内部采用流式操作,当使用某一行数据时才会真正读入内存,所以即使是GB级别的Excel文件也只占用少量内存。

我们可以写一段简单示例来比较读TXT文件和Excel的区别

java
// 读取TXT文件
@Test 
public void testReadText() {
    try (Stream<String> line = Files.lines(Paths.get("F:/excel/1.txt"))) {
        // 按行读取并打印
        line.forEach(System.out::println);
    } catch (IOException ex) {
        ex.printStackTrace();
    }
}
// 读取Excel
@Test 
public void testReadExcel() {
    try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/1.xlsx"))) {
        // 按行读取第1个Sheet并打印
        reader.sheet(0).rows().forEach(System.out::println);
    } catch (IOException ex) {
        ex.printStackTrace();
    }
}

可以看到,两段代码几乎一致,并且功能也一样,都是按行读取数据并输出。

大多数场景都需要将行数据转为对象然后进行其它逻辑,典型的处理流程可能如下图

plain
+------+     +--------+       +--------+      +---------+
| 读取  | ->  | 过滤器1 |  ->   | 过滤器2 |  ->  | 逻辑处理 |
+------+     +--------+       +--------+      +---------+

像这种场景使用EEC将非常贴合,因为ExcelReader提供了标准的Stream流,第一层是Stream<Sheet>,第二层是Stream<Row>,流处理的最大特点就是将大任务拆分成几个小任务。

我们假定一个场景,实现一个提供文件上传功能,该功能允许用户上传商品数据,程序读取文件后进行内容检查(我可不希望上传一些违规的内容污染服务器),最后将检查通过的商品通过商品中台进行商品上架。

这样的经典场景可以使用如下代码实现

java
// 假定已将文件写到某台服务器或OSS服务器
try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/goods.xlsx"))) {
    reader.sheet(0).dataRows()
    // 将行数据转为Goods对象
    .map(row -> row.too(Goods.class))

    // 本地的一些检查,检查一些必填项
    .filter(this::validateGoods)

    // 合规检查,检查文本或者图片是否违规
    .filter(g -> redLineDetectService.checkText(g.getGoodsName()) && redLineDetectService.checkImage(g.getImage()))

    // 调用商品中台上架
    .forEach(goodsService::publish);
} catch (IOException ex) {
    ex.printStackTrace();
}

上面示例展示了一个完整的从读取到过滤到逻辑处理场景,其中的sheet(0)表示读取第一个Sheet页,dataRows()会读取第一个非空行做为表头解析。

批量处理行逻辑

上面的场景示例展现了简明的流处理,但one-by-one上架可能会拖慢系统速度,此时就有批量处理场景,但是标准的流仅提供单行数据,应该如何改进呢?

呃。。。与其说是改进不如说是退化,Sheet接口提供iterator和dataIterator两种迭代器,可以使用迭代器收集数据,代码如下:

java
try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/goods.xlsx"))) {
    List<Goods> batch = new ArrayList<>(100);
    for (Iterator<Row> ite = reader.sheet(0).dataIterator(); ite.hasNext(); ) {
        // 行数据转对象
        batch.add(ite.next().to(Goods.class));
        // 满100条批量上架
        if (batch.size() >= 100) {
            goodsService.batchPublish(batch);
            batch.clear();
        }
    }
    // 上架剩余商品
    if (!batch.isEmpty()) {
        goodsService.batchPublish(batch);
    }
} catch (IOException ex) {
    ex.printStackTrace();
}

你无需担心OOM,因为Iterator依然是按需加载数据,内存消耗与Stream相当。

获取文件包含多少行

EEC并不提供获取总行数的方法(有一个被标记为过时的Sheet#getSize方法目前仍然可以使用),推荐使用Sheet#getDimension方法替换,该方法会返回一个Dimension对象包含firstRow lastRow firstColumn lastColumn4个属性,细心的你一定发现了这4个属性将定位整个文档的有效范围。 取有效数据行数可以通过计算dimension.lastRow - dimension.firstRow + 1得到。

对于标准的Office Open XML来说该范围值被写到了各worksheet的头部,大致像这样<dimension ref="A1:F10"/>,所以标准的Excel可以快速获得。 但是并非所有工具都采用Office标准,比如POI导出的文件就不会写此属性,读取这类文件EEC做如下处理:将指针指向文件末尾,然后读取最后一个单元格的范围,将此范围做为有效数据范围,这有可能导致列范围不准确的问题。

总的来说获取文件范围的时间复杂度趋近于O(1),需要注意的是此属性并非可信任的,最好不要在代码中使用此值做强检验

v0.5.11开始并不会解压原始文件,所以无法用上面的方法将指针移到文件末尾以快速获取最后一个单元格范围,调用Sheet#getDimension方法将从头开始匹配单元格范围所以此方法将消耗更多的时间

反复读取

Sheet提供reset方法,该方法会重置位置到文件头,从而起到反复读取效果,该方法并不会二次解压文件也不会清除SharedString和文件范围等基础信息,所以理论上会比第一次快。看上去像是一个很2的功能,但是某些情况依然有用,比如大文件需要检查某个列是否出现重复值,检查完后再逻辑处理, 因为文件太大我们无法将数据一次读到内存再检查重复和逻辑处理,此时我们就可以使用reset做两次读文件操作

java
try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/large-goods.xlsx"))) {
    Sheet sheet = reader.sheet(0);
    Dimension dimension = sheet.getDimension();
    // 这里没有+1,因为表头占一行
    int maxRow = dimension.lastRow - dimension.firstRow;
    long count = sheet.dataRows().map(row -> row.getString("商品编码")).distinct().count(); // <- 使用distinct去除重复商品编码
    // 如果去重后的结果小于原始结果说明有重复
    if (count < maxRow) {
        throw new IllegalArgumentException("包含重复商品编码");
    }

    // 重置
    sheet.reset();

    // 和上面的例子一样处理逻辑即可
    sheet.dataRows().map(row -> row.to(Goods.class)).forEach(goodsService::publish);
} catch (IOException ex) {
    ex.printStackTrace();
}

指定表头位置

从v0.5.6开始EEC支持指定表头你可以通过Sheet#header(fromRowNum, toRowNum)来指定表头的位置,如上面实例中第7行为表头,则可以使用

java
List<Goods> list = reader.sheet(0).reset()
.header(7) // 指定第7行为表头
.rows().map(row -> row.to(Goods.class)).collect(Collectors.toList());

JDBC式读取

除了上面使用row#to或者rot#too方式将行数据直接转对象外,我们还可以使用类似于JDBC方式更原始的获取单元格的值,这种更底层的方式在复杂环境中尤为有效,比如多行表头或者非表格读取

java
List<O> list = reader.sheet(0).rows().map(row -> {
    // ... 其它解析
    O o = new O();
    o.total = row.getInt(0);       // 获取总计
    o.formula = row.getFormula(0); // 获取计算总计的公式
    return o;
}).collect(Collectors.toList());

行转Map

v0.5.6 Row提供toMap方法将行数据转为字典类型,为保证列顺序实际返回类型为LinkedHashMap,如果使用Sheet#dataRowsSheet#header指定表头则字典的Key为表头文本,Value为表头对应的列值, 如果未指定表头那将以列索引做为Key,与导出指定的colIndex一样索引从0开始。对于多行表头字典Key将以行1:行2:行n的格式进行拼接,横向合并的单元格将自动将值复制到每一列,而纵向合并的单元格则不会复制

关于单元格类型的特殊说明:行数据转对象时会根据对象定义进行一次类型转换,将单元格的值转为对象定义中的类型,但是转为字典时却不会有这一步 逻辑,类型是根据excel中的值进行粗粒度转换,例如数字类型如果带有日期格式化则会返回一个Timestamp类型, 所以最终的数据类型可能与预期有所不同

有如下Excel文件

202512062334140acdf0a71.jpeg

使用toMap方法示例

不指定表头行将列索引将做为Key

java
reader.sheet(0).asMergeSheet()
.rows().map(org.ttzero.excel.reader.Row::toMap).forEach(System.out::println);

// 控制台输出
{0=姓名, 1=性别, 2=证书, 3=证书, 4=证书, 5=年龄, 6=教育, 7=教育}
{0=姓名, 1=性别, 2=编号, 3=类型, 4=等级, 5=年龄, 6=教育1, 7=教育2}
{0=暗月月, 1=男, 2=1, 3=数学, 4=3, 5=30, 6=教育a, 7=教育b}
{0=暗月月, 1=男, 2=2, 3=语文, 4=1, 5=30, 6=教育a, 7=教育c}
{0=暗月月, 1=男, 2=3, 3=历史, 4=1, 5=30, 6=教育b, 7=教育c}
{0=张三, 1=女, 2=1, 3=英语, 4=1, 5=20, 6=教育d, 7=教育d}
{0=张三, 1=女, 2=5, 3=物理, 4=7, 5=20, 6=教育x, 7=教育x}
{0=李四, 1=男, 2=2, 3=语文, 4=1, 5=24, 6=教育c, 7=教育a}
{0=李四, 1=男, 2=3, 3=历史, 4=1, 5=24, 6=教育b, 7=教育c}
{0=王五, 1=男, 2=1, 3=高数, 4=2, 5=28, 6=教育c, 7=教育a}
{0=王五, 1=男, 2=2, 3=JAvA, 4=3, 5=28, 6=教育b, 7=教育c}

指表头时以表头行做为Key

java
reader.sheet(0).header(1, 2).rows().map(org.ttzero.excel.reader.Row::toMap).forEach(System.out::println);

// 控制台输出
注意此处 ↓ 拼接"证书:类型"做为表头
{姓名=暗月月, 性别=男, 证书:编号=1, 证书:类型=数学, 证书:等级=3, 年龄=30, 教育:教育1=教育a, 教育:教育2=教育b}
{姓名=, 性别=, 证书:编号=2, 证书:类型=语文, 证书:等级=1, 年龄=, 教育:教育1=教育a, 教育:教育2=教育c} // <- 注意此行
{姓名=, 性别=, 证书:编号=3, 证书:类型=历史, 证书:等级=1, 年龄=, 教育:教育1=教育b, 教育:教育2=教育c} // <- 注意此行
{姓名=张三, 性别=女, 证书:编号=1, 证书:类型=英语, 证书:等级=1, 年龄=20, 教育:教育1=教育d, 教育:教育2=教育d}
{姓名=, 性别=, 证书:编号=5, 证书:类型=物理, 证书:等级=7, 年龄=, 教育:教育1=教育x, 教育:教育2=教育x}
{姓名=李四, 性别=男, 证书:编号=2, 证书:类型=语文, 证书:等级=1, 年龄=24, 教育:教育1=教育c, 教育:教育2=教育a}
{姓名=, 性别=, 证书:编号=3, 证书:类型=历史, 证书:等级=1, 年龄=, 教育:教育1=教育b, 教育:教育2=教育c}
{姓名=王五, 性别=男, 证书:编号=1, 证书:类型=高数, 证书:等级=2, 年龄=28, 教育:教育1=教育c, 教育:教育2=教育a}
{姓名=, 性别=, 证书:编号=2, 证书:类型=JAvA, 证书:等级=3, 年龄=, 教育:教育1=教育b, 教育:教育2=教育c}

上面的输出可以看到除表头外所有合并的单元格只有第1个单元格有值其它单元格均为NULL,若要使合并单元格的其它合并项也有值可以将Sheet转为MergedSheet即可。

java
reader.sheet(0).asMergeSheet() // <- 转为MergedSheet
.header(1, 2).rows().map(org.ttzero.excel.reader.Row::toMap).forEach(System.out::println);

// 控制台输出
{姓名=暗月月, 性别=男, 证书:编号=1, 证书:类型=数学, 证书:等级=3, 年龄=30, 教育:教育1=教育a, 教育:教育2=教育b}
{姓名=暗月月, 性别=男, 证书:编号=2, 证书:类型=语文, 证书:等级=1, 年龄=30, 教育:教育1=教育a, 教育:教育2=教育c} // <- 注意此行
{姓名=暗月月, 性别=男, 证书:编号=3, 证书:类型=历史, 证书:等级=1, 年龄=30, 教育:教育1=教育b, 教育:教育2=教育c} // <- 注意此行
{姓名=张三, 性别=女, 证书:编号=1, 证书:类型=英语, 证书:等级=1, 年龄=20, 教育:教育1=教育d, 教育:教育2=教育d}
{姓名=张三, 性别=女, 证书:编号=5, 证书:类型=物理, 证书:等级=7, 年龄=20, 教育:教育1=教育x, 教育:教育2=教育x}
{姓名=李四, 性别=男, 证书:编号=2, 证书:类型=语文, 证书:等级=1, 年龄=24, 教育:教育1=教育c, 教育:教育2=教育a}
{姓名=李四, 性别=男, 证书:编号=3, 证书:类型=历史, 证书:等级=1, 年龄=24, 教育:教育1=教育b, 教育:教育2=教育c}
{姓名=王五, 性别=男, 证书:编号=1, 证书:类型=高数, 证书:等级=2, 年龄=28, 教育:教育1=教育c, 教育:教育2=教育a}
{姓名=王五, 性别=男, 证书:编号=2, 证书:类型=JAvA, 证书:等级=3, 年龄=28, 教育:教育1=教育b, 教育:教育2=教育c}

isEmpty与isBlank的区别

v0.5.6提供了新的空单元格判断方法Row#isBlank,该方法与原有的Row#isEmpty的区别在于isEmpty的判断逻辑是只要包含值和样式(格式化/边框/填充/字体/对齐等)的任何一样都会判定为,而isBlank仅判断单元格的值、值、值,只要单元格无值则判定为

效果如下图所示

202512062334144384c7a16.jpeg

读取行号

你可以使用Row#getRowNum方法或者使用@RowNum注解来获取原始文件行号,与你打开Excel所见一样此行号从1开始

额外属性

v0.5.11支持指定额外属性以丰富Row转对象时的列匹配,目前支持的属性有Force Import(无ExcelColumn注解强制匹配), Ignore Case (忽略大小写)和Camel Case(下划线转驼峰)三种属性,属性间可以自由组合

java
reader.sheet(0)
.forceImport()             // <- 没有ExcelColumn注解的列使用field name匹配
.headerColumnIgnoreCase()  // <- 忽略大小写匹配
.headerColumnToCamelCase() // <- 下划线转驼峰匹配
.dataRows().map(row -> row.to(U.class))
.collect(Collectors.toList());

xlsx和xls格式

大家应该对POI读取xls和xlsx两种格式需要两套API并不陌生吧,POI处理xls消耗内存极大,往往读几MB的文件就需要上百MB内存。 EEC统一了两种格式的API,换句话说你不需要关心该文件是xls还是xlsx,读取时EEC根据文件头来判断格式,然后选择使用何种方式解析文件。EEC读取xls消耗极小的内存,极限测试约1G的100万行xls文件,使用Easyexcel需要约5G内存,而EEC仅需要7MB内存。

我分别对EEC和Easyexcel进行了极限内存测试,也就是跑完测试不抛异常时的最小内存,结果如下。

描述1w/6.9M5w/35M10w/71M50w/487M100w/978M
EEC3M3M3M5M7M
POI50M220M440M2400M5000M

从上图可以看出随着文件逐渐增大POI所需内存也逐渐增大,读取文件所需的内存甚至远远超过文件本身的大小,而EEC读文件所需内存一直比较平稳且远低于POI,基本可以在10MB下完成大文件读取。

大数据量导出

前面已经展示了简单的导出示例,例子中大部分都传入一个数组,但是我们知道对于十万级、百万级的数量,不可能一次拉取到内存,此时分片功能就突现价值了。

自动分片

ListSheet和ListMapSheet默认支持分片,我们只需要覆写protected List<T> more()方法即可。

下面代码将展示如何分页拉取学生数据,每次拉取1024条数据,这样内存中最多也就1024条数据,边写边拉取数据,直到返回空数组或者null。

java
new Workbook().addSheet(new ListSheet<Student>() {
    private int pageNo = 0, limit = 1024;
    @Override
    protected List<Student> more() {
        return service.getPageData(++pageNo, limit);
    }
}).writeTo(Paths.get("F:/excel"));

得益于EEC的Worksheet默认分页,我们无需更多的处理,上面代码即可支持百万级、千万级数据导出

如下代码测试200w随机数字导出的示例

java
// 导出200w数据
final int loop = 2000;
new Workbook("200w").addSheet(new ListSheet<E>() {
    int n = 0; // 页码
    @Override
    public List<E> more() {
        return n++ < loop ? data() : null;
    }
}).writeTo(Paths.get("F:/excel"));

// 生成测试数据
public List<E> data() {
    List<E> list = new ArrayList<>(1000);
    for (int i = 0; i < 1000; i++) {
        E e = new E();
        list.add(e);
        e.nv = random.nextInt();
        e.str = getRandomString();
    }
    return list;
}

// 测试对象
public static class E {
    @ExcelColumn
    private int nv;
    @ExcelColumn
    private String str;
}

打开文件效果如下:

第一页共写入1048576行,这也是xlsx格式单页最大行数

202512062334156dbab9dfc.jpeg

写满第一页后自动新增一个worksheet并写入剩余数据951426,共计200w+2(2个表头)

20251206233415bb6418248.jpeg

使用data-supplier拉取数据

v0.5.14版本新增data-supplier减化了分片开发难度,它被定义为BiFunction<Integer, T, List<T>>其中第一个入参Integer表示已拉取数据的记录数, 第二个入参T表示上一批数据中最后一个对象,业务端可以通过这两个参数来计算下一批数据应该从哪个节点开始拉取, 通常你可以使用第一个参数除以每批拉取的数据大小来确定当前页码,如果数据已排序则可以使用T对象的排序字段来计算下一批数据的游标从而跳过 limit ... offset ...分页查询从页极大提升取数性能。

java
new Workbook()
.addSheet(new ListSheet<E>().setData((i, lastOne) -> i < 2_000_000 ? E.data() : null))
.writeTo(Paths.get("F:/excel/200w.xlsx"));

增加进度兼听

大数据量导出时往往耗时较长,表现出来就是程序卡在那里一动不动,为了防止这种假死现象我们可以在导出时增加一个进度兼听代码段,它位于Workbook#onProgress方法,它有两个入参 第一个是sheet表示当前正在导入哪个工作表,第二个是rows表示已写入的行数,onProgress方法每1000行被执行一次

java
new Workbook()
// 添加进度兼听代码,外部可观察写入数据量,可做导出进度也简单写日志
.onProgress((sheet, rows) -> System.out.println(sheet.getName() + " 已写入: " + rows))
.addSheet(new ListSheet<E>().setData((i, lastOne) -> i < 2_000_000 ? E.data() : null))
.writeTo(Paths.get("F:/excel/200w.xlsx"));

对于导出时长评估的补充说明:xlsx格式本质为zip格式,所以导出可分为两阶段,第一阶段为写数据阶段,第二阶段为压缩阶段。

  • 第一阶段可以根据总数据量和每1000条数据的耗时计算出该阶段的总耗时(每批动态计算来矫正偏差)
  • 第二阶段就比较难动态计算了,一般做法是提前拿文件做基准zip压缩测试,根据每mb的基准时间来计算,好在做完基准测试后可直接根据文件大小就能计算出压缩时长,可以粗估为第一阶段时间同等时间

读取分片数据

对于自动分片的数据,我们不需要一个sheet一个sheet读取,而是直接使用Stream的flatMap功能将worksheet降维处理,如下代码统计200w数据中数字大于1w的个数

java
try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/200w.xlsx"))) {
    long count = reader.sheets()
    .flatMap(Sheet::dataRows) // 使用flatMap降维
    .map(row -> row.getInt(0)).filter(i -> i > 10000) // 取第1列数据并过滤大于10000的值
    .count();
    System.out.println("共计" + count + "个数大于1w");
}

贴出DEBUG日志

java
- load xl\worksheets\sheet1.xml
- Dimension-Range: A1:B1048576
- end of file.
- load xl\worksheets\sheet2.xml
- Dimension-Range: A1:B951426
- end of file.
共计999601个数大于1w

通过DEBUG日志可以看到使用flatMap解析完sheet1后接着解析sheet2,得出结果999601,与excel筛选出的结果一致

2025120623341549ba81529.jpeg202512062334159e2e7becd.jpeg

模板导出

从v0.5.14开始EEC新增模板工作表TemplateSheet,它支持指定一个已有的Excel文件作为模板导出,TemplateSheet将复制模板工作表的样式并替换占位符, 同时TemplateSheet也可以和其它Worksheet混用,这意味着可以添加多个模板工作表和普通工作表。 创建模板工作表需要指定模板文件,它可以是本地文件也可是输入流InputStream,支持的类型包含xls 和xlsx两种格式,除模板文件外还需要指定工作表, 未指定工作表时默认以第一个工作表做为模板。

绑定值

TemplateSheet工作表导出时不受ExcelColumn注解限制,导出的数据范围由模板内占位符决定,默认占位符由一对关闭的大括号${key}组成, 虽然占位符与EL表达式写法相同但模板占位符并不具备EL的能力,所以无法使用${1 + 2}${System.getProperty("user.name")}这类语句来做运算, 模板占位符_仅做替换不做运算_所以不需要担心安全漏洞问题。

setData(java.lang.Object)方法为占位符绑定值,支持对象、Map、Array和List,数据量较大时可绑定一个数据生产者data-supplier来分片拉取数据, 它被定义为BiFunction<Integer, T, List<T>>,其中第一个入参Integer表示已拉取数据的记录数(并非已写入数据), 第二个入参T表示上一批数据中最后一个对象,业务端可以通过这两个参数来计算下一批数据应该从哪个节点开始拉取, 通常你可以使用第一个参数除以每批拉取的数据大小来确定当前页码,如果数据已排序则可以使用T对象的排序字段来计算下一批数据的游标以跳过 limit ... offset ... 分页查询从而大大提升取数性能。

java
new Workbook("模板测试")
// 模板工作表
.addSheet(new TemplateSheet(Paths.get("F:/excel/template.xlsx"))
          // 绑定用户列表
          .setData(userList)
          // 设置一个数据生产者 data-supplier分片查询数据
          .setData((i, lastOne) -> queryUser(i > 0 ? ((User)lastOne).getId() : 0))
          // 普通对象数组工作表
          .addSheet(new ListSheet<>().setData(list)))
.writeTo(Paths.get("F:/excel"));

命名空间

每个占位符都有一个命名空间,格式为${namespace.key}它用于区分不同的数据域,例如汇总数据和列表数据或多个列表数据, 当前只支持一级命名空间如果对象套对象则需要在外部拆分并以不同的命名空间设值

有如下模板,它有3个命名空间,分别为”默认“,”list“和”summary“

202512062334155e65525a4.jpeg

测试代码

java
// 准备测试数据 >>>
Map<String, Object> main = new HashMap<>();
main.put("gysName", " 供应商A");
main.put("gsName", "ABC公司");
main.put("jsName", "亚瑟");
main.put("cgDate", new Date());
main.put("orderNo", "0001");
main.put("orderStatus", "OK");

List<Map<String, Object>> list = new ArrayList<>();
Map<String, Object> row1 = new HashMap<>();
row1.put("xh", 1);
row1.put("jpCode", "45A3495C72");
row1.put("jpName", "name1");
row1.put("num", 10);
row1.put("price", 10);
row1.put("amount", 100);
row1.put("tax", 0.6);
row1.put("taxPrice", 11.6);
row1.put("taxAmount", 116);
row1.put("remark", "备注1");
list.add(row1);
Map<String, Object> row2 = new HashMap<>();
row2.put("xh", 2);
row2.put("jpCode", "F2454E321436");
row2.put("jpName", "name2");
row2.put("num", 20);
row2.put("price", 20);
row2.put("amount", 200);
row2.put("tax", 0.6);
row2.put("taxPrice", 21.2);
row2.put("taxAmount", 212);
row2.put("remark", "备注2");
list.add(row2);

Map<String, Object> summary = new HashMap<>();
summary.put("nums", 30);
summary.put("priceTotal", 30);
summary.put("amountTotal", 300);
summary.put("taxTotal", 0.6);
summary.put("taxPriceTotal", 32.8);
summary.put("taxAmountTotal", 328);
// <<< 测试数据准备结束

new Workbook()
.addSheet(new TemplateSheet(testResourceRoot().resolve("template2.xlsx"))
          .setData(main)  <- 绑定命名空间null
          .setData("list", list) <- 绑定命名空间list
          .setData("summary", summary) <- 绑定命名空间summary
         ).writeTo(Paths.get("F:/excel/命名空间测试.xlsx"));

效果如下:

20251206233415fea7cf016.jpeg

数据格式化

只需要在模板文件中设置好格式化即可,单元格设置的任意格式化都将被复制,如上示例中价格单元格包含格式化¥0.00_),模板文件看不出效果但结果文件可以看到效果(结果为数字所以有格式化效果)

内置函数

占位符中包含三个内置函数它们分别为[@link:][@list:][@media:],分别用于设置单元格的值为超链接、序列和图片, 其中序列的值可以从源工作表中获取也可以使用setData方法来设置,内置函数必须独占一个单元格且仅识别固定的三个内置函数, 任意其它命令将被识别为普通命令空间

占位符整体样式:[@内置函数:][命名空间][.]<占位符>

有如下模板

202512062334158b0289b41.jpeg

java
// 准备测试数据 >>>
List<Map<String, Object>> list = new ArrayList<>();
Map<String, Object> row1 = new HashMap<>();
row1.put("name", "张三");
row1.put("age", 6);
row1.put("sex", "男");
row1.put("pic", "https://m.360buyimg.com/babel/jfs/t20260628/103372/21/40858/120636/649d00b3Fea336b50/1e97a70d3a3fe1c6.jpg");
row1.put("jumpUrl", "https://www.tulingxueyuan.cn");
list.add(row1);

Map<String, Object> row2 = new HashMap<>();
row2.put("name", "李四");
row2.put("age", 8);
row2.put("sex", "女");
row2.put("pic", "https://gw.alicdn.com/bao/uploaded/i3/1081542738/O1CN01ZBcPlR1W63BQXG5yO_!!0-item_pic.jpg_300x300q90.jpg");
row2.put("jumpUrl", "https://www.tulingxueyuan.cn/zjtl/");
list.add(row2);
// <<< 测试数据准备结束

new Workbook()
// 模板工作表
.addSheet(new TemplateSheet(Paths.get("F:/excel/template.xlsx"))
          // 替换模板中占位符
          .setData(list)
          // 替换模板中"@list:sex"值为性别序列
          .setData("@list:sex", Arrays.asList("未知", "男", "女")))
.writeTo(Paths.get("F:/excel/内置函数测试.xlsx"));

效果如下:

202512062334157fe0acc34.jpeg

性别列为"序列",头像列为"图片",简历原件为"超链接"

多种混合工作表

在EEC中Worksheet及其子类均被视为数据源,这些数据源均可以混合使用,输出协议由WorksheetWriter决定,目前仅支持xlsx和csv格式,所以即使模板为xls格式输出也将是xlsx格式

java
new Workbook()
.addSheet(new TemplateSheet(Paths.get("F:/excel/1.xlsx"))) // <- xlsx模板工作表
.addSheet(new TemplateSheet(Paths.get("F:/excel/2.xls"))) // <- xls模板工作表
.addSheet(new ListSheet<>(randomTestData())) // <- 普通工作表
.writeTo(Paths.get("F:/excel/混合模板.xlsx"));

兼容性

为了解决切换到EEC后导致现有模板失效从而大面积修改模板的问题,EEC提供了setPrefixsetSuffix两个方法来修改占位符前缀和后缀,如现有模板占位符为{key} 则可以使用setPrefix("{")来重置前缀,这样你不需要修改现有模板来完成适配。

java
new Workbook()
// 模板工作表
.addSheet(new TemplateSheet(Paths.get("F:/excel/template.xlsx"))
          .setPrefix("{") // <- 重置前缀为"{"
          .setData(list))
.writeTo(Paths.get("F:/excel/内置函数测试.xlsx"));

特殊说明

TemplateSheet工作表使用ExcelReader读取源文件,并复制样式等信息到新的工作表,它并不是直接在原工作表中追加数据,所以会丢失一些信息(只能读取当前ExcelReader所支持的内容)。

除此之外v0.5.14版本还有一些功能限制,具体表现如下

  • 不支持多Table,如果Table列与其余固定文本一起时固定文本也将被复制
  • 替换占位符时不解析现有对象中的ExcelColumn注解,所以在实体里设置的注解属性完全无效
  • 模板为xls时颜色会出现偏差,我尝试用POI读取颜色时也出现同样问题
  • 暂时不支持自动分页,模板有更复杂的内容,无法处理分页后哪些部分需要复制到新的工作表,所以暂时不支持分页
  • 模板中包含双色填充时导出结果只会保留color1的颜色
  • 由于eec读取xls图片有BUG,所以模板文件中有图片时可能导致导出异常

动态设置样式

所谓动态就是根据单元格或行数据不同为每个单元格或者每一行设置不同样式,这个功能可以极大丰富文件的可读性和多样性,算是EEC的个性化功能吧。

使用StyleDesign注解

Java Bean可以使用@StyleDesign注解动态编辑样式(包含字体,填充,边框,格式等),StyleDesign作用于TypeFieldMethod,前者影响整行样式,后两种影响单个Cell

作用于Type

StyleDesign指定的类需要实现StyleProcessor<T>接口,该接口方法有3个参数,第一个为Java Bean,第2个是现有样式,第3个是Styles实例,

java
@StyleDesign(using = StudentScoreStyle.class)
public static class DesignStudent {
    @ExcelColumn
    private String name;
    @ExcelColumn
    private int score;
}

public static class StudentScoreStyle implements StyleProcessor<DesignStudent> {
    @Override
    public int build(DesignStudent o, int style, Styles st) {
        // 低于60分时背景色标黄
        if (o.getScore() < 60) {
            style = st.modifyFill(style, new Fill(PatternType.solid, Color.orange));
        } else if (o.getScore() > 95) {
            // 粗体+下划线(这里使用clone可以保留原字体和大小)
            Font newFont = st.getFont(style).clone().underline().bold();
            style = st.modifyFont(style, newFont);
        }
        return style;
    }
}

效果如下:95分以上的行字体被加粗并加下划线,低于60分的整行背景色标黄

20251206233415d3af47024.png

作用于Field和Method

StyleDesign使用于Field和Method用法与Type完全一样,只是传入的第1个参数变成单元格的值

java
public static class DesignStudent {
    @StyleDesign(using = NameMatch.class)
    @ExcelColumn
    private String name;
    private int score;

    @StyleDesign(using = ScoreStyle.class)
    @ExcelColumn
    public int getScore() {
        return score;
    }
}

private static final Set<String> VIP_SET = new HashSet<>(Arrays.asList("a", "b", "x"));

public static class NameMatch implements StyleProcessor<String> {
    @Override
    public int build(String name, int style, Styles sst) {
        if (VIP_SET.contains(name)) {
            Font font = sst.getFont(style).clone();
            style = sst.modifyFont(style, font.bold());
        }
        return style;
    }
}

public static class ScoreStyle implements StyleProcessor<Integer> {
    @Override
    public int build(Integer score, int style, Styles st) {
        if (score < 60) {
            style = st.modifyFill(style, new Fill(PatternType.solid, Color.orange));
        }
        return style;
    }
}

202512062334158532929b5.png

使用StyleProcessor

对于ListMapSheet,ResultSetSheet或StatementSheet这三种无法使用注解的Worksheet,EEC提供了setStyleProcessor方法,与StyleDesign一样,可以应用于整行或者单个单元格

作用于Worksheet

java
new Workbook()
.addSheet(new ListSheet<>(list
                          , new Column("姓名", "name")
                          , new Column("数学成绩", "score")
                          , new Column("备注", "toString")
                         ).setStyleProcessor((o,s,st) -> o.getScore() < 60 ? st.modifyFill(s, new Fill(PatternType.solid, Color.orange)) : s))
.writeTo(Paths.get("F:/excel"));

低于60分整个单元格标黄

202512062334157fbf67992.png

作用于Column

java
new Workbook()
.addSheet(new ListSheet<>(list
                          , new Column("姓名", "name").setStyleProcessor((n, s, sst) -> Styles.modifyHorizontal(s, Horizontals.CENTER))
                          , new Column("数学成绩", "score").setWidth(12D)
                          , new Column("备注", "toString").setWidth(25.32D).setWrapText(true)
                         )).writeTo(Paths.get("F:/excel"));

上面的代码使用是将“姓名”列设置为居中

202512062334154c2e17d87.png

动态样式处理就展示这么多,对于样式处理有一定的学习成本,EEC处理样式一定有这两步,第一步是清除当前样式,第二步是添加新的样式。样式之间使用|运算符连接,也可以使用Styles.modifyXX不简化

静态设置样式

Excel样式包含格式化NumFmt、字体Font、填充Fill、边框Border、 垂直对齐Verticals和水平对齐Horizontals以及自动折行组成, EEC简化了样式设计,单元格样式由一个int值保存,它可以极大减少内存开销和提升查找速度,但短板是可用的样式减少,当前最多只能包含256个格式化,64个字体、64个填充和64个边框, 对于日常的导出需求应该是够用的但复杂场景就需要考虑将int扩大到long。

相对于动态样式而言,设置静态样式是一次性的在初始化的时候计算所以并不会影响导出速度,默认的样式大多数情况下并不能满足每个人的审美, 好在EEC有多种方式修改默认的表头或者数据行的样式。

修改表头样式

Worksheet暴露了几个修改表头样式的方法setHeadStylesetHeadStyleIndex可以通过这些方法设置表头样式,每个Worksheet都可以设置不同的表头。

修改样式前必须先实例化Workbook然后才能修改样式。下面的示例展示如何修改表头字体、背景和边框

java
ListSheet<Item> sheet = new ListSheet<>(Item.randomTestData());

// 必须先执行这一步,将Worksheet添加到Workbook
Workbook workbook = new Workbook("Custom header style").addSheet(sheet);

// 然后才能修改样式
sheet.setHeadStyle(new Font("微软雅黑", 18, Font.Style.BOLD, Color.black)
                   , new Fill(PatternType.gray0625, Color.lightGray)
                   , new Border(BorderStyle.DOUBLE, Color.red));

workbook.writeTo(Paths.get("F:/excel"));

效果如下:

20251206233415adde9251c.png

其中BorderStyle效果如下:

202512062334151dd2478b7.png

PatternType效果如下:

20251206233415422a7ce02.png

修改部分表头样式

如果仅需要修改表头的部分样式时则可以先获取原有样式然后再修改部分属性即可。 下面的示例展示修改部分表头的部分属性,比如修改字体、修改填充色等

java
ListSheet<Item> sheet = new ListSheet<>(Collections.singletonList(new Item()));
Workbook workbook = new Workbook().addSheet(sheet);

Styles styles = workbook.getStyles();
int style = sheet.defaultHeadStyle();
// 仅修改字体颜色
Font font = styles.getFont(style).clone() // 先获取原有样式并复制(不然会影响原样式)
.setColor(new Color(191, 191, 191)); // 设置新的样式
int newStyle = styles.modifyFont(style, font); // 将新字体添加进样式表
// 修改填充色
int borderStyle = styles.modifyFill(style, new Fill(PatternType.solid, new Color(247, 150, 70)));

sheet.setColumns(new Column[] {
    new Column("商品名称", "productName").setWidth(20.0D).setWrapText(true)
    , new Column("商品编码", "goodsNo").setHeaderStyle(borderStyle)
    , new Column("规格型号", "model")
    , new Column("品牌", "brandNameCn").setWidth(12.63D)
    , new Column("单位", "measure").setWidth(9.63D)
    , new Column("在库库存(勿改)", "quantity").setWidth(16.25D).setNumFmt("###0").setHeaderStyle(newStyle)
    , new Column("盘点库存", "editQuantity").setWidth(12.63D).setHeaderStyle(borderStyle)
});

效果如下:

202512062334153577e05d8.jpeg

可以看到"在库库存"列观感上就给用户不能修改的视觉,这样可以避免用户将库存填写在此列,而应该填写在”盘点库存“列,并且将两列必填项的背景改为橙色可以着重显示。

清除表头样式

清除表头样式就比较简单了,可以直接给StyleIndex赋值为0即可。

java
ListSheet<Item> sheet = new ListSheet<>(Item.randomTestData());
Workbook workbook = new Workbook("Custom header style").addSheet(sheet);

// Style Index设置为【0】
sheet.setHeadStyleIndex(0);
workbook.writeTo(Paths.get("F:/excel"));

效果如下:

20251206233415960a50854.jpeg

修改Body样式

与表头类似Column也提供了类似的方法,用户可以通过setCellStyle方法修改样式,这里就不赘述了,也支持动态修改样式,请参照动态设置样式

v0.5.12提供所有样式修改,你可以在创建Column时调用setFontsetBordersetNumFmtsetFillsetHorizontalsetVertical等方法直接设置初始样式

java
new Workbook()
.setAutoSize(true) // <- 自适应列宽
.addSheet(new ListSheet<>(randomTestData()
                          , new Column("编码", "code").setFont(new Font("Trebuchet MS", 20))
                          , new Column("姓名", "name").setFont(new Font("Trebuchet MS", 20)).setHorizontal(Horizontals.CENTER) // <-- 设置水平居中
                          , new Column("日期", "date").setFont(new Font("华文行楷", 11)).setNumFmt("yyyy-mm-dd hh:mm:ss")
                          , new Column("数字", "num").setFont(new Font("Bauhaus 93", 14)).setNumFmt("#,##0_);[Red]-#,##0_);0_)") // <- 指定字体和格式化
                         )).writeTo(Paths.get("F:/excel"));

202512062334156d6e13eff.jpeg

指定导出时的列顺序和位置

默认情况ListSheet根据对象的Field自然顺序导出,ListMapSheet是无序的,ResultSetSheet和StatementSheet的顺序当然就是Query字段的顺序,除了默认顺序还可以指定Column来调整顺序。

v0.4.13版本开始,ExcelColumn注解中增加了colIndex属性以及Column增加#setColIndex方法。此属性定义为int类型,用于指定_从‘0’开始_的列位置,从‘0’开始从‘0’开始 重要的事情说三遍。

此值的最大值与excel版本有关,excel97-2003限制为256,xlsx版本限制为16_384,因为colIndex是从0开始,所以要在此限制上减1,分别为25416_383, 超过此限制会抛出 TooManyColumnsException 异常。

此位置是绝对位置,如果有相同的列下标,这些列下标会依次往后排列

下面列一些实际例子:

自然顺序

我们先定义一个基础的类如下:

java
public class OrderEntry {
    @ExcelColumn(colIndex = 0)
    private String s;
    @ExcelColumn( colIndex = 1)
    private Date date;
    @ExcelColumn(colIndex = 2)
    private Double d;
    @ExcelColumn(colIndex = 3)
    private String s2 = "a";
    @ExcelColumn(colIndex = 4)
    private String s3 = "b";
    @ExcelColumn(colIndex = 5)
    private String s4 = "c";

    // 这里是 GET SET 方法...
}

这是一个自然顺序的类,如你想象导出结果如下:

20251206233415abc468240.jpeg

相同列下标

如果出现相同列下标会如何处理,是抛异常还是别的?

我们定义一个类继承OrderEntry,将原来第2和第3列都设置为5,如下:

java
public class SameOrderEntry extends OrderEntry {
    @Override
    @ExcelColumn(colIndex = 5)
    public Double getD() {
        return super.getD();
    }

    @Override
    @ExcelColumn(colIndex = 5)
    public String getS2() {
        return super.getS2();
    }
}

这样列下标为5的一共有3个,分别是Double dString s2String s4,现在的顺序是[0, 1, 4, 5, 5, 5],EEC导出会是怎样呢?

20251206233415858a9080e.png20251206233415ddd2f5b3f.jpeg

C、D两列空出来了,正好对应上面跳过的2,3。那3个5如何处理呢?它会按照属性定义的顺序,正好就是[d, s2, s4]

极限下标

我们设置一些较大的下标测试一下,设置一个xlsx可接受的最大下标16_383,定义如下:

java
public class LargeOrderEntry extends OrderEntry {
    @Override
    @ExcelColumn(colIndex = 16_383)
    public Date getDate() {
        return super.getDate();
    }

    @Override
    @ExcelColumn(colIndex = 189)
    public String getS2() {
        return super.getS2();
    }
}

效果如下,列太大所以只接了两个较大的列进行拼接

2025120623341514af3c4ef.jpeg

指定开始行

默认的EEC从第1行开始写,从v0.5.8版本开始你可以通过Sheet#setStartRowIndex来指定第一行的位置,行下标的范围为1~${limit},这里limit与文件格式相关,xlsx格式默认最大下标1_048_576,xls最大下标65_536

startRowIndexcolIndex两个属性可以搭配使用,下面代码展示从第7行第4列开始写表格

java
List<RepeatableEntry> list = RepeatableEntry.randomTestData();
int startRowIndex = 7; // 指定起始行
new Workbook()
.setAutoSize(true)
.addSheet(new ListSheet<>(list).setStartRowIndex(startRowIndex))
.writeTo(Paths.get("F:/excel/Repeat Columns From 7.xlsx"));

// 读取时指定起始行
try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/Repeat Columns From 7.xlsx"))) {
    List<RepeatableEntry> readList = reader.sheet(0).header(startRowIndex).bind(RepeatableEntry.class).rows()
    .map(row -> (RepeatableEntry) row.get()).collect(Collectors.toList());
}

20251206233415402dde1e9.jpeg

默认情况下无论行和列的开始下标是多少,打开文件时表格都会停留在左上角,如果不希望滚动到左上角则需要在调用setStartRowIndex时指定参数scrollToVisibleArea为false,此时打开文件时活动光标在A1单元格, 因为光标停留在A1所以打开文件可能无法在屏幕中看到数据,需要手动滚动到数据行,容易产生没有数据的误会,请谨慎使用。

202512062334152c329ece7.jpeg

合并单元格

EEC通过扩展参数merge_cells来添加合并单元格,合并是作用于一个区域,所以使用Dimension来保存一个合并的起始和结束行列信息,你可以合并任意多个单元格,其中只有一个限制,那就是合并后的单元格可以相邻但不能重叠

写入

示例:

java
List<Dimension> mergeCells = Arrays.asList(Dimension.of("A1:A10"), Dimension.of("B2:E5"));
new Workbook()
.addSheet(new EmptySheet().putExtProp(Const.ExtendPropertyKey.MERGE_CELLS, mergeCells))
.writeTo(Paths.get("F:/excel"));

效果如下:

20251206233415aa396c855.jpeg

如果单元格有重叠程序不会报错,但打开文件时会弹出警告,如果点击“是”将会尝试修复,一般情况下会删除产生重叠的合并

例如我们将上面的第二个合并中B2:E5改为A2:E5将在A2单元格重叠,打开文件如下图

202512062334154760a2352.jpeg

点击“是”后可以看到仅保留了第一个合并,而将造成重叠的第二个合并删除了

2025120623341599a2cf612.jpeg

你不能寄希望在自动修复上,那样将产生不可预期的效果,EEC也不会进行相关检查,所以最好事先预检,好在此预检并不复杂。

读取

我们知道合并后的值只保存在左上的第一个单元格中其它单元格均为null,EEC提供了copy-on-merged方法,该方法会将第一个单元格的值复制到其它单元格中使得合并范围内的所有单元格读取的内容完全一样。

假如有如下合并单元格

20251206233415f4b9f69aa.jpeg

使用reader.sheet(0).rows().forEach(System.out::println)普通读取结果如下,除了第一个单元格有值外其余单元格均为null,业务代码需要特殊处理才行否则将丢失数据。

java
 ab |  | 
    |  | 
    |  | 
    |  | 
    |  | 
    |  |

使用copy-on-merge

org.ttzero.reader.Sheet可以使用asSheetasMergeSheetasCalcSheetasFullSheet相互转换,转换后Worksheet就有了不同的功能,考虑到普通的Sheet读取速度最快所以请根据需求选择。

java
try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/abc.xlsx"))) {
    // 使用asMergeSheet转换为MergeSheet
    MergeSheet sheet = reader.sheet(0).asMergeSheet();
    // 合并单元格信息
    Grid mergeGrid = sheet.getMergeGrid();
    // 使用test来判断某个单元格是否为合并单元格
    assert mergeGrid.test(3, 1);

    // 获取所有合并单元格的位置
    List<Dimension> mergeCells = sheet.getMergeCells();

    // 打印
    sheet.rows().forEach(System.out::println);
}

得到Grid后可以通过test方法来测试单元格是否为合并单元格,另一个重要的方式中size,该方法返回合并单元格个数。

使用copy-on-merged后将得到如下效果

java
ab | ab | ab
ab | ab | ab
ab | ab | ab
ab | ab | ab
ab | ab | ab
ab | ab | ab

这样我们不需要额外处理null

设置多行表头

EEC从v0.5.3开始支持多表头导出,同样的可以使用注解或者手动指定两种方式,最多支持10层。

使用注解

Java Bean可以使用多个ExcelColumn来实现,多个ExcelColumn的顺序与导出的最终表头完全一致,具体示例如下:

java
@ExcelColumn("订单号")
private String orderNo;

@ExcelColumn("收件人")
private String recipient;

@ExcelColumn("收件地址")
@ExcelColumn("省")
private String province;

@ExcelColumn("收件地址")
@ExcelColumn("市")
private String city;

@ExcelColumn("收件地址")
@ExcelColumn("区")
private String area;

@ExcelColumn("收件地址")
@ExcelColumn("详细地址")
private String detail;

定义如上Java实体,在‘省’,‘市’,‘区’,和‘详细地址‘4个属性上面加了一个共同的父表头‘收件地址’,效果如下

202512062334150c76129a0.jpeg

更为复杂的示例

java
@ExcelColumn("TOP")
@ExcelColumn
@ExcelColumn
@ExcelColumn("订单号")
private String orderNo;

@ExcelColumn("TOP")
@ExcelColumn
@ExcelColumn
@ExcelColumn("收件人")
private String recipient;

@ExcelColumn("TOP")
@ExcelColumn
@ExcelColumn("收件地址")
@ExcelColumn("省")
private String province;

@ExcelColumn("TOP")
@ExcelColumn
@ExcelColumn("收件地址")
@ExcelColumn("市")
private String city;

@ExcelColumn("TOP")
@ExcelColumn
@ExcelColumn("收件地址")
@ExcelColumn("区")
private String area;

@ExcelColumn("TOP")
@ExcelColumn
@ExcelColumn("收件地址")
@ExcelColumn("详细地址")
private String detail;

我们在头顶再加一个共同的表头‘TOP’,展示效果如下

20251206233415df9fdb03a.jpeg

手动添加

Column增加addSubColumn方法用于添加子表头,顺序与注解相似,第一个在最上面最后一个需要指定字段名。这种方式多用于ListMapSheet和ResultSetSheet

java
new Workbook().addSheet(new ListSheet<>(data
                                        , new Column("姓名", "name")
                                        , new Column("性别", "sex")
                                        , new Column("证书").addSubColumn(new Column("编号", "no"))
                                        , new Column("证书").addSubColumn(new Column("类型", "type"))
                                        , new Column("证书").addSubColumn(new Column("等级", "level"))
                                        , new Column("年龄", "age")
                                        , new Column("教育").addSubColumn(new Column("教育1", "jy1"))
                                        , new Column("教育").addSubColumn(new Column("教育2", "jy2"))))
.writeTo(Paths.get("F:/excel"));

20251206233415735a7c081.jpeg

读取带多行表头的文件

v0.5.6开始EEC支持指定表头位置,你可以通过Sheet#header(fromRowNum, toRowNum)来指定表头,header方法支持fromRowNumtoRowNum两个参数,为了更加直观这两个参数均从1开始,和打开excel所看到的一样,同时from和to两端都是包含的,对于多行表头来说header将以A1:A2:A3这种格式进行纵向拼接

我们拿上面【手动添加】的文件为例子来展示如何使用header来支持多表头,我们只需要设置header(1, 2)指定两行表头即可reader.sheet(0).header(1, 2).dataRows().map(Row::toMap).forEach(System.out::println),通过这个命令可输入如下结果

java
{姓名=暗月月, 性别=男, 证书:编号=1, 证书:类型=数学, 证书:等级=3, 年龄=30, 教育:教育1=教育a, 教育:教育2=教育b}
{姓名=暗月月, 性别=男, 证书:编号=2, 证书:类型=语文, 证书:等级=1, 年龄=30, 教育:教育1=教育a, 教育:教育2=教育c}
{姓名=暗月月, 性别=男, 证书:编号=3, 证书:类型=历史, 证书:等级=1, 年龄=30, 教育:教育1=教育b, 教育:教育2=教育c}
{姓名=张三, 性别=女, 证书:编号=1, 证书:类型=英语, 证书:等级=1, 年龄=20, 教育:教育1=教育d, 教育:教育2=教育d}
{姓名=张三, 性别=女, 证书:编号=5, 证书:类型=物理, 证书:等级=7, 年龄=20, 教育:教育1=教育x, 教育:教育2=教育x}
{姓名=李四, 性别=男, 证书:编号=2, 证书:类型=语文, 证书:等级=1, 年龄=24, 教育:教育1=教育c, 教育:教育2=教育a}
{姓名=李四, 性别=男, 证书:编号=3, 证书:类型=历史, 证书:等级=1, 年龄=24, 教育:教育1=教育b, 教育:教育2=教育c}
{姓名=王五, 性别=男, 证书:编号=1, 证书:类型=高数, 证书:等级=2, 年龄=28, 教育:教育1=教育c, 教育:教育2=教育a}
{姓名=王五, 性别=男, 证书:编号=2, 证书:类型=JAvA, 证书:等级=3, 年龄=28, 教育:教育1=教育b, 教育:教育2=教育c}

我们可以看到中间合并的表头表现为证书:编号, 证书:类型, 证书:等级,如果Java bean使用EEC注解的话也可以直接转对象reader.sheet(0).header(1, 2).dataRows().map(row -> row.to(Order.class)).forEach(Print::println)和单行表头完全一样

自定义表头

v0.5.6同样也支持自定义表头,如果自动解析表头有问题则可以设置自定义表头

java
// 创建自定义表头
org.ttzero.excel.reader.Row headerRow2 = new org.ttzero.excel.reader.Row() {};
Cell[] cells2 = new Cell[8];
cells2[0] = new Cell((short) 1).setSv("姓名");
cells2[1] = new Cell((short) 2).setSv("性别");
cells2[2] = new Cell((short) 3).setSv("证书:编号");
cells2[3] = new Cell((short) 4).setSv("证书:类型");
cells2[4] = new Cell((short) 5).setSv("证书:等级");
cells2[5] = new Cell((short) 6).setSv("年龄");
cells2[6] = new Cell((short) 7).setSv("教育:教育1");
cells2[7] = new Cell((short) 8).setSv("教育:教育2");
headerRow2.setCells(cells2);
// 使用自定义表头
reader.sheet(0).reset().header(2).bind(Object.class, new HeaderRow().with(2, headerRow2))
.rows().map(Row::toMap).forEach(System.out::println);

关于自适应列宽

v0.5.3版本大幅优化了自适应列宽计算方式,使得在默认字体下列宽更加精准,相对于POI的自适应结果EEC对中文处理更精准,EEC设置自适应列宽只需要调用setAutoSize即可。

v0.5.12版本进一步优化字体宽度计算逻辑,除了支持“宋体11号”字体外现在支持绝大部分字体和字号,同时还优化了自动折行时计算逻辑,升级后将分组计算每段文本宽度取最大值, 而不是当做一个长字符串处理

默认字体

java
// 测试类
public static class WidthTestItem {
    @ExcelColumn(value = "整型", format = "#,##0_);[Red]-#,##0_);0_)")
    private Integer nv;
    @ExcelColumn("字符串(en)")
    private String sen;
    @ExcelColumn("字符串(中文)")
    private String scn;
    @ExcelColumn(value = "日期时间", format = "yyyy-mm-dd hh:mm:ss")
    private Timestamp iv;
}

new Workbook()
.setAutoSize(true) // <- 自适应列宽
.addSheet(new ListSheet<>(randomTestData()))
.writeTo(Paths.get("F:/excel"));

20251206233415a16a6afa8.jpeg

自定义字体

下面修改4列的4种字体和字号,看一下自适应列宽的效果

java
new Workbook()
.setAutoSize(true) // <- 自适应列宽
.addSheet(new ListSheet<>(randomTestData()
                          , new Column("整型", "nv").setNumFmt("#,##0_);[Red]-#,##0_);0_)").setFont(new Font("Bauhaus 93", 16))
                          , new Column("字符串(EN)", "sen").setFont(new Font("Trebuchet MS", 20))
                          , new Column("字符串(中文)", "scn").setFont(new Font("微软雅黑", 8))
                          , new Column("日期", "iv").setNumFmt("yyyy-mm-dd hh:mm:ss").setFont(new Font("华文行楷", 14))
                         )).writeTo(Paths.get("F:/excel"));

2025120623341543d0cd490.jpeg

优化后效果看上去还不错,当然也有一些字体计算出来的结果与实际显示效果可能有很大偏差,此时可以覆写XMLWorksheetWriter#stringWidth方法调整, 内部使用SwingUtilities2.getFontMetrics#stringWidth方法计算字符串宽度。测试发现windows系统自带的中文字体均能很好的适应, 但几乎所有的英文字体均无法正常适应要么无法适应中文要么无法适应英文所以调整起来还是比较麻烦,EEC也只能取巧处理。

Number Format列如何计算宽度

如果格式化的列使用上面的计算方法就不准确了,格式化后的字符串基本会在原字符串上加一些分隔符,所以一般来说格式化后的长度比原长度更长,比如最常见的数字格式化#,##0,它的使用是每3位加一个逗号, 列宽与数字大小成正比,数字越大添加的逗号越多宽度越大。

最终的列宽与每个格式相关,所以计算列宽的方法也在NumFmt实例中,自定义格式化需要重写calcNumWidth方法来微调,计算方法可以参考NumFmt#calcNumWidth通用计算方法。

java
new Workbook()
.setAutoSize(true)
.addSheet(new ListSheet<>(expectList
                          , new Column().setNumFmt(new NumFmt("yyyy-mm-dd hh:mm:ss") { // <-- 设置NumFmt时重置计算方法
                              @Override
                              public double calcNumWidth(double base, Font font) {
                                  // TODO 根据字体和字号计算宽度
                                  return super.calcNumWidth(base, font);
                              }
                          })
                         )).writeTo(Paths.get("F:/excel"));

指定单列自适应宽度

除在工作表所有列自适应外还支持单列自适应,可在创建列的时候指定某列自适应列宽new Column().autoSize()

java
new Workbook()
.addSheet(new ListSheet<>("期末成绩", expectList
                          , new Column("学号", "id")
                          , new Column("姓名", "name").autoSize() // <-单列自适应
                          , new Column("成绩", "score")
                         )
         ).writeTo(Paths.get("F:/excel"));

202512062334151b34aae11.jpeg

戴上紧箍咒吧

自适应列宽在某种程度上来说可以使文档更美观,但如果某个单元格文字太长会让楼歪掉,这个时候就需要给它戴上一个紧箍咒,不能让它超过我们设定的范围, 这个设定是通过ExcelColumn注解的maxWidth属性实现,Column也可以使用width属性限定,我们看下效果:

202512062334154d6dd035c.jpeg

左边是自适应列宽,右边是自适应列宽+MaxWidth+Wrap的效果,右边的效果只需要添加@ExcelColumn(maxWidth = 20D, wrapText = true)属性即可。

多个属性间的组合逻辑

当前设置列宽有2个属性,分别是auto-size和width,组合效果如下

auto-sizewidth效果
--默认固定宽度
TRUE-自适应宽度
-10固定宽度10
TRUE10min(自适应宽度,10)
FALSE-默认固定宽度
FALSE10固定宽度10

批注

表头批注可以使用注释HeaderComment或创建Column指定new Column().setHeaderComment(),批定批注时还可以额外指定宽度和高度

使用注解

java
public static class Stock {
    @ExcelColumn("库存")
    private int stock;
    @ExcelColumn(value = "库存健康度", comment = @HeaderComment(value =
                                                           "健康:库存大于阈值20%\n" +
                                                           "正常:库存高于阈值10%\n" +
                                                           "警告:库存高于阈值0~10%\n" +
                                                           "危险:库存低于阈值10%", width = 120))
    private StockHealth stockHealth;
}

// 生成测试数据
List<Stock> list = new ArrayList<>();
list.add(new Stock(60, StockHealth.HEALTHY));
list.add(new Stock(40, StockHealth.NORMAL));
list.add(new Stock(10, StockHealth.DANGER));
// 导出
new Workbook().addSheet(new ListSheet<>(list)).writeTo(Paths.get("F:/excel/批注测试.xlsx"));

2025120623341592c8787a9.jpeg

使用Column#setHeaderComment添加

java
new Workbook().addSheet(new ListSheet<>(list)
                        .setColumns(new Column("库存", "stock")
                                    , new Column("库存健康度", "stockHealth")
                                    .setHeaderComment(new Comment(null,
                                                                  "健康:库存大于阈值20%\n" +
                                                                  "正常:库存高于阈值10%\n" +
                                                                  "警告:库存高于阈值0~10%\n" +
                                                                  "危险:库存低于阈值10%", 120., 60.))))
.writeTo(Paths.get("F:/excel/批注测试.xlsx"));

使用addComment手动添加批注

首先需要从Sheet拿到Comments,Comments是一个集合体它可以包含多个批注,目前Comment对象设计不太友好,只能通过ref指定位置没有办法指定row和col指定位置,当然头部批注也可以使用此方法添加,此方法更加灵活。

plain
Workbook workbook = new Workbook();
ListSheet listSheet = new ListSheet<>(list);
// 获取Comments
Comments comments = listSheet.createComments();
// A2单元格添加批注
comments.addComment("A2", null, "实际库存");
// B4单元格添加批注
comments.addComment("B4", "库存不足", "底于警戒线13%,请尽快添加库存");
workbook.addSheet(listSheet);
workbook.writeTo(Paths.get("F:/excel/批注测试.xlsx"));

20251206233415a1fc5b48e.jpeg

实战

场景:导入并校验数据是否合规,数据不合规时在对应的Cell上更改字体和背景颜色且通过批注添加异常信息

  1. 提前检查数据是否合规,如果全部合规就执行导入,如果有一条不合规就提前中断并创建Excel
  2. 使用TemplateSheet模板工作表做为输出源,这样可以最大限度保留原始文件样式
  3. 检查数据行并按需修改“字体”,“填充色”以及tooltips
java
public void testDataCheck() throws IOException {
try (ExcelReader reader = ExcelReader.read(Paths.get("F:/excel/students.xlsx"))) {
    // 提前检查数据是否合规(任意一条不合规就中断)
    boolean invalid = reader.sheet(0).dataRows().map(row -> row.too(Student.class)).anyMatch(e -> !check(e));

    // 检查正常的情况下处理导入
    if (!invalid) {
        // TODO 正常业务处理
    } else {
        // 包含不合规的数据则创建一个Excel
        new Workbook().addSheet(new TemplateSheet(Paths.get("F:/excel/students.xlsx")) {
            @Override
            protected void resetBlockData() {
                super.resetBlockData();

                // 获取样式表
                Styles styles = workbook.getStyles();

                // 再次全面检查所有行数据
                for (int i = 0, position = rowBlock.position(); i < position; i++) {
                    org.ttzero.excel.entity.Row row = rowBlock.get(i);
                    Cell[] cells = row.getCells();

                    // 检查必要列

                    // 检查“姓名”(设定第2列为“姓名”
                    Cell cell = cells[1];
                    String v = checkName(cell.stringVal);
                    // "姓名"不合规
                    if (v != null) {
                        // 获取原始样式
                        int style = styles.getStyleByIndex(cell.xf);
                        // 修改字体
                        // 如果仅仅是改字体样式,比如改为红色,加粗,斜体等可以先获取原始字体然后再修改
                        Font font = styles.getFont(style); // 注意:这里拿到的是字体的引用,修改前必须clone一份新字体
                        // 修改字体样式 - 改为斜体
                        style = styles.modifyFont(style, font.clone().italic()); // <- 注意这里clone了原始字体然后再改为斜体,如果不clone则将修改所有使用原始字体的单元格

                        // 修改填充色 - 改为橙色
                        style = styles.modifyFill(style, new Fill(Color.ORANGE));

                        // 添加进样式表并修改单元格样式
                        cell.xf = styles.of(style);

                        // 添加tooltips
                        createComments().addComment(new String(int2Col(2)) + (row.getIndex() + 1), new Comment("", v)); // int2Col(2) 将第2列转为Excel的ref值也就是'B'
                    }
                }
            }
        }.setPrefix("$#@!$")).writeTo(Paths.get("F:/excel/student-checked.xlsx"));
    }
}
}

效果如下

2025120623341529cf9f661.jpeg

目前版本暂时不支持读取批注,敬请关注

读取Excel中的图片

导出图片请查看章节 导出Excel#导出图片

从v0.4.12版本开始支持读取excel文件中的图片,目前有两种途径获取图片信息,一是从ExcelReader中获取所有图片,另一个是从各Worksheet中获取当前Worksheet包含的图片。

v0.5.12支持读取POI的内嵌图片,读取方法不变listPictures将返回所有图片

java
// 从Workbook中获取所有图片
List<Drawings.Picture> pictures = reader.listPictures();

// 取第一个worksheet中包含的图片
List<Drawings.Picture> pictures = reader.sheet(0).listPictures();

返回的Drawings.Picture类型,包含Worksheet,位置,本地临时路径,网络图片URL(如果是联机图片)以及是否为背景图片等信息,拿到本地临时路径后就可以将图片复制到其它任意位置,另外这里的位置信息是图片左上和右下在单元格的行列位置,对象为Dimension它包含"首行", "首列", "末行", "末列" 4个位置,例如:下图中图片在worksheet的位置为C39:H52

202512062334155f2773231.jpeg

下面方法实现图片复制功能

java
// From workbook
List<Drawings.Picture> pictures = reader.listPictures();

// 如果excel不包含图片则pictures为NULL,所以防止NPE这里判断pictures
if (pictures != null) {
    // Copy images
    for (Drawings.Picture pic : pictures) {
        // 将图片复制到d盘
        Path dest = Paths.get("F:/excel", pic.sheet.getName(), pic.localPath.getFileName().toString());
        if (!Files.exists(dest.getParent())) FileUtil.mkdir(dest.getParent());
        Files.copy(pic.localPath, dest, StandardCopyOption.REPLACE_EXISTING);
    }
}

v0.4.13支持xls的图片读取,方法与xlsx完全一样

20251206233415d4157fb3d.jpeg

xls图片保存在Workbook globals里,它处于Wroksheet之前,但是通过解析globals并不知道图片由哪个Worksheet引用,引用信息(包含位置信息)存在于各个Worksheet的末尾,为了避免过度解析,默认只记录global里图片的起始位置,调用#listPictures方法时才会解析图片,调用Picture#getSheet()或者Picture#getDimension()时解析引用信息。

注意:本地临时路径在关闭ExcelReader后会自动清除,如果想要永久保存图片则需要将其复制到其它地方

读取单元格样式

EEC从v0.5.6开始支持读取单元格样式,Row对象提供getCellStyle方法获取单元格样式,此样式仅返回一个int值表示样式索引,如果要获得具体的样式, 你需要从Styles对象中调用具体的getFontgetFillgetNumFmtgetBordergetVerticalgetHorizontal来分别获取 字体,填充,格式化,边框,垂直对齐,水平对齐 6个样式

java
// 第一步 获取Styles对象
Styles styles = row.getStyles();

// 第二步 获取指定单元格样式
int style = row.getCellStyle(cell);

// 获取字体
Font font = styles.getFont(style);

// 获取边框
Border border = styles.getBorder(style);

// 获取填充 
Fill fill = styles.getFill(style);

// 获取格式化
NumFmt fmt = styles.getNumFmt(style);

// 水平对齐
String horizontal = Horizontals.of(styles.getHorizontal(style))

// 垂直对齐
String vertical = Verticals.of(styles.getVertical(style))

通过上面的方法你可以完整的复制一个excel

动态转换

导出数据时经常会将数据库一些状态值枚举值转为文本输出到Excel中,EEC提供了一个FunctionalInterface类ConversionProcessor,在创建Column时可以像这样 new Column("状态", "status", int.class, n -> ApplyStatusEnum.of((int) n).getDesc()将状态这一列的数字值转为状态文本值输出,在v0.5.12版本中又引入了Converter接口 你可以在ExcelColumn注解中使用它,与ConversionProcessor相比Converter是双向的他提供输出转换conversion和输入转换reversion

java
@ExcelColumn
private String name;
@ExcelColumn(converter = StatusConvert.class) // <- 指定状态码转换器
private int status;

// 转换器实现
public static class StatusConvert implements Converter<Integer> {
    final String[] statusDesc = { "未开始", "进行中", "完结", "中止" };

    /**
     * Excel读取的文本转为状态码
     * 
     * @param v Excel原始值
     * @param fieldClazz 导入对象中Converter标记的字段类型
     * @return 状态码
     */
    @Override
    public Integer reversion(String v, Class<?> fieldClazz) {
        for (int i = 0; i < statusDesc.length; i++) {
            if (statusDesc[i].equals(v)) {
                return i;
            }
        }
        return null;
    }

    /**
     * 状态码转为文本
     * 
     * @param v 原始值
     * @return 状态说明
     */
    @Override
    public Object conversion(Object v) {
        return v != null ? statusDesc[(int) v] : null;
    }
}

QA集

如何设置样式

样式设置放在表头Column对象上,使用以下setFontsetFillsetBordersetNumFmtsetVerticalsetHorizontalsetWrapText7个方法设置字体,填充,边框,格式化,垂直对齐,水平对齐和自动折行 7个样式, 由于EEC包含边框、字体和水平对齐3个打底样式,要去除这些打底样式则需要设置新的样式来替换,边框可以使用new Border()空边框来清除

java
new Workbook()
.setAutoSize(true) // <- 自适应列宽
.addSheet(new ListSheet<>(randomTestData()
                          , new Column("整型", "nv").setNumFmt("#,##0_);[Red]-#,##0_);0_)").setFont(new Font("Bauhaus 93", 16))
                          , new Column("字符串(EN)", "sen").setFont(new Font("Trebuchet MS", 20))
                          , new Column("字符串(中文)", "scn").setFont(new Font("微软雅黑", 8))
                          , new Column("日期", "iv").setNumFmt("yyyy-mm-dd hh:mm:ss").setFont(new Font("华文行楷", 14))
                         )).writeTo(Paths.get("F:/excel/1.xlsx"));

20251206233415532d1cf13.png2025120623341519299c558.jpeg

如何忽略表头

Sheet#ignoreHeader可忽略表头

java
new Workbook()
.addSheet(new EmptySheet().ignoreHeader()) // <- 忽略表头
.writeTo(Paths.get("F:/excel/1.xlsx"));

如何进行数据转换

简单转换可以使用ConversionProcessor,它仅有一个入参和出参作用于Column列

如下代码展示将成绩小于60分的转换为"不合格"

java
new Workbook()
.addSheet(new ListSheet<>(
    new Column("学号", "id"),
    new Column("姓名", "name"),
    new Column("成绩", "score", n -> (int) n < 60 ? "不合格" : n)
)).writeTo(Paths.get("F:/excel/1.xlsx"));

ConversionProcessor只支持输出转换,如果需要输入转换的话则需要使用Converter接口,它具有两个方法:一个为conversion输出转换,一个为reversion输入转换

下面代码展示将“status”转为状态文本,导入时将状态文本转换'status'值

java
public class Item {
    // 设置转换器
    @ExcelColumn(converter = StatusConvert.class)
    private int status;
}

public class StatusConvert implements Converter<Integer> {
    final String[] statusDesc = { "未开始", "进行中", "完结", "中止" };

    @Override
    public Integer reversion(String v, Class<?> filedClazz) {
        for (int i = 0; i < statusDesc.length; i++) {
            if (statusDesc[i].equals(v)) {
                return i;
            }
        }
        return null;
    }

    @Override
    public Object conversion(Object v) {
        return v != null ? statusDesc[(int) v] : null;
    }
}

如何设置斑马线

斑马线有利于阅读,EEC使用XMLZebraLineCellValueAndStyle添加斑马线,除表头外每隔一行设置一个填充色做为斑马线样式

如下示例展示设置橙色斑马线

java
new Workbook()
.addSheet(new ListSheet<>(Item.randomTestData())
          .setCellValueAndStyle(new XMLZebraLineCellValueAndStyle(new Fill(PatternType.solid, Color.orange))))
.writeTo(Paths.get("F:/excel/斑马线.xlsx"));

如何设置自适应列宽

EEC支持工作簿、工作表和指定列三个维度设置自适应列宽,它们的关键词都是AutoSize

java
new Workbook()
.setAutoSize(true)   // <- 作用于工作薄,所有工作表都自适应列宽
.addSheet(new EmptySheet())
.addSheet(new EmptySheet())
.writeTo(Paths.get("F:/excel/1.xlsx"));

new Workbook()
.addSheet(new EmptySheet().autoSize()) // <- 作用于工作表
.writeTo(Paths.get("F:/excel/1.xlsx"));

new Workbook()
.addSheet(new ListSheet<>(
    new Column("学号", "id"),
    new Column("姓名", "name").autoSize(), // <- 作用某一列
    new Column("成绩", "score"))
         ).writeTo(Paths.get("F:/excel/1.xlsx"));

如何设置缩放

缩放是通过扩展参数设置,对应Key为Const.ExtendPropertyKey.ZOOM_SCALE,范围10-400对应缩放比例10%到400%

java
new Workbook()
.addSheet(new EmptySheet().putExtProp(Const.ExtendPropertyKey.ZOOM_SCALE, 70)) // <- 设置70%缩放
.writeTo(Paths.get("F:/excel/1.xlsx"));

202512062334158ed625581.jpeg

扩展参数说明

由于程序越写越复杂,工作表Worksheet新添加功能都需要定义新的属性,为了限制无限增加的属性所以将这些属性放到扩展参数中,扩展参数由一个Map组成,使用putExtProp设置属性getExtPropValue获取扩展属性

当前已支持扩展属性有

属性用途类型
FREEZE冻结窗格Dimension
STYLE_DESIGN运态样式StyleProcessor
MERGE_CELLS合并单元格List
AUTO_FILTER筛选Dimension
DATA_VALIDATION数据验证List
ZOOM_SCALE缩放Integer

可能出现的几种异常

  • java.lang.NoSuchMethodError: org.dom4j.io.SAXReader.createDefault()Lorg/dom4j/io/SAXReader; 这个异常是因为dom4j版本不一致,EEC使用的是org.dom4j:dom4j:2.1.3,如果项目中已引入dom4j则需要排除已有的低版本dom4j,低版本dom4j存在XXE安全漏洞不建议使用

报表类导出样式示例

得益于EEC的扩展性,处理报表类样式可以轻松实现,下面展示如何简单制作报表

分组斑马线

首先我们定义一个Group接口,用于指定分组字段

java
public interface Group {
    String groupBy();
}

然后再定义一个StyleProcessor用于处理分组斑马线样式

java
public static class GroupStyleProcessor<U extends Group> implements StyleProcessor<U> {
    private String group;
    private int s, o;
    @Override
    public int build(U u, int style, Styles sst) {
        if (group == null) {
            group = u.groupBy();
            s = sst.addFill(new Fill(PatternType.solid, new Color(239, 245, 235)));
            return style;
        }
        // 根据Group的值添加斑马线
        if (u.groupBy() != null && !group.equals(u.groupBy())) {
            group = u.groupBy();
            o ^= 1;
        }
        return o == 1 ? Styles.clearFill(style) | s : style;
    }
}

导出时使用GroupStyleProcessor按订单号分组的斑马线

java
new Workbook().setAutoSize(true)
.addSheet(new ListSheet<>(testData()).setStyleProcessor(new GroupStyleProcessor<>()))
.writeTo(Paths.get("F:/excel"));

public class OrderDetail implements Group {
    。。。其它字段

    @Override
    public String groupBy() {
        return orderNo;
    }
}

只需要这两步我们就可以得到如下样式,根据订单号分组斑马线,这个效果可以非常明显区分不同订单的商品

2025120623341560cd0d60b.jpeg

分组合并

上面的样式虽然区分了不同的订单,有利于导入到其它系统,但为了更能体现每日的订单我们还需要将日期进行分组,学习更多单元格合并功能请点击这里 ,好吧!接着改造>>>

我们为每个订单添加一个小计,用于订单内商品数量和价格合计,然后每个订单内"日期“、“客户”和“关联订单”两列做合并

java
// 用于保存合并单元格
List<Dimension> mergeCells = new ArrayList<>();
String date = null, order = null;
int row = 2, dateFrom = row, orderFrom = row; // 记录订单/日期的起始位置
E summary = null, allSummary = createSummary();
for (int i = 0, size = list.size(); i < size; ) {
    E e = list.get(i);
    if (!e.orderNo.equals(order)) {
        if (order != null) {
            list.add(i++, summary);
            size++;
            // 合并客户名和订单号
            mergeCells.add(new Dimension(orderFrom, (short) 2, row, (short) 2));
            mergeCells.add(new Dimension(orderFrom, (short) 10, row, (short) 10));
            // 合并小计
            mergeCells.add(new Dimension(row, (short) 3, row, (short) 5));
            row++;
        }
        summary = createSummary();
        summary.orderNo = e.orderNo;
        summary.date = e.date;

        order = e.orderNo;
        orderFrom = row;
    } else {
        e.orderNo = null;
        e.customer = null;
    }
    if (!e.date.equals(date)) {
        if (date != null) {
            // 合并日期
            mergeCells.add(new Dimension(dateFrom, (short) 1, row - 1, (short) 1));
        }
        dateFrom = row;
        date = e.date;
    } else e.date = null;

    // 累计
    summary.num += e.num;
    summary.totalAmount = summary.totalAmount.add(e.totalAmount);

    allSummary.num += e.num;
    allSummary.totalAmount = allSummary.totalAmount.add(e.totalAmount);

    i++;
    row++;
}
// 添加最后一个订单小计以及合计数据
list.add(summary);
mergeCells.add(new Dimension(dateFrom, (short) 1, row, (short) 1));
mergeCells.add(new Dimension(orderFrom, (short) 2, row, (short) 2));
mergeCells.add(new Dimension(orderFrom, (short) 10, row, (short) 10));
mergeCells.add(new Dimension(row, (short) 3, row, (short) 5));

allSummary.date = "总计:"; allSummary.productName = null; allSummary.orderNo = "--";
list.add(allSummary);
row++;
mergeCells.add(new Dimension(row, (short) 1, row, (short) 5));

上面的代码并没有什么逻辑,一是判断订单不同时追加一行小计,二是添加日期,客户和订单三列的合并。

有了上面的合并单元格收集后我们就可以添加到扩展参数中了

java
new Workbook().cancelOddFill().setAutoSize(true)
.addSheet(new ListSheet<>(testData())
          .putExtProp(Const.ExtendPropertyKey.MERGE_CELLS, mergeCells)).writeTo(Paths.get("F:/excel"));

现在的效果如下:

202512062334159fd54ce46.jpeg

看上去还行,有合并和小计数据了,但是斑马线好像不太友好的样子,为了美观下一步我们去掉第一列的斑马线颜色,并将小计字体加粗处理。

为了标记小计,我们增加一个接口,定义如下

java
public interface Summary {
    default boolean isSummary() {
        return false;
    }
}

普通行isSummary返回false,小计行返回true

然后再实现小计的样式

java
public static class GroupStyleProcessor2<U extends Group & Summary> implements StyleProcessor<U> {
    private String group;
    private int s, o, i;
    @Override
    public int build(U u, int style, Styles sst) {
        if (group == null) {
            group = u.groupBy();
            s = sst.addFill(new Fill(PatternType.solid, new Color(239, 245, 235)));
            return style;
        }
        // 小计加粗字体
        if (u.isSummary()) {
            Font font = sst.getFont(style).clone();
            font.bold();
            style = Styles.clearFont(style) | sst.addFont(font);
        }
        else if (u.groupBy() != null && !group.equals(u.groupBy())) {
            group = u.groupBy();
            o ^= 1;
            i = 0;
        }
        return o == 1 && ++i > 1 ? Styles.clearFill(style) | s : style;
    }
}

现在它的效果是这样

20251206233415be157c136.jpeg

现在一个漂亮的报表已经呈现,没有模板似乎也很轻松。

EEC与E3 support兼容性对照表

eec支持xlsx格式读取/写入,eec-e3-support支持xls格式读取,后者依赖前者,但是两个工具经常不在一起发版,版本可能存在不兼容的情况。

下面列出两者相互兼容的映射表

eec更新说明eec-e3-support
0.5.202024-11-13 - 新增SimpleSheet简单工作表,简化导出的数据格式 - CSVSheetWriter新增分隔符delimiter属性 - 提升OpenJDK8-21的兼容性0.5.19
0.5.192024-09-22 - 支持增加自定义属性 - 支持设置“只读”标识,设置只读后打开Excel后无法编辑 - 删除部分已标记为过时的方法
0.5.182024-08-13 - 增加CSVSheet的兼容性, Excel转CSV支持保存BOM - 增加ResultSetSheet的类型兼容性 - ListMapSheet支持泛型 - 删除I18N相关代码降低复杂度 - 精简BloomFilter降低复杂度,精简后仅支持String类型0.5.15
0.5.172024-07-18 - 修复部分情况下Row#toMap抛下标越界问题(#380)
0.5.162024-06-29 - 输入转换Converter#reversion增加数据类型提升扩展性(#376), 兼容问题参考 - 修复读取自定义theme颜色会出现偏差的问题
0.5.152024-05-21 - 修复onProgress出现越界问题 - 修复data-supplier计算offset出现偏差使得导出数据缺失的问题 - 删除部分已标记为过时的方法
0.5.142024-04-22 - 新增数据验证Validation - 新增超链接注解Hyperlink - 新增模板工作表TemplateSheet - 新增TypeCastException用于Row转对象时如果出现类型转换异常时携带行列等信息 - ListSheet新增data-supplier减化分片开发难度 - 新增zoomScale扩展属性支持设置工作表缩放比例 - 修复读取双色填充样式时抛异常0.5.14
0.5.132024-02-20 - logback安全更新 - 新增全属性工作表FullSheet以读取更多属性,它集合了MergeSheet和CalcSheet的功能 - 新增扩展属性AutoFilter用于添加列筛选功能 - 修复继承自ListSheet的工作表初始无法获取对象类型导致单元格空白的问题 - 修复部分场景下边框颜色无法设置的问题 - 修复部分Excel的indexed颜色与标准有所不同导致获取颜色不正确的问题 - 修复部分场景读取Excel发生IndexOutOfBound异常 - 修复HeaderStyle注解设置样式时,字段样式被全局样式替换的问题0.5.13
0.5.122023-11-26 - 移除watch改用slf4j输出日志 - 新增进度窗口onProgress - 优化自适应列宽算法使其支持更多字体和大小 - 数据转换器功能增强,ExcelColumn增加converter属性以支持导出/导入时双向数据转换(#362) - 支持读取xlsx格式wps的内嵌图片(#363) - 部分类的注释改为中文,后续会将全部注释改为中文0.5.12
0.5.112023-10-08 - 优化ExcelReader性能 - 增加setHeaderColumnReadOption方法提高ExcelReader丰富性 - 修复读取16进制转义字符时出现乱码问题 - 修复非法UTF8字符导致写文件异常 - 无数据且能获取表头信息时正常写表头(#361) - 屏蔽JDK17以上版本使用ExcelReader抛异常的问题0.5.11
0.5.102023-08-20 - 修复单元格长度过长导致内容错位的异常(#354) - 支持导出图片0.5.10
0.5.92023-05-10 - 修复dom4j默认构造器容易造成XXE安全漏洞 - v0.5.x 升级到 v0.5.9 - v0.4.x 升级到 v0.4.150.5.8
0.5.82023-04-08 - 删除部分已标记为过时的方法和类,兼容处理请查看[wiki升级指引] - 重命名xxOddFill为xxZebraLine - 修复自动分页后打开文件弹出警告 - 取消默认斑马线,增加XMLZebraLineCellValueAndStyle自定义斑马线 - 表头背景从666699调整为E9EAEC,斑马线颜色从EFF5EB调整为E9EAEC - 单个Column可以指定auto-size属性(#337) - 提供入口自定义处理未知的数据类型 - 导出数据支持指定起始行号(#345) - 修复xls解析RK Value丢失精度问题 - 修复部分已知BUG(#334, #342, #346)
0.5.72023-02-17 - 修复读取font-size时因为浮点数造成异常 - 修复auto-size重置列宽时抛Buffer异常 - 新增 #setRowHeight, #setHeaderRowHeight 方法设置行高0.5.6
0.5.62023-01-07 - 读取文件时支持指定表头,对于多行表头尤为有效 - 提供Row#toMap方法将行数据转为LinkedHashMap(#294) - 提供Row#isBlank方法用于判断所有单元格的值是否为空(#314) - 读取文件转时支持自定义HeaderRow - 读文件时支持获取单元格样式 - 修复部分BUG(#308, #320, #323)
0.5.52022-11-07 - Row转对象时如果出异常将提示具体的行和列信息(#284) - 导出结束后删除zip包(#296) - 修复部分BUG(#297,#298)0.5.4
0.5.42022-08-28 - 支持显示/隐藏网络线 - 支持显示/隐藏指定列 - 字体增加"删除线"样式 - Comment增加width和height两属性,用于调整批注大小 - BIFF8Sheet支持reset重置流用于反复读取 - 修复部分BUG(#282,#285)
0.5.32022-07-25 - 修复导出时日期少6天的问题(#269) - 支持多个ExcelColumn注解,可以实现多行表头(#210) - 微调表格样式使其更突出内容 - 优化自动计算列宽的算法使其更精准 - 修复部分BUG(#264,#265)0.5.0
0.5.22022-07-16 - (严重)修复单元格字节超过1k时导致SST索引读取死循环问题(#258) - StatementSheet&ResultSetSheet添加StyleProcessor 实现整行样式调整(#235) - 修复部分BUG(#257, #260)
0.5.12022-07-10 - 提升对非标准Office OpenXML生成的excel读取兼容性(#245, #247) - 提升读取Excel时Row转Java对象的兼容性(#254) - 修复部分BUG(#249, #252)
0.5.02022-05-22 - 增加StyleDesign用于样式处理(单元格或者整行样式处理) - 增加FreezePanes用于冻结网格 - 修改部分BUG(#227,#232,#238,#243) - 读取文件支持自定义注解转对象(#237)
0.4.142021-12-19 - 提高对Numbers转xlsx的兼容性 - 值转换从原来的int类型扩大为Object - 增加@RowNum注解,用于注入行号 - 修改ListSheet.EntryColumn的访问权限,方便实现更多高级特性 - 支持单列数字无表头导出,现在可以简单的导出List数据 - 修复已知BUG(#197,#202,#205,#219) - 将com.google.common包重命名为 org.ttzero.excel.common解决内嵌引起的包冲突(#200)0.4.13
0.4.132021-08-09 - 支持xls获取图片 - @ExcelColumn注解增加colIndex属性,用于指定列顺序(#188) - 读取文件时Worksheet#getIndex()返回Sheet在文件中的下标而非id(#193) - 修复部分BUG(#182,#190)
0.4.12.12021-05-20 - Hotfix:HeaderStyle注解设置某列cell颜色会影响所有表头样式0.4.11
0.4.122021-05-18 - 增加获取图片功能(#168) - 支持row()方法转对象(#175) - 读取文件默认使用包装类而非基本类型,为了方便处理Null类型(#177) - 增加@HeaderStyle注解自定义头部样式
0.4.112021-03-28 - 修复导出时删除特殊字符的问题 - 增加wrapText属性控制单元格自动换行 - 增加forceExport属性来强制没有@ExcelColumn注解的属性 - 兼容非标准化BOF记录解析 - 优化short-sector解析 - 极大提升读取xls兼容性 - 增加对EXTSST的解析
0.4.102021-01-07 - 增加兼容性(Office for Mac) - 修复部分BUG(#147,#148,#159,#161)0.4.10
0.4.92020-11-15 - 修复读取文件时的BUG(#146) - 增加读取高版本Office导出的xls文件格式的兼容性0.4.9
0.4.82020-10-09 - ExcelColumn注解增加format属性来支持自定义单元格格式化 - 为减少数据泄露风险,现在对象属性必须明确指定 ExcelColumn注解才会被导出0.4.6
0.4.72020-08-14 - 安全更新,修复dom4j小于2.1.3版本可能启用XXE攻击。 - ExcelColumn注解增加comment属性,允许在Excel列头添加“批注”功能 - 修复一些已知BUG
0.4.62020-04-20 - 优化SharedStringTable - 支持读取Excel97~2003文件(需要依懒eec-e3-support) - 修复一些已知BUG

更新: 2024-12-31 20:31:15
原文: https://www.yuque.com/tulingzhouyu/db22bv/gghp2hsgd58g071n