Easy Excel 使用总结

心已赠人 2023-09-26 11:31 122阅读 0赞

--------------------

title: Easy Excel 使用总结  
date: 2022-10-14 17:33:57  
tags:

*  Excel  
    categories:
 *  开发技术及框架  
    cover: https://cover.png  
    feature: false

--------------------

## 1. 概述 ##

**官网地址：[EasyExcel 官方文档 - 基于 Java 的 Excel 处理工具 | Easy Excel (alibaba.com)][EasyExcel _ - _ Java _ Excel _ _ Easy Excel _alibaba.com]**

EasyExcel 是一个基于 Java 的、快速、简洁、解决大文件内存溢出的 Excel 处理工具。他能让你在不用考虑性能、内存的等因素的情况下，快速完成 Excel 的读、写等功能

![在这里插入图片描述][9a96eb37e97a4ac8b15ae70f60e78a85.png]

导入依赖

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>easyexcel</artifactId>
        <version>最新版本</version>
    </dependency>

## 2. 常用注解 ##

#### 2.2.1 @ExcelProperty ####

用于匹配 Excel 和实体类的匹配，参数如下：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>空</td> 
   <td>用于匹配 Excel 中的头，必须全匹配，如果有多行头，会匹配最后一行头</td> 
  </tr> 
  <tr> 
   <td>order</td> 
   <td>Integer.MAX_VALUE</td> 
   <td>优先级高于 <code>value</code>，会根据 <code>order</code> 的顺序来匹配实体和 excel 中数据的顺序</td> 
  </tr> 
  <tr> 
   <td>index</td> 
   <td>-1</td> 
   <td>优先级高于 <code>value</code> 和 <code>order</code>，会根据 <code>index</code> 直接指定到 excel 中具体的哪一列</td> 
  </tr> 
  <tr> 
   <td>converter</td> 
   <td>自动选择</td> 
   <td>指定当前字段用什么转换器，默认会自动选择。读的情况下只要实现 <code>com.alibaba.excel.converters.Converter#convertToJavaData(com.alibaba.excel.converters.ReadConverterContext&lt;?&gt;)</code> 方法即可</td> 
  </tr> 
 </tbody> 
</table>

#### 2.2.2 @ExcelIgnore ####

默认所有字段都会和 Excel 去匹配，加了这个注解会忽略该字段

#### 2.2.3 @ExcelIgnoreUnannotated ####

默认不管加不加 `ExcelProperty` 的注解的所有字段都会参与读写，加了 `ExcelIgnoreUnannotated` 注解以后，不加 `ExcelProperty` 注解的字段就不会参与

#### 2.2.4 @DateTimeFormat ####

日期转换，用 `String` 去接收 Excel 日期格式的数据会调用这个注解，参数如下：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>空</td> 
   <td>参照 <code>java.text.SimpleDateFormat</code> 书写即可</td> 
  </tr> 
  <tr> 
   <td>use1904windowing</td> 
   <td>自动选择</td> 
   <td>Excel 中时间是存储 1900 年起的一个双精度浮点数，但是有时候默认开始日期是 1904，所以设置这个值改成默认 1904 年开始</td> 
  </tr> 
 </tbody> 
</table>

#### 2.2.5 @NumberFormat ####

数字转换，用 `String` 去接收 Excel 数字格式的数据会调用这个注解

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>空</td> 
   <td>参照 <code>java.text.DecimalFormat</code> 书写即可</td> 
  </tr> 
  <tr> 
   <td>roundingMode</td> 
   <td>RoundingMode.HALF_UP</td> 
   <td>格式化的时候设置舍入模式</td> 
  </tr> 
 </tbody> 
</table>

## 3. 写 Excel（导出） ##

### 3.1 常用参数 ###

*  `WriteWorkbook`：可以理解成一个 Excel
 *  `WriteSheet`：理解成一个 Excel 里面的一个表单
 *  `WriteTable`：一个表单里面如果有多个实际用的表格，则可以用 `WriteTable`

