《SpringBoot篇》22.EasyExcel常用API与注解

简介: 《SpringBoot篇》22.EasyExcel常用API与注解

1、常用类


EasyExcel 入口类,用于构建开始各种操作;

ExcelReaderBuilder 构建出一个ReadWorkbook对象,即一个工作簿对象,对应的是一个Excel文件;

ExcelWriterBuilder 构建出一个WriteWorkbook对象,即一个工作簿对象,对应的是一个Excel文件;

ExcelReaderSheetBuilder 构建出一个ReadSheet对象,即一个工作表的对象,对应的Excel中的每个sheet,一个工作簿可以有多个工作表;

ExcelWriterSheetBuilder 构建出一WriteSheet对象,即一个工作表的对象,对应的Excel中的每个sheet,一个工作簿可以有多个工作表;

ReadListener 在每一行读取完毕后都会调用ReadListener来处理数据,我们可以把调用service的代码可以写在其invoke方法内部;

WriteHandler 在每一个操作包括创建单元格、创建表格等都会调用WriteHandler来处理数据,对使用者透明不可见;

所有配置都是继承的 Workbook的配置会被Sheet继承。所以在用EasyExcel设置参数的时候,在EasyExcel…sheet()方法之前作用域是整个sheet,之后针对单个sheet。

2、读取时的注解


@ExcelProperty

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


可选属性:

image.png

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


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


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


代码演示:


// 1. 修改成员变量顺序读取Excel表格
// 2. 修改index属性值读取Excel表格
// 3. 修改value属性值读取Excel表格
@ExcelProperty(value = "学生姓名",index = 3)
private String name;

@ExcelIgnore

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


代码演示:


// 4. 忽略id成员变量值读取Excel表格,在excel中不会显示。
@Excellgore
private String id;

@DateTimeFormat

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


// 5. 按照指定的格式写入Excel内容
//只显示年月日
@DateTimeFormat("YYYY-MM-dd")
private Date birthday;

@NumberFormat

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


@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、写入时的注解注解


@ExcelProperty

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


可选属性:

image.png

使用效果:(与读一致)

index 指定写到第几列,如果不指定则根据成员变量位置排序;


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


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


其他注解:

基本和读取时一致


@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


相关文章
|
5月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
875 128
|
5月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
615 0
|
5月前
|
Java 测试技术 API
将 Spring 的 @Embedded 和 @Embeddable 注解与 JPA 结合使用的指南
Spring的@Embedded和@Embeddable注解简化了JPA中复杂对象的管理,允许将对象直接嵌入实体,减少冗余表与连接操作,提升数据库设计效率。本文详解其用法、优势及适用场景。
370 126
|
6月前
|
XML JSON Java
Spring框架中常见注解的使用规则与最佳实践
本文介绍了Spring框架中常见注解的使用规则与最佳实践,重点对比了URL参数与表单参数的区别,并详细说明了@RequestParam、@PathVariable、@RequestBody等注解的应用场景。同时通过表格和案例分析,帮助开发者正确选择参数绑定方式,避免常见误区,提升代码的可读性与安全性。
|
5月前
|
人工智能 Java 机器人
基于Spring AI Alibaba + Spring Boot + Ollama搭建本地AI对话机器人API
Spring AI Alibaba集成Ollama,基于Java构建本地大模型应用,支持流式对话、knife4j接口可视化,实现高隐私、免API密钥的离线AI服务。
4508 2
基于Spring AI Alibaba + Spring Boot + Ollama搭建本地AI对话机器人API
|
4月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
557 2
|
5月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
690 1
使用Spring的@Retryable注解进行自动重试
|
5月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
423 12
|
5月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
299 0
探索Spring Boot的@Conditional注解的上下文配置