二快速入门EasyExcel

Posted 2021-12-18 上善若水

一、快速入门–QuickStart

1.1、新建工程、导入依赖

<!-- EasyExcel -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.1.6</version>
</dependency>
<!-- lombok 优雅编程 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
</dependency>
<!-- junit -->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

导入easyexcel-2.1.6坐标的时候，会依赖传递导入poi-3.17的POI。

1.2、最简单的读

读取如下excel中的内容：

项目结构

Student.java

package com.xbmu.pojo;

import lombok.Data;

import java.util.Date;

@Data
public class Student 
    /**
     * 学生姓名
     */
    private String name;
    /**
     * 学生性别
     */
    private String gender;

    /**
     * 学生出生日期
     */
    private Date birthday;
    /**
     * id
     */
    private String id;

StudentReadListener.java

package com.xbmu.listener;

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.xbmu.pojo.Student;
public class StudentReadListener extends AnalysisEventListener<Student> 
    // 每读一行内容，会调用该invoke方法一次，在invoke可以操作使用读取到的数据
    @Override
    public void invoke(Student student, AnalysisContext analysisContext) 
        System.out.println("row data = " + student);
    
    // 全部读完之后，会调用该方法
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) 

    

Test01.java

package com.xbmu.test;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.read.builder.ExcelReaderBuilder;
import com.alibaba.excel.read.builder.ExcelReaderSheetBuilder;
import com.xbmu.listener.StudentReadListener;
import com.xbmu.pojo.Student;
import org.junit.Test;

public class Test01 
    @Test
    public void test1()
    
        /**
         * pathName 文件路径
         * head 每行数据对应的实体
         * readListener 读监听器，每读一行就会调用一次该监听器的invoke方法
         */
        // 封装工作簿对象
        ExcelReaderBuilder workBook = EasyExcel.read("学员信息表.xlsx", Student.class, new StudentReadListener());
        // 封装工作表
        ExcelReaderSheetBuilder sheet = workBook.sheet();
        // 读取
        sheet.doRead();

    

运行结果

1.3、最简单的写

Student.java

package com.xbmu.pojo;

import com.alibaba.excel.annotation.ExcelIgnore;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

@Data
@AllArgsConstructor
@NoArgsConstructor
@ColumnWidth(20)
public class Student 
    /**
     * 学生姓名
     */
    @ExcelProperty(value = "学生姓名",index = 0)
    @ColumnWidth(30)
    private String name;
    /**
     * 学生性别
     */
    @ExcelProperty(value = "学生性别",index = 2)
    private String gender;

    /**
     * 学生出生日期
     */
    @ExcelProperty(value = "学生出生日期",index = 1)
    @ColumnWidth(20)
    private Date birthday;
    /**
     * id
     */
    //@ExcelProperty(value = "学生编号",index = 3)
    @ExcelIgnore
    private String id;

Test1.java

package com.xbmu.test;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.read.builder.ExcelReaderBuilder;
import com.alibaba.excel.read.builder.ExcelReaderSheetBuilder;
import com.alibaba.excel.write.builder.ExcelWriterBuilder;
import com.alibaba.excel.write.builder.ExcelWriterSheetBuilder;
import com.xbmu.listener.StudentReadListener;
import com.xbmu.pojo.Student;
import org.junit.Test;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

public class Test01 
    @Test
    public void test2()
    

        List<Student> students = initData();
        // 工作簿对象
        ExcelWriterBuilder workBook = EasyExcel.write("学员信息表_20211123.xlsx", Student.class);
        // 工作表对象。sheet方法参数：工作表的顺序号（从0开始）或者工作表的名字
        ExcelWriterSheetBuilder sheet = workBook.sheet();
        // 写入数据
        sheet.doWrite(students);

    
    private List<Student> initData() 
        ArrayList<Student> students = new ArrayList<>();
        for (int i = 0; i < 10; i++) 
            Student data = new Student();
            data.setName("张三0" + i);
            data.setBirthday(new Date());
            data.setGender("男");
            students.add(data);
        
        return students;
    

运行结果

1.4、总结：

1.4.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。

1.4.2、读取时的注解

@ExcelProperty

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

可选属性：

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

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

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

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

@ExcelIgnore

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

@DateTimeFormat

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

@NumberFormat

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

@ExcelIgnoreUnannotated

标注在类上。

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

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

1.4.3、 读取时通用参数

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

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

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

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

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

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

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

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

1.4.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即可。

1.4.5、ReadSheet（工作表对象）参数

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

1.4.6、写入时的注解

@ExcelProperty

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

可选属性：

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

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

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

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

其他注解：

基本和读取时一致

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

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

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

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

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

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

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

1.4.7、写入时通用参数

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

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

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

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

• needHead 是否导出头

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

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

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

1.4.8、WriteWorkbook（工作簿对象）参数

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

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

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

• templateInputStream 模板的文件流

• templateFile 模板文件

• autoCloseStream 自动关闭流。

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

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

1.4.9、WriteSheet（工作表对象）参数

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

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