#### 3.1.1 通用参数 ####

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

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>converter</td> 
   <td>空</td> 
   <td>默认加载了很多转换器，这里可以加入不支持的字段</td> 
  </tr> 
  <tr> 
   <td>writeHandler</td> 
   <td>空</td> 
   <td>写的处理器。可以实现 <code>WorkbookWriteHandler</code>，<code>SheetWriteHandler</code>，<code>RowWriteHandler</code>，<code>CellWriteHandler</code>，在写入 Excel 的不同阶段会调用</td> 
  </tr> 
  <tr> 
   <td>relativeHeadRowIndex</td> 
   <td>0</td> 
   <td>写入到 Excel 和上面空开几行</td> 
  </tr> 
  <tr> 
   <td>head</td> 
   <td>空</td> 
   <td>与 <code>clazz</code> 二选一。读取文件头对应的列表，会根据列表匹配数据，建议使用 class</td> 
  </tr> 
  <tr> 
   <td>clazz</td> 
   <td>空</td> 
   <td>与 <code>head</code> 二选一。读取文件的头对应的 class，也可以使用注解。如果两个都不指定，则会读取全部数据</td> 
  </tr> 
  <tr> 
   <td>autoTrim</td> 
   <td>true</td> 
   <td>会对头、读取数据等进行自动 trim</td> 
  </tr> 
  <tr> 
   <td>use1904windowing</td> 
   <td>false</td> 
   <td>Excel 中时间是存储 1900 年起的一个双精度浮点数，但是有时候默认开始日期是 1904，所以设置这个值改成默认 1904 年开始</td> 
  </tr> 
  <tr> 
   <td>useScientificFormat</td> 
   <td>false</td> 
   <td>数字转文本的时候在较大的数值的是否是否采用科学计数法</td> 
  </tr> 
  <tr> 
   <td>needHead</td> 
   <td>true</td> 
   <td>是否需要写入头到 Excel</td> 
  </tr> 
  <tr> 
   <td>useDefaultStyle</td> 
   <td>true</td> 
   <td>是否使用默认的样式</td> 
  </tr> 
  <tr> 
   <td>automaticMergeHead</td> 
   <td>true</td> 
   <td>自动合并头，头中相同的字段上下左右都会去尝试匹配</td> 
  </tr> 
  <tr> 
   <td>excludeColumnIndexes</td> 
   <td>空</td> 
   <td>需要排除对象中的 index 的数据</td> 
  </tr> 
  <tr> 
   <td>excludeColumnFieldNames</td> 
   <td>空</td> 
   <td>需要排除对象中的字段的数据</td> 
  </tr> 
  <tr> 
   <td>includeColumnIndexes</td> 
   <td>空</td> 
   <td>只要导出对象中的 index 的数据</td> 
  </tr> 
  <tr> 
   <td>includeColumnFieldNames</td> 
   <td>空</td> 
   <td>只要导出对象中的字段的数据</td> 
  </tr> 
 </tbody> 
</table>

#### 3.1.2 WriteWorkbook ####

EasyExcel.write(fileName, DemoData.class)
                // 在 write 方法之后， 在 sheet 方法之前都是设置 WriteWorkbook 的参数
                .sheet("模板")
                .doWrite(() -> {
        
                    // 分页查询数据
                    return data();
                });

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>excelType</td> 
   <td>空</td> 
   <td>当前 Excel 的类型,支持 XLS、XLSX、CSV</td> 
  </tr> 
  <tr> 
   <td>outputStream</td> 
   <td>空</td> 
   <td>与 <code>file</code> 二选一。写入文件的流</td> 
  </tr> 
  <tr> 
   <td>file</td> 
   <td>空</td> 
   <td>与 <code>outputStream</code> 二选一。写入的文件</td> 
  </tr> 
  <tr> 
   <td>templateInputStream</td> 
   <td>空</td> 
   <td>模板的文件流</td> 
  </tr> 
  <tr> 
   <td>templateFile</td> 
   <td>空</td> 
   <td>模板文件</td> 
  </tr> 
  <tr> 
   <td>charset</td> 
   <td>Charset#defaultCharset</td> 
   <td>只有 csv 文件有用，写入文件的时候使用的编码</td> 
  </tr> 
  <tr> 
   <td>autoCloseStream</td> 
   <td>true</td> 
   <td>自动关闭写入的流</td> 
  </tr> 
  <tr> 
   <td>password</td> 
   <td>空</td> 
   <td>读取文件的密码</td> 
  </tr> 
  <tr> 
   <td>inMemory</td> 
   <td>false</td> 
   <td>是否在内存处理，默认会生成临时文件以节约内存。内存模式效率会更好，但是容易 OOM</td> 
  </tr> 
  <tr> 
   <td>writeExcelOnException</td> 
   <td>false</td> 
   <td>写入过程中抛出异常了，是否尝试把数据写入到 Excel</td> 
  </tr> 
 </tbody> 
