EasyExcel--基础--02--常用API及注解

已于 2024-11-20 11:29:13 修改
阅读量2.9k 收藏 6
点赞数 2
分类专栏： EasyExcel 文章标签： excel
于 2023-04-26 14:42:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhou920786312/article/details/130385793
版权

EasyExcel–基础–02–常用API及注解

1、常用类

  • EasyExcel 入口类，用于构建开始各种操作；
  • ExcelReaderBuilder 构建出一个ReadWorkbook对象，即一个工作簿对象，对应的是一个Excel文件；
  • ExcelWriterBuilder 构建出一个WriteWorkbook对象，即一个工作簿对象，对应的是一个Excel文件；
  • ExcelReaderSheetBuilder 构建出一个ReadSheet对象，即一个工作表的对象，对应的Excel中的每个sheet，一个工作簿可以有多个工作表；
  • ExcelWriterSheetBuilder 构建出一WriteSheet对象，即一个工作表的对象，对应的Excel中的每个sheet，一个工作簿可以有多个工作表；
  • ReadListener 在每一行读取完毕后都会调用ReadListener来处理数据
  • WriteHandler 在每一个操作包括创建单元格、创建表格等都会调用WriteHandler来处理数据，对使用者透明不可见；
  • 所有配置都是继承的 Workbook的配置会被Sheet继承。所以在用EasyExcel设置参数的时候，在EasyExcel…sheet()方法之前作用域是整个sheet，之后针对单个sheet。

2、读取时的注解

2.1、@ExcelProperty

使用位置

标准作用在成员变量上

可选属性

属性名含义说明
index对应Excel表中的列数默认-1，建议指定时从0开始
value对应Excel表中的列头
converter成员变量转换器自定义转换器需要实Converter接口

使用效果

index属性可以指定当前字段对应excel中的哪一列，可以根据列名value去匹配，也可以不写。

如果不使用@ExcelProperty注解，成员变量从上到下的顺序，对应表格中从左到右的顺序；

使用建议

要么全部不写，要么全部用index，要么全部用名字去匹配，尽量不要三个混着用。

2.2、@ExcelIgnore

标注在成员变量上，默认所有字段都会和excel去匹配，加了这个注解会忽略该字段

2.3、@DateTimeFormat

标注在成员变量上，日期转换，代码中用String类型的成员变量去接收excel中日期格式的数据会调用这个注解。里面的value参照java.text.SimpleDateFormat

2.4、@NumberFormat

标注在成员变量上，数字转换，代码中用String类型的成员变量去接收excel数字格式的数据会调用这个注解。里面的value参照java.text.DecimalFormat

2.5、@ExcelIgnoreUnannotated

标注在类上。

不标注该注解时，默认类中所有成员变量都会参与读写，无论是否在成员变量上加了@ExcelProperty 的注解。

标注该注解后，类中的成员变量如果没有标注@ExcelProperty 注解将不会参与读写。

3、 读取时通用参数

ReadWorkbook,ReadSheet 都会有的参数，如果为空，默认使用上级。

  • converter 转换器，默认加载了很多转换器。也可以自定义。

  • readListener 监听器，在读取数据的过程中会不断的调用监听器。

  • headRowNumber 指定需要读表格的 列头行数。默认有一行头，也就是认为第二行开始起为数据。

  • head 与clazz二选一。读取文件头对应的列表，会根据列表匹配数据。建议使用clas，就是文件中每一行数据对应的代码中的实体类型。

  • clazz 与head二选一。读取文件的头对应的class，也可以使用注解。如果两个都不指定，则会读取全部数据。

  • autoTrim 字符串、表头等数据自动trim

  • password 读的时候是否需要使用密码

4、ReadWorkbook(工作簿对象)参数

  • excelType 当前excel的类型，读取时会自动判断，无需设置。
  • inputStream 与file二选一。建议使用file。
  • file 与inputStream二选一。读取文件的文件。
  • autoCloseStream 自动关闭流。
  • readCache 默认小于5M用 内存，超过5M会使用 EhCache，不建议使用这个参数。
  • useDefaultListener @since 2.1.4 默认会加入ModelBuildEventListener 来帮忙转换成传入class的对象，设置成false后将不会协助转换对象，自定义的监听器会接收到Map<Integer,CellData>对象，如果还想继续接听到class对象，请调用readListener方法，加入自定义的beforeListener、 ModelBuildEventListener、 自定义的afterListener即可。

5、ReadSheet(工作表对象)参数

  • sheetNo 需要读取Sheet的编号，建议使用这个来指定读取哪个Sheet
  • sheetName 根据名字去匹配Sheet，excel 2003不支持根据名字去匹配

