EasyExcelUtil (easyexcel-util 1.0.2 API)

java.lang.Object
- com.github.ciweigg.EasyExcelUtil

public class EasyExcelUtil
extends Object

easyexcel工具类

Author:: Una

Constructor Summary

Constructors
Constructor and Description

EasyExcelUtil()

Constructors
Constructor and Description
`EasyExcelUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> void`	`asyncRead(File file, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Integer sheetNo, Integer headRowNum)` 异步无模型读（指定sheet和表头占的行数）
`static <T> void`	`asyncRead(InputStream inputStream, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Integer sheetNo, Integer headRowNum)` 异步无模型读（指定sheet和表头占的行数）
`static <T> void`	`asyncRead(String filePath, com.alibaba.excel.event.AnalysisEventListener<T> excelListener)` 异步无模型读（默认读取sheet0,从第2行开始读）
`static <T> void`	`asyncRead(String filePath, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Integer sheetNo)` 异步无模型读（默认表头占一行，从第2行开始读）
`static <T> void`	`asyncRead(String filePath, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Integer sheetNo, Integer headRowNum)` 异步无模型读（指定sheet和表头占的行数）
`static <T> void`	`asyncReadModel(File file, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Class<T> clazz, Integer sheetNo, Integer headRowNum)` 异步按模型读取
`static <T> void`	`asyncReadModel(InputStream inputStream, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Class clazz, Integer sheetNo, Integer headRowNum)` 异步按模型读取
`static <T> void`	`asyncReadModel(String filePath, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Class clazz)` 异步按模型读取（默认读取sheet0,从第2行开始读）
`static <T> void`	`asyncReadModel(String filePath, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Class<T> clazz, Integer sheetNo, Integer headRowNum)` 异步按模型读取
`static <T> void`	`asyncReadModel(String filePath, com.alibaba.excel.event.AnalysisEventListener<T> excelListener, Class clazz, Integer sheetNo)` 异步按模型读取（默认表头占一行，从第2行开始读）
`static List<Map<Integer,String>>`	`syncRead(File file, Integer sheetNo, Integer headRowNum)` 同步无模型读（指定sheet和表头占的行数）
`static List<Map<Integer,String>>`	`syncRead(InputStream inputStream, Integer sheetNo, Integer headRowNum)` 同步无模型读（指定sheet和表头占的行数）
`static List<Map<Integer,String>>`	`syncRead(String filePath)` 同步无模型读（默认读取sheet0,从第2行开始读）
`static List<Map<Integer,String>>`	`syncRead(String filePath, Integer sheetNo)` 同步无模型读（默认表头占一行，从第2行开始读）
`static List<Map<Integer,String>>`	`syncRead(String filePath, Integer sheetNo, Integer headRowNum)` 同步无模型读（指定sheet和表头占的行数）
`static <T> List<T>`	`syncReadModel(File file, Class<T> clazz, Integer sheetNo, Integer headRowNum)` 同步按模型读（指定sheet和表头占的行数）
`static <T> List<T>`	`syncReadModel(InputStream inputStream, Class<T> clazz, Integer sheetNo, Integer headRowNum)` 同步按模型读（指定sheet和表头占的行数）
`static <T> List<T>`	`syncReadModel(String filePath, Class<T> clazz)` 同步按模型读（默认读取sheet0,从第2行开始读）
`static <T> List<T>`	`syncReadModel(String filePath, Class<T> clazz, Integer sheetNo)` 同步按模型读（默认表头占一行，从第2行开始读）
`static <T> List<T>`	`syncReadModel(String filePath, Class<T> clazz, Integer sheetNo, Integer headRowNum)` 同步按模型读（指定sheet和表头占的行数）
`static <T> void`	`write(OutputStream outputStream, Class<T> headClazz, List<T> data, com.alibaba.excel.write.handler.WriteHandler writeHandler, Integer sheetNo, String sheetName)` 按模板写文件
`static <T> void`	`write(String filePath, Class<T> headClazz, List<T> data)` 按模板写文件
`static <T> void`	`write(String filePath, Class<T> headClazz, List<T> data, Integer sheetNo, String sheetName)` 按模板写文件
`static <T> void`	`write(String filePath, Class<T> headClazz, List<T> data, com.alibaba.excel.write.handler.WriteHandler writeHandler, Integer sheetNo, String sheetName)` 按模板写文件
`static void`	`write(String filePath, List<List<String>> head, List<List<Object>> data)` 无模板写文件
`static void`	`write(String filePath, List<List<String>> head, List<List<Object>> data, Integer sheetNo, String sheetName)` 无模板写文件
`static <T> void`	`writeExclude(String filePath, Class<T> headClazz, List<T> data, Set<String> excludeCols, Integer sheetNo, String sheetName)` 按模板写文件（排除某些字段）
`static <T> void`	`writeInclude(String filePath, Class<T> headClazz, List<T> data, Set<String> includeCols, Integer sheetNo, String sheetName)` 按模板写文件（包含某些字段）
`static <T> void`	`writeTemplate(String filePath, String templateFileName, Class<T> headClazz, List<T> data)` 根据excel模板文件写入文件
`static <T> void`	`writeTemplate(String filePath, String templateFileName, List<T> data)` 根据excel模板文件写入文件
`static EasyExcelWriterFactory`	`writeWithSheets(File file)` 多个sheet页的数据链式写入 ExcelUtil.writeWithSheets(file) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();
`static EasyExcelWriterFactory`	`writeWithSheets(OutputStream outputStream)` 多个sheet页的数据链式写入 ExcelUtil.writeWithSheets(outputStream) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();
`static EasyExcelWriterFactory`	`writeWithSheets(String filePath)` 多个sheet页的数据链式写入 ExcelUtil.writeWithSheets(filePath) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();
`static EasyExcelWriterFactory`	`writeWithSheetsWeb(javax.servlet.http.HttpServletResponse response, String exportFileName)` 多个sheet页的数据链式写入（失败了会返回一个有部分数据的Excel） ExcelUtil.writeWithSheets(response, exportFileName) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();
`static EasyExcelWriterFactory`	`writeWithSheetsWeb(javax.servlet.http.HttpServletResponse response, String exportFileName, com.alibaba.excel.write.handler.SheetWriteHandler writeHandler)` 多个sheet页的数据链式写入（失败了会返回一个有部分数据的Excel） ExcelUtil.writeWithSheets(response, exportFileName) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- EasyExcelUtil
```
public EasyExcelUtil()
```