</table>

#### 3.1.3 WriteSheet ####

EasyExcel.write(fileName, DemoData.class)
                .sheet("模板")
                 // 在 sheet 方法之后，在 doWrite 方法之前都是设置 WriteSheet 的参数
                .doWrite(() -> {
        
                    // 分页查询数据
                    return data();
                });

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>sheetNo</td> 
   <td>0</td> 
   <td>需要写入的编码</td> 
  </tr> 
  <tr> 
   <td>sheetName</td> 
   <td>空</td> 
   <td>需要些的 Sheet 名称，默认同 <code>sheetNo</code></td> 
  </tr> 
 </tbody> 
</table>

#### 3.1.4 WriteTable ####

EasyExcel.write(fileName, DemoData.class)
                .sheet("模板")
                .table()
                // 在 table 方法之后， 在 doWrite 方法之前都是设置 WriteTable 的参数
                .doWrite(() -> {
        
                    // 分页查询数据
                    return data();
                });

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>tableNo</td> 
   <td>0</td> 
   <td>需要写入的编码</td> 
  </tr> 
 </tbody> 
</table>

### 3.2 简单的写 ###

省略其他获取数据和定义接口等实现

![在这里插入图片描述][dc6bfa96515a49d485f2e93e613d9902.png]

#### 3.2.1 定义表格实体类 ####

public class ExcelDO {
        
    
        @ExcelProperty("员工ID")
        private String empId;
        @ExcelProperty("员工姓名")
        private String empName;
        @ExcelProperty("员工工号")
        private String empCode;
        @ExcelProperty("身份证号")
        private String idcardNo;
        @ExcelProperty("性别")
        private String gender;
        @ExcelProperty("电话号码")
        private String phone;
        @ExcelProperty("地址")
        private String address;
        @ExcelProperty("邮箱")
        private String email;
        @ExcelProperty("备注")
        private String remark;
        @ExcelProperty("有效标志")
        private String valiFlag;
        @ExcelProperty("创建时间")
        private Timestamp createTime;
        @ExcelIgnore
        private Timestamp updateTime;
    }

#### 3.2.2 实现类 ####

@Service
    public class ExcelServiceImpl implements ExcelService {
        
    
        @Resource
        private EmployeeService employeeService;
    
        @Override
        public void simpleWrite() {
        
            String fileName = "D://simpleWrite" + System.currentTimeMillis() + ".xlsx";
    
            // 写法1
            EasyExcel.write(fileName, ExcelDO.class)
                    .sheet("模板")
                    .doWrite(() -> getData());
      
            // 写法2
            EasyExcel.write(fileName, ExcelDO.class).sheet("模板").doWrite(getData());
      
            // 写法3
            try (ExcelWriter excelWriter = EasyExcel.write(fileName, ExcelDO.class).build()) {
        
                WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
                excelWriter.write(getData(), writeSheet);
            }
        }
    
        private List<ExcelDO> getData() {
        
            List<ExcelDO> list = ListUtils.newArrayList();
    
            List records = employeeService.getEmployee().getRecords();
            list.addAll(records);
    
            return list;
        }
    }

#### 3.2.3 Controller ####

