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

ゞ浴缸里的玫瑰 2023-09-24 12:44 66阅读 0赞

> 陈老老老板 说明：工作了，学习一些新的技术栈和工作中遇到的问题，边学习边总结，各位一起加油。需要注意的地方都标红了，还有资源的分享. 一起加油。  
> **本文是介绍EasyExcel常用API与注解**

## 常用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 ####

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

**可选属性：**

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th align="left">含义</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>index</td> 
   <td align="left">对应Excel表中的列数</td> 
   <td>默认-1，建议指定时从0开始</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td align="left">对应Excel表中的列头</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>converter</td> 
   <td align="left">成员变量转换器</td> 
   <td>自定义转换器需要实Converter接口</td> 
  </tr> 
 </tbody> 
</table>

**注：**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 ####

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

**可选属性：**

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th align="left">含义</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>index</td> 
   <td align="left">对应Excel表中的列数</td> 
   <td>默认-1，指定时建议从0开始</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td align="left">对应Excel表中的列头</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>converter</td> 
   <td align="left">成员变量转换器</td> 
   <td>自定义转换器需要实Converter接口</td> 
  </tr> 
 </tbody> 
</table>

**使用效果**：（与读一致）  
`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

> **总结：EasyExcel常用API与注解，特别的方便。希望对您有帮助，感谢阅读  
>   
> 结束语：裸体一旦成为艺术，便是最圣洁的。道德一旦沦为虚伪，便是最下流的。  
> 勇敢去做你认为正确的事，不要被世俗的流言蜚语所困扰。**