《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


相关文章
|
1月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
50 0
|
2月前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
129 3
|
2天前
|
存储 安全 Java
Spring Boot 编写 API 的 10条最佳实践
本文总结了 10 个编写 Spring Boot API 的最佳实践,包括 RESTful API 设计原则、注解使用、依赖注入、异常处理、数据传输对象(DTO)建模、安全措施、版本控制、文档生成、测试策略以及监控和日志记录。每个实践都配有详细的编码示例和解释,帮助开发者像专业人士一样构建高质量的 API。
|
22天前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
36 4
|
23天前
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
34 4
|
1月前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
61 4
SpringBoot必须掌握的常用注解!
|
22天前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
67 2
|
22天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
40 2
|
25天前
|
消息中间件 Java 数据库
解密Spring Boot:深入理解条件装配与条件注解
Spring Boot中的条件装配与条件注解提供了强大的工具,使得应用程序可以根据不同的条件动态装配Bean,从而实现灵活的配置和管理。通过合理使用这些条件注解,开发者可以根据实际需求动态调整应用的行为,提升代码的可维护性和可扩展性。希望本文能够帮助你深入理解Spring Boot中的条件装配与条件注解,在实际开发中更好地应用这些功能。
31 2
|
26天前
|
JSON Java 数据格式
springboot常用注解
@RestController :修饰类,该控制器会返回Json数据 @RequestMapping(“/path”) :修饰类,该控制器的请求路径 @Autowired : 修饰属性,按照类型进行依赖注入 @PathVariable : 修饰参数,将路径值映射到参数上 @ResponseBody :修饰方法,该方法会返回Json数据 @RequestBody(需要使用Post提交方式) :修饰参数,将Json数据封装到对应参数中 @Controller@Service@Compont: 将类注册到ioc容器
下一篇
DataWorks