Method Detail

syncRead
```
public static List<Map<Integer,String>> syncRead(String filePath)
```
同步无模型读（默认读取sheet0,从第2行开始读）

Parameters:

filePath - .

Returns:

Map的key-value为colNum, cellValue

syncRead

public static List<Map<Integer,String>> syncRead(String filePath,
                                                 Integer sheetNo)

同步无模型读（默认表头占一行，从第2行开始读）

Parameters:: filePath - .; sheetNo - sheet页号，从0开始
Returns:: Map的key-value为colNum, cellValue

syncRead

public static List<Map<Integer,String>> syncRead(InputStream inputStream,
                                                 Integer sheetNo,
                                                 Integer headRowNum)

同步无模型读（指定sheet和表头占的行数）

Parameters:: inputStream - .; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）
Returns:: Map的key-value为colNum, cellValue

syncRead

public static List<Map<Integer,String>> syncRead(File file,
                                                 Integer sheetNo,
                                                 Integer headRowNum)

同步无模型读（指定sheet和表头占的行数）

Parameters:: file - .; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）
Returns:: Map的key-value为colNum, cellValue

syncRead

public static List<Map<Integer,String>> syncRead(String filePath,
                                                 Integer sheetNo,
                                                 Integer headRowNum)

同步无模型读（指定sheet和表头占的行数）

Parameters:: filePath - .; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）
Returns:: Map的key-value为colNum, cellValue

syncReadModel
```
public static <T> List<T> syncReadModel(String filePath,
                                        Class<T> clazz)
```
同步按模型读（默认读取sheet0,从第2行开始读）

Type Parameters:

T - 泛型

Parameters:

filePath - .

clazz - 模型的类类型（excel数据会按该类型转换成对象）

Returns:

.

syncReadModel

public static <T> List<T> syncReadModel(String filePath,
                                        Class<T> clazz,
                                        Integer sheetNo)

同步按模型读（默认表头占一行，从第2行开始读）

Type Parameters:: T - 泛型
Parameters:: filePath - .; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始
Returns:: .

syncReadModel

public static <T> List<T> syncReadModel(InputStream inputStream,
                                        Class<T> clazz,
                                        Integer sheetNo,
                                        Integer headRowNum)

同步按模型读（指定sheet和表头占的行数）

Type Parameters:: T - 泛型
Parameters:: inputStream - .; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）
Returns:: .

syncReadModel

public static <T> List<T> syncReadModel(File file,
                                        Class<T> clazz,
                                        Integer sheetNo,
                                        Integer headRowNum)

同步按模型读（指定sheet和表头占的行数）

Type Parameters:: T - 泛型
Parameters:: file - .; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）
Returns:: .

syncReadModel

public static <T> List<T> syncReadModel(String filePath,
                                        Class<T> clazz,
                                        Integer sheetNo,
                                        Integer headRowNum)

同步按模型读（指定sheet和表头占的行数）

Type Parameters:: T - 泛型
Parameters:: filePath - .; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）
Returns:: .

asyncRead
```
public static <T> void asyncRead(String filePath,
                                 com.alibaba.excel.event.AnalysisEventListener<T> excelListener)
```
异步无模型读（默认读取sheet0,从第2行开始读）