@RestController
    public class ExcelController {
        
    
        @Resource
        private ExcelService excelService;
    
        @PostMapping("/simpleWrite")
        public void simpleWrite() {
        
            excelService.simpleWrite();
        }
    }

#### 3.2.4 定义特殊格式转换 Convert ####

当使用 `LocalDateTime` 或 `Timestamp` 等格式时，会报 ExcelWriteDataConvertException，此时需要自定义类型转换器

![在这里插入图片描述][2b91c753420448719f11428db95418ab.png]

**TimestampConvert**

public class TimestampConvert implements Converter<Timestamp> {
        
    
        // 在Java中数据类型
        @Override
        public Class<Timestamp> supportJavaTypeKey() {
        
            return Timestamp.class;
        }
    
        // 在Excel中的数据类型
        @Override
        public CellDataTypeEnum supportExcelTypeKey() {
        
            return CellDataTypeEnum.STRING;
        }
    
        // 将Excel的数据类型转为Java数据类型
        @Override
        public Timestamp convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty,
                                           GlobalConfiguration globalConfiguration) throws Exception {
        
            return Timestamp.valueOf(cellData.getStringValue());
        }
    
        // 将Java的数据类型转为Excel数据类型
        @Override
        public WriteCellData<?> convertToExcelData(Timestamp value, ExcelContentProperty contentProperty,
                                                   GlobalConfiguration globalConfiguration) throws Exception {
        
            return new WriteCellData<>(value.toString());
        }
    }

#### 3.2.5 Convert 使用 ####