6、写入时的注解注解

6.1、@ExcelProperty

使用位置：标准作用在成员变量上

可选属性：

属性名含义说明
index对应Excel表中的列数默认-1，指定时建议从0开始
value对应Excel表中的列头
converter成员变量转换器自定义转换器需要实Converter接口

使用效果：index 指定写到第几列，如果不指定则根据成员变量位置排序；

​ value指定写入的列头，如果不指定则使用成员变量的名字作为列头；

​ 如果要设置复杂的头，可以为value指定多个值。

6.2、其他注解：

基本和读取时一致

  • @ContentRowHeight() 标注在类上或属性上，指定内容行高

  • @HeadRowHeight() 标注在类上或属性上，指定列头行高

  • @ColumnWidth() 标注在类上或属性上，指定列宽

  • ExcelIgnore` 默认所有字段都会写入excel，这个注解会忽略这个字段

  • DateTimeFormat 日期转换，将Date写到excel会调用这个注解。里面的value参照java.text.SimpleDateFormat

  • NumberFormat 数字转换，用Number写excel会调用这个注解。里面的value参照java.text.DecimalFormat

  • ExcelIgnoreUnannotated 默认不加 ExcelProperty 的注解的都会参与读写，加了不会参与

7、写入时通用参数

WriteWorkbook、WriteSheet都会有的参数，如果为空，默认使用上级。

  • converter 转换器，默认加载了很多转换器。也可以自定义。

  • writeHandler 写的处理器。可以实现WorkbookWriteHandler,SheetWriteHandler,RowWriteHandler,CellWriteHandler，在写入excel的不同阶段会调用，对使用者透明不可见。

  • relativeHeadRowIndex 距离多少行后开始。也就是开头空几行

  • needHead 是否导出头

  • head 与clazz二选一。写入文件的头列表，建议使用class。

  • clazz 与head二选一。写入文件的头对应的class，也可以使用注解。

  • autoTrim 字符串、表头等数据自动trim

8、WriteWorkbook(工作簿对象)参数

  • excelType 当前excel的类型，默认为xlsx

  • outputStream 与file二选一。写入文件的流

  • file 与outputStream二选一。写入的文件

  • templateInputStream 模板的文件流

  • templateFile 模板文件

  • autoCloseStream 自动关闭流。

  • password 写的时候是否需要使用密码

  • useDefaultStyle 写的时候是否是使用默认头

9、WriteSheet(工作表对象)参数

  • sheetNo 需要写入的编号。默认0

  • sheetName 需要些的Sheet名称，默认同sheetNo

Easyexcel（1-注解使用）
peng_gx的博客
11-18 1622
Easyexcel常用注解使用
Spring Boot 项目优雅实现 Excel 导入与导出功能
Trouvailless的博客
06-15 879
Excel 导入与导出是项目中经常用到的功能，在 Java 中常用 poi 实现 Excel 的导入与导出。由于 poi 占用内存较大，在高并发下很容易发生 OOM 或者频繁 fullgc，阿里基于 poi 开源了 EasyExcel 项目。
二、快速入门EasyExcel
付之一笑的专栏
11-23 2258
一、快速入门–QuickStart 1.1、新建工程、导入依赖 <!-- EasyExcel --> <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.1.6</version> </dependency> <!-- lombok 优雅编程
SpringBoot3+EasyExcel通过WriteHandler动态实现表头重命名
最新发布
★【World Of Moshow 郑锴】★
03-31 727
为了通过 EasyExcel 实现动态表头重命名，可以封装一个方法，传入动态的新表头名称列表（List<String>），并结合 WriteHandler 接口来重命名表头。同时，通过 EasyExcel 将数据直接写入到输出流。
EasyExcel注解使用
weixin_40017062的博客
12-05 3310
EasyExcel注解使用
easyexcel常见注解
拒绝熬夜啊的博客
05-17 1万+
easyexcel常见注解
EasyExcel常用注解
Mico_Cmx的博客
02-17 3015
easyExcel开发常用注解
easyexcel中的常用注解
热门推荐
weixin_45151960的博客
10-15 3万+
@ExcelProperty @ColumnWith 列宽 @ContentFontStyle 文本字体样式 @ContentLoopMerge 文本合并 @ContentRowHeight 文本行高度 @ContentStyle 文本样式 @HeadFontStyle 标题字体样式 @HeadRowHeight 标题高度 @HeadStyle 标题样式 @ExcelIgnore 忽略项 @ExcelIgnoreUnannotated 忽略未注解 字段注解 类注解 @ColumnWith(列
easyexcel-utils:EasyExcel简单封装，通过修改原始码增加更多的型号注解支持-修改
03-24
关于easyexcel，其主要目的是为了降低读取excel时的内存消耗，简化读写excel的api 。 同时2.x版本提供了很多新功能，具体大家可以直接参考官方说明吧，github文档上写一清二楚，这里就不传播一些没啥必要的二三手...
easyexcel-master.zip
07-06
3. 易用：提供了丰富的API和注解，使得Excel的读写操作变得简单直观，开发者无需深入了解Excel的底层格式，就能快速上手。 二、工作原理 EasyExcel采用了流式处理的方式，一次读取一行或写入一行，减少内存占用。...
案例实战-SpringBoot整合EasyExcel实现列表导出功能
06-03
EasyExcel是一个轻量级的Java处理Excel工具，它提供了简单易用的API，可以高效地读写Excel文件，尤其适合大数据量的场景。 首先，SpringBoot是基于Spring框架的快速开发工具，它简化了配置，集成了大量的常用功能，...
easyexcel-3.0.5-API文档-中文版.zip
05-09
赠送jar包：easyexcel-3.0.5.jar； 赠送原API文档：easyexcel-3.0.5-javadoc.jar； 赠送源代码：easyexcel-3.0.5-sources.jar； 赠送Maven依赖信息文件：easyexcel-3.0.5.pom； 包含翻译后的API文档：easyexcel-3.0.5-javadoc-API文档-中文(简体)版.zip； Maven坐标：com.alibaba:easyexcel:3.0.5； 标签：alibaba、easyexcel、jar包、java、中文文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
easyexcel-3.0.5-API文档-中英对照版.zip
05-04
赠送jar包：easyexcel-3.0.5.jar； 赠送原API文档：easyexcel-3.0.5-javadoc.jar； 赠送源代码：easyexcel-3.0.5-sources.jar； 赠送Maven依赖信息文件：easyexcel-3.0.5.pom； 包含翻译后的API文档：easyexcel-3.0.5-javadoc-API文档-中文(简体)-英语-对照版.zip； Maven坐标：com.alibaba:easyexcel:3.0.5； 标签：alibaba、easyexcel、jar包、java、中英对照文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。 双语对照，边学技术、边学英语。
尚医通项目57-65：数据字典的配置与应用
qq_43568982的博客
05-20 952
开始时间：2022-05-17 课程链接：【尚医通】 开发数据字典 把常用的诸如省份信息这种数据，开发成一个固定的数据字典 后端开发 先设计表 再添加数据 搭建service-cmn模块，和之前搭建service-hosp差不多 因为我们的service-cmn是service的儿子，所以pom文件只需要依赖到service就行，写的内容不多 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apac
easyExcel注解详情
java程序员的蜕变之路
11-20 2580
设置背景色设置字体颜色设置边框，换行，内容位置。
EasyExcel注解大全
y449739776的博客
03-31 1万+
@ExcelProperty 这是最常用的一个注解，注解中有三个参数value,index,converter分别代表列明，列序号，数据转换方式，value和index只能二选一，通常不用设置converter 最佳实践 public class ImeiEncrypt { @ExcelProperty(value = "imei") private String imei; } @ColumnWith 用于设置列宽度的注解,注解中只有一个参数value，value的单位是字符
EasyExcel - API
m0_51262652的博客
03-25 4126
使用时一般时配合SpringBoot项目 该文参照博客地址 原创地址 一般 用 maven 去引入EasyExcel的依赖 在 maven 仓库搜索 EasyExcel 选择喜欢(最新)的版本,复制到pom.xml 刷新 maven即可! 这里是 maven仓库地址 常用注解: @ExcelProperty : 指定当前字段对应excel的那一列.可以根据名字或者下标去匹配(下标从0开始),不写的默认按照顺序匹配; value 字段对应excel 的第一列的名称
easyExcel中的注解
一起coding，一起嗨。
04-07 1万+
@ExcelProperty 这是最常用的一个注解，注解中有三个参数value,index,converter分别代表列明，列序号，数据转换方式，value和index只能二选一，通常不用设置converter 最佳实践 public class ImeiEncrypt { @ExcelProperty(value = "imei") private String imei; } 复制代码 @ColumnWith 用于设置列宽度的注解,注解中只有一个参数value，value的单
一、 EasyExcel 实体类注解 - 数据的导入/导出
weixin_37766721的博客
03-06 1949
EasyExcel 模板导出/数据导入
easyexcel校验字段
08-18
### 回答1： EasyExcel 是一个 Java 的读写 Excel 文件的开源库，它可以方便地实现 Excel 文件的读取、写入和操作。在 EasyExcel 中，校验字段可以通过添加注解来实现。 具体步骤如下： 1. 在需要校验的字段上添加注解 `@ExcelProperty`，并设置 `index` 属性表示该字段在 Excel 文件中的列位置。 ```java public class User { @ExcelProperty(index = 0) @NotBlank(message = "姓名不能为空") private String name; @ExcelProperty(index = 1) @Pattern(regexp = "^\\d{11}$", message = "手机号格式不正确") private String phone; // 其他字段... } ``` 2. 在读取 Excel 文件时，使用 `EasyExcel.read()` 方法并传入一个 `AnalysisEventListener` 的实现类，重写 `onData()` 方法进行校验。 ```java public class UserExcelListener extends AnalysisEventListener<User> { private List<User> userList = new ArrayList<>(); @Override public void invoke(User user, AnalysisContext context) { // 数据校验 Set<ConstraintViolation<User>> violations = ValidatorUtil.validate(user); if (!violations.isEmpty()) { // 校验未通过，抛出异常 throw new RuntimeException(violations.iterator().next().getMessage()); } // 校验通过，加入列表 userList.add(user); } @Override public void doAfterAllAnalysed(AnalysisContext context) { // 处理数据... } } ``` 在 `invoke()` 方法中，我们使用 `ValidatorUtil` 工具类对读取到的每一条数据进行校验。如果校验不通过，直接抛出异常，否则将数据加入列表。 需要注意的是，`ValidatorUtil` 是一个自定义的校验工具类，它使用了 JSR-303 标准中的注解进行校验。在使用之前需要先引入相关依赖和配置校验器。 ```xml <!-- 引入 Hibernate Validator 校验器 --> <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.1.7.Final</version> </dependency> <!-- 配置校验器 --> <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"/> ``` 以上就是使用 EasyExcel 实现校验字段的步骤，希望对你有所帮助。 ### 回答2： EasyExcel 是一款方便易用的操作 Excel 文件的工具库，可以实现对 Excel 文件的读写操作。在 EasyExcel 中，校验字段是通过注解和校验器来实现的。 首先，在实体类的属性上添加校验注解，例如 @NotNull 表示非空校验，@Max 表示最大值校验等等。这些注解可以根据具体需求进行选择和组合使用。 同时，根据需要，我们还可以自定义一些校验器来对字段进行额外的校验。自定义校验器需要实现 Validator 接口，并实现其中的 validate 方法，在该方法中编写具体的校验逻辑。 接下来，在读取或写入 Excel 文件时，使用 EasyExcel 提供的相关方法进行校验操作。在读取操作中，可以通过调用 ReadListener 的 onException 方法来获取校验不通过的数据和原因，并进行相应的处理。在写入操作中，可以在写入数据前进行校验，并将校验不通过的数据进行处理或记录。 总结来说，EasyExcel 校验字段的步骤如下： 1. 在实体类的属性上添加校验注解，标示字段的校验规则。 2. 可选：根据需要，自定义校验器对字段进行额外的校验。 3. 在读取或写入 Excel 文件时，使用 EasyExcel 提供的相关方法进行校验操作。 4. 根据校验结果进行相应的处理，如记录错误信息、筛选出不合规的数据等。 使用 EasyExcel 校验字段可以有效地保证数据的准确性和一致性，提高数据处理的效率和可靠性。同时，EasyExcel 提供了丰富的校验注解和灵活的扩展机制，方便根据实际需求进行定制化的校验规则。 ### 回答3： EasyExcel是一款开源的Java操作Excel的工具库，提供了丰富的API和功能，可以方便地进行Excel文件的读写操作。其中一项常用的功能是校验Excel文件中的字段。 EasyExcel的校验字段功能可以帮助用户在读取Excel文件时进行自定义的字段校验。具体使用步骤如下： 首先，用户需要定义一个校验的规则，并将其封装成一个校验器。校验规则可以包括字段的数据类型、长度、范围等，校验器需要实现EasyExcel的接口 "AbstractValidateResultCodeListener"。 其次，在读取Excel文件时，使用EasyExcel提供的 "ExcelReaderBuilder" 创建一个读取器，并将校验器传入该读取器中。 然后，使用读取器读取Excel文件，读取过程中，EasyExcel会根据校验规则对每个字段进行校验。 最后，根据校验结果进行相应的处理。EasyExcel读取Excel文件时，会将校验失败的数据进行记录，用户可以通过校验结果对象获取到校验失败的数据以及失败的原因，并进行后续操作，如打印出错误信息、记录日志等。 总之，EasyExcel提供了易于使用的校验字段功能，通过自定义校验规则，可以方便地对Excel文件中的字段进行校验，并获取校验结果，从而使数据处理更加准确和可靠。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值