Type Parameters:

T - 泛型

Parameters:

excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等

filePath - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

asyncRead
```
public static <T> void asyncRead(String filePath,
                                 com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                 Integer sheetNo)
```
异步无模型读（默认表头占一行，从第2行开始读）

Type Parameters:

T - 泛型

Parameters:

filePath - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等

sheetNo - sheet页号，从0开始

asyncRead
```
public static <T> void asyncRead(InputStream inputStream,
                                 com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                 Integer sheetNo,
                                 Integer headRowNum)
```
异步无模型读（指定sheet和表头占的行数）

Type Parameters:

T - 泛型

Parameters:

inputStream - .

excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等

sheetNo - sheet页号，从0开始

headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

asyncRead
```
public static <T> void asyncRead(File file,
                                 com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                 Integer sheetNo,
                                 Integer headRowNum)
```
异步无模型读（指定sheet和表头占的行数）

Type Parameters:

T - 泛型

Parameters:

file - .

excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等

sheetNo - sheet页号，从0开始

headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

asyncRead
```
public static <T> void asyncRead(String filePath,
                                 com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                 Integer sheetNo,
                                 Integer headRowNum)
```
异步无模型读（指定sheet和表头占的行数）

Type Parameters:

T - 泛型

Parameters:

filePath - .

excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等

sheetNo - sheet页号，从0开始

headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

asyncReadModel
```
public static <T> void asyncReadModel(String filePath,
                                      com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                      Class clazz)
```
异步按模型读取（默认读取sheet0,从第2行开始读）

Type Parameters:

T - 泛型

Parameters:

filePath - .

excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等

clazz - 模型的类类型（excel数据会按该类型转换成对象）

asyncReadModel

public static <T> void asyncReadModel(String filePath,
                                      com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                      Class clazz,
                                      Integer sheetNo)

异步按模型读取（默认表头占一行，从第2行开始读）

Type Parameters:: T - 泛型
Parameters:: filePath - .; excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始

asyncReadModel

public static <T> void asyncReadModel(InputStream inputStream,
                                      com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                      Class clazz,
                                      Integer sheetNo,
                                      Integer headRowNum)

异步按模型读取

Type Parameters:: T - 泛型
Parameters:: inputStream - .; excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

asyncReadModel

public static <T> void asyncReadModel(File file,
                                      com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                      Class<T> clazz,
                                      Integer sheetNo,
                                      Integer headRowNum)

异步按模型读取

Type Parameters:: T - 泛型
Parameters:: file - .; excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

asyncReadModel

public static <T> void asyncReadModel(String filePath,
                                      com.alibaba.excel.event.AnalysisEventListener<T> excelListener,
                                      Class<T> clazz,
                                      Integer sheetNo,
                                      Integer headRowNum)

异步按模型读取

Type Parameters:: T - 泛型
Parameters:: filePath - .; excelListener - 监听器，在监听器中可以处理行数据LinkedHashMap，表头数据，异常处理等; clazz - 模型的类类型（excel数据会按该类型转换成对象）; sheetNo - sheet页号，从0开始; headRowNum - 表头占的行数，从0开始（如果要连表头一起读出来则传0）

write

public static void write(String filePath,
                         List<List<String>> head,
                         List<List<Object>> data)

无模板写文件

Parameters:: filePath - .; head - 表头数据; data - 表内容数据

write

public static void write(String filePath,
                         List<List<String>> head,
                         List<List<Object>> data,
                         Integer sheetNo,
                         String sheetName)

无模板写文件

Parameters:: filePath - .; head - 表头数据; data - 表内容数据; sheetNo - sheet页号，从0开始; sheetName - sheet名称

writeTemplate

public static <T> void writeTemplate(String filePath,
                                     String templateFileName,
                                     Class<T> headClazz,
                                     List<T> data)

根据excel模板文件写入文件

Type Parameters:: T - 泛型
Parameters:: filePath - .; templateFileName - 模板文件名称; headClazz - 表头模板; data - 数据

writeTemplate

public static <T> void writeTemplate(String filePath,
                                     String templateFileName,
                                     List<T> data)

根据excel模板文件写入文件

Type Parameters:: T - 泛型
Parameters:: filePath - .; templateFileName - .; data - 数据

write

public static <T> void write(String filePath,
                             Class<T> headClazz,
                             List<T> data)

按模板写文件

Type Parameters:: T - 泛型
Parameters:: filePath - .; headClazz - 表头模板; data - 数据

write

public static <T> void write(String filePath,
                             Class<T> headClazz,
                             List<T> data,
                             Integer sheetNo,
                             String sheetName)

按模板写文件

Type Parameters:: T - 泛型
Parameters:: filePath - .; headClazz - 表头模板; data - 数据; sheetNo - sheet页号，从0开始; sheetName - sheet名称