**1、找到需要转换的字段，在 `@ExcelProperty` 上添加 converter 属性\`**

![在这里插入图片描述][ded8d84e44be464eaf57e139bba772c8.png]

**2、`ExcelWriterBuilders` 是支持对单次的操作添加 converter 的，那样就不需要为每个需要转换的字段单独添加 converter 了**

![在这里插入图片描述][8010db58c65a4322897d511aa7403f37.png]

**3、全局 Convert**

即将自定义的 Convert 添加到 EasyExcel 的 Convert Map 转换器 Map 里（`Map<ConverterKey, Converter<?>> converterMap()`）

详细可见：[EasyExcel 自定义 Converter 全局加载器以及加载 Converter][EasyExcel _ Converter _ Converter]

**4、第二种方法还能这样写，在单次操作中加入转换器 Map 里**

public void simpleWrite() {
        
            String fileName = "D://simpleWrite" + System.currentTimeMillis() + ".xlsx";
    
    //        EasyExcel.write(fileName, ExcelDO.class)
    //                .registerConverter(new TimestampConvert())
    //                .sheet("模板")
    //                .doWrite(() -> getData());
            ExcelWriter excelWriter = EasyExcel.write(fileName, ExcelDO.class).build();
    
            TimestampConvert timestampConvert = new TimestampConvert();
            excelWriter.writeContext().currentWriteHolder().converterMap()
                    .put(ConverterKeyBuild.buildKey(timestampConvert.supportJavaTypeKey()), timestampConvert);
            excelWriter.writeContext().currentWriteHolder().converterMap()
                    .put(ConverterKeyBuild.buildKey(timestampConvert.supportJavaTypeKey(), timestampConvert.supportExcelTypeKey()), timestampConvert);
    
            WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
            excelWriter.write(getData(), writeSheet);
    }

#### 3.2.6 定义内容转换 Convert ####

导出后，发现性别和有效标志等字段，显示的是数据库中存储的数字，应该将其转换为对应的含义

![在这里插入图片描述][317f3e49d93d4dd8a300f4acebbf2f06.png]

**GenderConverter**

public class GenderConverter implements Converter<String> {
        
    
        @Override
        public Class<String> supportJavaTypeKey() {
        
            return String.class;
        }
    
        @Override
        public CellDataTypeEnum supportExcelTypeKey() {
        
            return CellDataTypeEnum.STRING;
        }
    
        @Override
        public String convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
        
            return "男".equals(cellData.getStringValue()) ? "1" : "0";
        }
    
        @Override
        public WriteCellData<?> convertToExcelData(String value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
        
            return new WriteCellData<>(value.equals("1") ? "男" : "女");
        }
    }

使用 Convert 的第一种使用方法

![在这里插入图片描述][e2cafd24c51e4d6da78754097f2dd553.png]

再导出后，性别已经由数字转换为对应的含义

![在这里插入图片描述][66ec47f6dc834a918bc6344c4d2bf0a9.png]

### 3.3 Web 中的写（下载） ###

与简单的写类似

@RestController
    public class ExcelController {
        
    
        @Resource
        private ExcelService excelService;
    
        @GetMapping("/download")
        public void download(HttpServletResponse response) throws IOException {
        
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.setCharacterEncoding("UTF-8");
            // 这里 URLEncoder.encode可以防止中文乱码，和 EasyExcel 没有关系
            String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
    
            EasyExcel.write(response.getOutputStream(), ExcelDO.class).sheet("模板").doWrite(excelService.getData());
        }
    }

浏览器地址栏输入接口地址，会弹出文件下载

![在这里插入图片描述][90e7a7be977b4e94a3b6c9bd346f5d0f.png]

![在这里插入图片描述][c4bdcc0f963b4bfb9c6a0a00e9675ac0.png]

**下载失败的时候返回 JSON**

@RestController
    public class ExcelController {
        
    
        @Resource
        private ExcelService excelService;
    
        @GetMapping("/download")
        public void download(HttpServletResponse response) throws IOException {
        
            try {
        
                // 正确设置 response 的 content-type；即设置正确的 mime type
                response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
                response.setCharacterEncoding("UTF-8");
                // 这里 URLEncoder.encode可以防止中文乱码 当然和 EasyExcel 没有关系
                String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
                response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
      
    //            int i = 1 / 0;
                EasyExcel.write(response.getOutputStream(), ExcelDO.class).sheet("模板").doWrite(excelService.getData());
            } catch (Exception e) {
        
                response.reset();
                response.setContentType("application/json");
                response.setCharacterEncoding("UTF-8");
      
                response.getWriter().println(JSON.toJSONString(Result.fail("下载文件失败")));
            }
        }
    }

![在这里插入图片描述][039838c46b364719a414c63ae7e567b9.png]

## 4. 读 Excel（导入） ##

### 4.1 常用参数 ###

*  `ReadWorkbook` 可以理解成一个 excel
 *  `ReadSheet` 理解成一个 excel 里面的一个表单

#### 4.1.1 通用参数 ####

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

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>converter</td> 
   <td>空</td> 
   <td>默认加载了很多转换器，这里可以加入不支持的字段</td> 
  </tr> 
  <tr> 
   <td>readListener</td> 
   <td>空</td> 
   <td>可以注册多个监听器，读取 Excel 的时候会不断的回调监听器中的方法</td> 
  </tr> 
  <tr> 
   <td>headRowNumber</td> 
   <td>1</td> 
   <td>excel 中头的行数，默认 1 行</td> 
  </tr> 
  <tr> 
   <td>head</td> 
   <td>空</td> 
   <td>与 <code>clazz</code> 二选一。读取文件头对应的列表，会根据列表匹配数据，建议使用 class</td> 
  </tr> 
  <tr> 
   <td>clazz</td> 
   <td>空</td> 
   <td>与 <code>head</code> 二选一。读取文件的头对应的 class，也可以使用注解。如果两个都不指定，则会读取全部数据</td> 
  </tr> 
  <tr> 
   <td>autoTrim</td> 
   <td>true</td> 
   <td>会对头、读取数据等进行自动 trim</td> 
  </tr> 
  <tr> 
   <td>use1904windowing</td> 
   <td>false</td> 
   <td>Excel 中时间是存储 1900 年起的一个双精度浮点数，但是有时候默认开始日期是 1904，所以设置这个值改成默认 1904 年开始</td> 
  </tr> 
  <tr> 
   <td>useScientificFormat</td> 
   <td>false</td> 
   <td>数字转文本的时候在较大的数值的是否是否采用科学计数法</td> 
  </tr> 
 </tbody> 
</table>

#### 4.1.2 ReadWorkbook ####

EasyExcel.read(fileName, DemoData.class, new DemoDataListener())
               // 在 read 方法之后， 在 sheet方法之前都是设置ReadWorkbook的参数
               .sheet()
               .doRead();

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>excelType</td> 
   <td>空</td> 
   <td>当前 excel 的类型,支持 XLS、XLSX、CSV</td> 
  </tr> 
  <tr> 
   <td>inputStream</td> 
   <td>空</td> 
   <td>与 <code>file</code> 二选一。读取文件的流，如果接收到的是流就只用，不用流建议使用 <code>file</code> 参数。因为使用了 <code>inputStream</code> easyexcel 会帮忙创建临时文件，最终还是 <code>file</code></td> 
  </tr> 
  <tr> 
   <td>file</td> 
   <td>空</td> 
   <td>与 <code>inputStream</code> 二选一。读取文件的文件。</td> 
  </tr> 
  <tr> 
   <td>mandatoryUseInputStream</td> 
   <td>false</td> 
   <td>强制使用 <code>inputStream</code> 来创建对象，性能会变差，但是不会创建临文件。</td> 
  </tr> 
  <tr> 
   <td>charset</td> 
   <td>Charset#defaultCharset</td> 
   <td>只有 csv 文件有用，读取文件的时候使用的编码</td> 
  </tr> 
  <tr> 
   <td>autoCloseStream</td> 
   <td>true</td> 
   <td>自动关闭读取的流。</td> 
  </tr> 
  <tr> 
   <td>readCache</td> 
   <td>空</td> 
   <td>默认小于 5M 用 内存，超过 5M 会使用 <code>EhCache</code>,这里不建议使用这个参数。</td> 
  </tr> 
  <tr> 
   <td>readCacheSelector</td> 
   <td>SimpleReadCacheSelector</td> 
   <td>用于选择什么时候用内存去存储临时数据，什么时候用磁盘存储临时数据</td> 
  </tr> 
  <tr> 
   <td>ignoreEmptyRow</td> 
   <td>true</td> 
   <td>忽略空的行</td> 
  </tr> 
  <tr> 
   <td>password</td> 
   <td>空</td> 
   <td>读取文件的密码</td> 
  </tr> 
  <tr> 
   <td>xlsxSAXParserFactoryName</td> 
   <td>空</td> 
   <td>指定 sax 读取使用的 class 的名称，例如：<code>com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl</code></td> 
  </tr> 
  <tr> 
   <td>useDefaultListener</td> 
   <td>true</td> 
   <td><code>@since 2.1.4</code> 默认会加入 <code>ModelBuildEventListener</code> 来帮忙转换成传入 <code>class</code> 的对象，设置成 <code>false</code> 后将不会协助转换对象，自定义的监听器会接收到 <code>Map&lt;Integer,CellData&gt;</code> 对象，如果还想继续接听到 <code>class</code> 对象，请调用 <code>readListener</code> 方法，加入自定义的 <code>beforeListener</code>、 <code>ModelBuildEventListener</code>、 自定义的 <code>afterListener</code> 即可。</td> 
  </tr> 
  <tr> 
   <td>extraReadSet</td> 
   <td>空</td> 
   <td>额外需要读取内容的 set，默认不读取这些数据</td> 
  </tr> 
 </tbody> 
</table>

#### 4.1.3 ReadSheet ####

EasyExcel.read(fileName, DemoData.class, new DemoDataListener())
               .sheet()
               // 在 sheet 方法之后， 在 doRead方法之前都是设置ReadSheet的参数
               .doRead();

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>sheetNo</td> 
   <td>0</td> 
   <td>需要读取 Sheet 的编码，建议使用这个来指定读取哪个 Sheet</td> 
  </tr> 
  <tr> 
   <td>sheetName</td> 
   <td>空</td> 
   <td>根据名字去匹配 Sheet</td> 
  </tr> 
 </tbody> 
</table>

### 4.2 简单的读 ###

读取的表格就使用上面导出的表格

#### 4.2.1 表格实体类和 Convert ####

表格实体类和 Convert 就使用写 Excel 的实体类和 Convert

#### 4.2.2 实现类 ####

@Service
    public class ExcelServiceImpl implements ExcelService {
        
    
        @Resource
        private EmployeeDAO employeeDAO;
    
        public void simpleRead() {
        
            String fileName = "D:\\simpleWrite1665735316967.xlsx";
    
            // 写法1：不用额外写一个 ExcelListener
            // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
            // 这里每次会读取100条数据 然后返回过来 直接调用使用数据就行
            EasyExcel.read(fileName, ExcelDO.class, new PageReadListener<ExcelDO>(excelDOS -> {
        
                for (ExcelDO excelDO : excelDOS) {
        
                    System.out.println(excelDO);
                }
            })).sheet().doRead();
    
            // 写法2：匿名内部类 不用额外写一个 ExcelListener
            EasyExcel.read(fileName, ExcelDO.class, new ReadListener<ExcelDO>() {
        
                // 单次缓存的数据量
                public static final int BATCH_COUNT = 100;
                // 临时存储
                private List<ExcelDO> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    
                @Override
                public void invoke(ExcelDO data, AnalysisContext context) {
        
                    cachedDataList.add(data);
                    if (cachedDataList.size() >= BATCH_COUNT) {
        
                        saveData();
                        // 存储完成清理 list
                        cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
                    }
                }
    
                // 所有数据解析完成了 都会来调用
                @Override
                public void doAfterAllAnalysed(AnalysisContext context) {
        
                    saveData();
                }
    
                // 存储到数据库，批量插入
                private void saveData() {
        
                    for (ExcelDO excelDO : cachedDataList) {
        
                        System.out.println(excelDO);
                    }
                }
            }).sheet().doRead();
    
            // 写法3：有个很重要的点 ExcelListener 不能被Spring管理，要每次读取Excel都要new,然后里面用到Spring可以构造方法传进去
            EasyExcel.read(fileName, ExcelDO.class, new ExcelListener(employeeDAO)).sheet().doRead();
    
            // 写法4：一个文件一个reader
            try (ExcelReader excelReader = EasyExcel.read(fileName, ExcelDO.class, new ExcelListener(employeeDAO)).build()) {
        
                // 构建一个sheet 这里可以指定名字或者no
                ReadSheet readSheet = EasyExcel.readSheet(0).build();
                // 读取一个sheet
                excelReader.read(readSheet);
            }
        }
    }

#### 4.2.3 监听器 ####

即把第二种写法的匿名内部类单独抽出来，**监听器不能被 Spring 管理，每次读取 Excel 都要 new，然后里面用到 Spring 可以构造方法传进去**

public class ExcelListener implements ReadListener<ExcelDO> {
        
    
        // 单次缓存的数据量
        public static final int BATCH_COUNT = 100;
        // 临时存储
        private List<ExcelDO> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    
        private EmployeeDAO employeeDAO;
    
        /**
         * 如果使用了Spring，使用这个构造方法。每次创建Listener的时候需要把Spring管理的类传进来
         *
         * @param employeeDAO
         */
        public ExcelListener(EmployeeDAO employeeDAO) {
        
            this.employeeDAO = employeeDAO;
        }
    
        /**
         * 这个每一条数据解析都会来调用
         *
         * @param data    one row value. Is same as {@link AnalysisContext#readRowHolder()}
         * @param context
         */
        @Override
        public void invoke(ExcelDO data, AnalysisContext context) {
        
            cachedDataList.add(data);
            // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
            if (cachedDataList.size() >= BATCH_COUNT) {
        
                saveData();
                // 存储完成清理 list
                cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
            }
        }
    
        /**
         * 所有数据解析完成了 都会来调用
         *
         * @param context
         */
        @Override
        public void doAfterAllAnalysed(AnalysisContext context) {
        
            // 这里也要保存数据，确保最后遗留的数据也存储到数据库
            saveData();
        }
    
        // 存储到数据库，批量存储
        private void saveData() {
        
    //        employeeDAO.save(cachedDataList);
            for (ExcelDO excelDO : cachedDataList) {
        
                System.out.println(excelDO);
            }
        }
    }

#### 4.2.4 Controller ####

@RestController
    public class ExcelController {
        
    
        @Resource
        private ExcelService excelService;
    
        @PostMapping("/simpleRead")
        public void simpleRead() {
        
            excelService.simpleRead();
        }
    }

![在这里插入图片描述][a1b8762d83704375acdf861d5e02852b.png]

### 4.3 Web 中的读（上传） ###

与简单的读类似

@RestController
    public class ExcelController {
        
    
        @Resource
        private EmployeeDAO employeeDAO;
    
        @PostMapping("upload")
        public Result upload(MultipartFile file) throws IOException {
        
            EasyExcel.read(file.getInputStream(), ExcelDO.class, new ExcelListener(employeeDAO)).sheet().doRead();
            return Result.success("上传成功");
        }
    }

![在这里插入图片描述][e6b2e657fa294fd99207269fee4b13f7.png]

![在这里插入图片描述][9ed0a157a0f84bf3af0aa11895b73433.png]

**更多读写相关操作详见官方文档：[关于 Easyexcel | Easy Excel (alibaba.com)][Easyexcel _ Easy Excel _alibaba.com]**

[EasyExcel _ - _ Java _ Excel _ _ Easy Excel _alibaba.com]: https://easyexcel.opensource.alibaba.com/
[9a96eb37e97a4ac8b15ae70f60e78a85.png]: https://img-blog.csdnimg.cn/9a96eb37e97a4ac8b15ae70f60e78a85.png
[dc6bfa96515a49d485f2e93e613d9902.png]: https://img-blog.csdnimg.cn/dc6bfa96515a49d485f2e93e613d9902.png
[2b91c753420448719f11428db95418ab.png]: https://img-blog.csdnimg.cn/2b91c753420448719f11428db95418ab.png
[ded8d84e44be464eaf57e139bba772c8.png]: https://img-blog.csdnimg.cn/ded8d84e44be464eaf57e139bba772c8.png
[8010db58c65a4322897d511aa7403f37.png]: https://img-blog.csdnimg.cn/8010db58c65a4322897d511aa7403f37.png
[EasyExcel _ Converter _ Converter]: https://blog.csdn.net/fsadkjl/article/details/105823830
[317f3e49d93d4dd8a300f4acebbf2f06.png]: https://img-blog.csdnimg.cn/317f3e49d93d4dd8a300f4acebbf2f06.png
[e2cafd24c51e4d6da78754097f2dd553.png]: https://img-blog.csdnimg.cn/e2cafd24c51e4d6da78754097f2dd553.png
[66ec47f6dc834a918bc6344c4d2bf0a9.png]: https://img-blog.csdnimg.cn/66ec47f6dc834a918bc6344c4d2bf0a9.png
[90e7a7be977b4e94a3b6c9bd346f5d0f.png]: https://img-blog.csdnimg.cn/90e7a7be977b4e94a3b6c9bd346f5d0f.png
[c4bdcc0f963b4bfb9c6a0a00e9675ac0.png]: https://img-blog.csdnimg.cn/c4bdcc0f963b4bfb9c6a0a00e9675ac0.png
[039838c46b364719a414c63ae7e567b9.png]: https://img-blog.csdnimg.cn/039838c46b364719a414c63ae7e567b9.png
[a1b8762d83704375acdf861d5e02852b.png]: https://img-blog.csdnimg.cn/a1b8762d83704375acdf861d5e02852b.png
[e6b2e657fa294fd99207269fee4b13f7.png]: https://img-blog.csdnimg.cn/e6b2e657fa294fd99207269fee4b13f7.png
[9ed0a157a0f84bf3af0aa11895b73433.png]: https://img-blog.csdnimg.cn/9ed0a157a0f84bf3af0aa11895b73433.png
[Easyexcel _ Easy Excel _alibaba.com]: https://easyexcel.opensource.alibaba.com/docs/current/