write

public static <T> void write(String filePath,
                             Class<T> headClazz,
                             List<T> data,
                             com.alibaba.excel.write.handler.WriteHandler writeHandler,
                             Integer sheetNo,
                             String sheetName)

按模板写文件

Type Parameters:: T - 泛型
Parameters:: filePath - .; headClazz - 表头模板; data - 数据; writeHandler - 自定义的处理器，比如设置table样式，设置超链接、单元格下拉框等等功能都可以通过这个实现（需要注册多个则自己通过链式去调用）; sheetNo - sheet页号，从0开始; sheetName - sheet名称

write

public static <T> void write(OutputStream outputStream,
                             Class<T> headClazz,
                             List<T> data,
                             com.alibaba.excel.write.handler.WriteHandler writeHandler,
                             Integer sheetNo,
                             String sheetName)

按模板写文件

Type Parameters:: T - 泛型
Parameters:: outputStream - .; headClazz - 表头模板; data - 数据; writeHandler - 自定义的处理器，比如设置table样式，设置超链接、单元格下拉框等等功能都可以通过这个实现（需要注册多个则自己通过链式去调用）; sheetNo - sheet页号，从0开始; sheetName - sheet名称

writeInclude

public static <T> void writeInclude(String filePath,
                                    Class<T> headClazz,
                                    List<T> data,
                                    Set<String> includeCols,
                                    Integer sheetNo,
                                    String sheetName)

按模板写文件（包含某些字段）

Type Parameters:: T - 泛型
Parameters:: filePath - .; headClazz - 表头模板; data - 数据; includeCols - 过滤包含的字段，根据字段名称过滤; sheetNo - sheet页号，从0开始; sheetName - sheet名称

writeExclude

public static <T> void writeExclude(String filePath,
                                    Class<T> headClazz,
                                    List<T> data,
                                    Set<String> excludeCols,
                                    Integer sheetNo,
                                    String sheetName)

按模板写文件（排除某些字段）

Type Parameters:: T - 泛型
Parameters:: filePath - .; headClazz - 表头模板; data - 数据; excludeCols - 过滤排除的字段，根据字段名称过滤; sheetNo - sheet页号，从0开始; sheetName - sheet名称

writeWithSheets
```
public static EasyExcelWriterFactory writeWithSheets(OutputStream outputStream)
```
多个sheet页的数据链式写入 ExcelUtil.writeWithSheets(outputStream) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();

Parameters:

outputStream - .

Returns:

EasyExcelWriterFactory

writeWithSheets
```
public static EasyExcelWriterFactory writeWithSheets(File file)
```
多个sheet页的数据链式写入 ExcelUtil.writeWithSheets(file) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();

Parameters:

file - .

Returns:

EasyExcelWriterFactory

writeWithSheets
```
public static EasyExcelWriterFactory writeWithSheets(String filePath)
```
多个sheet页的数据链式写入 ExcelUtil.writeWithSheets(filePath) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();

Parameters:

filePath - .

Returns:

EasyExcelWriterFactory

writeWithSheetsWeb
```
public static EasyExcelWriterFactory writeWithSheetsWeb(javax.servlet.http.HttpServletResponse response,
                                                        String exportFileName)
                                                 throws IOException
```
多个sheet页的数据链式写入（失败了会返回一个有部分数据的Excel） ExcelUtil.writeWithSheets(response, exportFileName) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();

Parameters:

response - .

exportFileName - 导出的文件名称

Returns:

.

Throws:

IOException - .

writeWithSheetsWeb

public static EasyExcelWriterFactory writeWithSheetsWeb(javax.servlet.http.HttpServletResponse response,
                                                        String exportFileName,
                                                        com.alibaba.excel.write.handler.SheetWriteHandler writeHandler)
                                                 throws IOException

多个sheet页的数据链式写入（失败了会返回一个有部分数据的Excel） ExcelUtil.writeWithSheets(response, exportFileName) .writeModel(ExcelModel.class, excelModelList, "sheetName1") .write(headData, data,"sheetName2") .finish();

Parameters:: response - .; exportFileName - 导出的文件名称; writeHandler - .
Returns:: EasyExcelWriterFactory
Throws:: IOException - .

Class EasyExcelUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EasyExcelUtil

Method Detail

syncRead

syncRead

syncRead

syncRead

syncRead

syncReadModel

syncReadModel

syncReadModel

syncReadModel

syncReadModel

asyncRead

asyncRead

asyncRead

asyncRead

asyncRead

asyncReadModel

asyncReadModel

asyncReadModel

asyncReadModel

asyncReadModel

write

write

writeTemplate

writeTemplate

write

write

write

write

writeInclude

writeExclude

writeWithSheets

writeWithSheets

writeWithSheets

writeWithSheetsWeb

writeWithSheetsWeb