cn.hutool.poi.excel

类 ExcelReader

java.lang.Object

cn.hutool.poi.excel.ExcelBase<ExcelReader>

cn.hutool.poi.excel.ExcelReader

所有已实现的接口:

Closeable, AutoCloseable

public class ExcelReader
extends ExcelBase<ExcelReader>

Excel读取器
读取Excel工作簿

从以下版本开始:

3.1.0

作者:

Looly

字段概要

从类继承的字段 cn.hutool.poi.excel.ExcelBase

isClosed, sheet, workbook

构造器概要

构造器

构造器和说明
ExcelReader(File bookFile, int sheetIndex) 构造
ExcelReader(File bookFile, String sheetName) 构造
ExcelReader(InputStream bookStream, int sheetIndex, boolean closeAfterRead) 构造
ExcelReader(InputStream bookStream, String sheetName, boolean closeAfterRead) 构造
ExcelReader(org.apache.poi.ss.usermodel.Sheet sheet) 构造
ExcelReader(String excelFilePath, int sheetIndex) 构造
ExcelReader(org.apache.poi.ss.usermodel.Workbook book, int sheetIndex) 构造
ExcelReader(org.apache.poi.ss.usermodel.Workbook book, String sheetName) 构造

方法概要

方法

限定符和类型	方法和说明
ExcelReader	addHeaderAlias(String header, String alias) 增加标题别名
org.apache.poi.ss.extractor.ExcelExtractor	getExtractor() 获取 ExcelExtractor 对象
Map<String,String>	getHeaderAlias() 获得标题行的别名Map
ExcelWriter	getWriter() 获取Excel写出器 在读取Excel并做一定编辑后，获取写出器写出
boolean	isIgnoreEmptyRow() 是否忽略空行
List<List<Object>>	read() 读取工作簿中指定的Sheet的所有行列数据
List<List<Object>>	read(int startRowIndex) 读取工作簿中指定的Sheet
List<List<Object>>	read(int startRowIndex, int endRowIndex) 读取工作簿中指定的Sheet
<T> List<T>	read(int headerRowIndex, int startRowIndex, Class<T> beanType) 读取Excel为Bean的列表
List<Map<String,Object>>	read(int headerRowIndex, int startRowIndex, int endRowIndex) 读取Excel为Map的列表 Map表示一行，标题为key，单元格内容为value
<T> List<T>	read(int headerRowIndex, int startRowIndex, int endRowIndex, Class<T> beanType) 读取Excel为Bean的列表
List<Map<String,Object>>	readAll() 读取Excel为Map的列表，读取所有行，默认第一行做为标题，数据从第二行开始 Map表示一行，标题为key，单元格内容为value
<T> List<T>	readAll(Class<T> beanType) 读取Excel为Bean的列表，读取所有行，默认第一行做为标题，数据从第二行开始
String	readAsText(boolean withSheetName) 读取为文本格式 使用ExcelExtractor 提取Excel内容
Object	readCellValue(int x, int y) 读取某个单元格的值
List<Object>	readRow(int rowIndex) 读取某一行数据
ExcelReader	removeHeaderAlias(String header) 去除标题别名
ExcelReader	setCellEditor(CellEditor cellEditor) 设置单元格值处理逻辑 当Excel中的值并不能满足我们的读取要求时，通过传入一个编辑接口，可以对单元格值自定义，例如对数字和日期类型值转换为字符串等
ExcelReader	setHeaderAlias(Map<String,String> headerAlias) 设置标题行的别名Map
ExcelReader	setIgnoreEmptyRow(boolean ignoreEmptyRow) 设置是否忽略空行

从类继承的方法 cn.hutool.poi.excel.ExcelBase

close, getCell, getCell, getColumnCount, getColumnCount, getOrCreateCell, getOrCreateCellStyle, getOrCreateColumnStyle, getOrCreateRow, getOrCreateRowStyle, getPhysicalRowCount, getRowCount, getSheet, getSheetCount, getSheetNames, getSheets, getWorkbook, setSheet, setSheet

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ExcelReader

public ExcelReader(String excelFilePath,
           int sheetIndex)

构造

参数:

excelFilePath - Excel文件路径，绝对路径或相对于ClassPath路径

sheetIndex - sheet序号，0表示第一个sheet

ExcelReader

public ExcelReader(File bookFile,
           int sheetIndex)

构造

参数:

bookFile - Excel文件

sheetIndex - sheet序号，0表示第一个sheet

ExcelReader

public ExcelReader(File bookFile,
           String sheetName)

构造

参数:

bookFile - Excel文件

sheetName - sheet名，第一个默认是sheet1

ExcelReader

public ExcelReader(InputStream bookStream,
           int sheetIndex,
           boolean closeAfterRead)

构造

参数:

bookStream - Excel文件的流

sheetIndex - sheet序号，0表示第一个sheet

closeAfterRead - 读取结束是否关闭流

ExcelReader

public ExcelReader(InputStream bookStream,
           String sheetName,
           boolean closeAfterRead)

构造

参数:

bookStream - Excel文件的流

sheetName - sheet名，第一个默认是sheet1

closeAfterRead - 读取结束是否关闭流

ExcelReader

public ExcelReader(org.apache.poi.ss.usermodel.Workbook book,
           int sheetIndex)

构造

参数:

book - Workbook 表示一个Excel文件

sheetIndex - sheet序号，0表示第一个sheet

ExcelReader

public ExcelReader(org.apache.poi.ss.usermodel.Workbook book,
           String sheetName)

构造

参数:

book - Workbook 表示一个Excel文件

sheetName - sheet名，第一个默认是sheet1

ExcelReader

public ExcelReader(org.apache.poi.ss.usermodel.Sheet sheet)

构造

参数:

sheet - Excel中的sheet

方法详细资料

isIgnoreEmptyRow

public boolean isIgnoreEmptyRow()

是否忽略空行

返回:

是否忽略空行

setIgnoreEmptyRow

public ExcelReader setIgnoreEmptyRow(boolean ignoreEmptyRow)

设置是否忽略空行

参数:

ignoreEmptyRow - 是否忽略空行

返回:

this

setCellEditor

public ExcelReader setCellEditor(CellEditor cellEditor)

设置单元格值处理逻辑
当Excel中的值并不能满足我们的读取要求时，通过传入一个编辑接口，可以对单元格值自定义，例如对数字和日期类型值转换为字符串等

参数:

cellEditor - 单元格值处理接口

返回:

this

另请参阅:

TrimEditor

getHeaderAlias

public Map<String,String> getHeaderAlias()

获得标题行的别名Map

返回:

别名Map

setHeaderAlias

public ExcelReader setHeaderAlias(Map<String,String> headerAlias)

设置标题行的别名Map

参数:

headerAlias - 别名Map

返回:

this

addHeaderAlias

public ExcelReader addHeaderAlias(String header,
                         String alias)

增加标题别名

参数:

header - 标题

alias - 别名

返回:

this

removeHeaderAlias

public ExcelReader removeHeaderAlias(String header)

去除标题别名

参数:

header - 标题

返回:

this

read

public List<List<Object>> read()

读取工作簿中指定的Sheet的所有行列数据

返回:

行的集合，一行使用List表示

read

public List<List<Object>> read(int startRowIndex)

读取工作簿中指定的Sheet

参数:

startRowIndex - 起始行（包含，从0开始计数）

返回:

行的集合，一行使用List表示

从以下版本开始:

4.0.0

read

public List<List<Object>> read(int startRowIndex,
                      int endRowIndex)

读取工作簿中指定的Sheet

参数:

startRowIndex - 起始行（包含，从0开始计数）

endRowIndex - 结束行（包含，从0开始计数）

返回:

行的集合，一行使用List表示

readAll

public List<Map<String,Object>> readAll()

读取Excel为Map的列表，读取所有行，默认第一行做为标题，数据从第二行开始
Map表示一行，标题为key，单元格内容为value

返回:

Map的列表

read

public List<Map<String,Object>> read(int headerRowIndex,
                            int startRowIndex,
                            int endRowIndex)

读取Excel为Map的列表
Map表示一行，标题为key，单元格内容为value

参数:

headerRowIndex - 标题所在行，如果标题行在读取的内容行中间，这行做为数据将忽略

startRowIndex - 起始行（包含，从0开始计数）

endRowIndex - 读取结束行（包含，从0开始计数）

返回:

Map的列表

readAll

public <T> List<T> readAll(Class<T> beanType)

读取Excel为Bean的列表，读取所有行，默认第一行做为标题，数据从第二行开始

类型参数:

T - Bean类型

参数:

beanType - 每行对应Bean的类型

返回:

Map的列表

read

public <T> List<T> read(int headerRowIndex,
               int startRowIndex,
               Class<T> beanType)

读取Excel为Bean的列表

类型参数:

T - Bean类型

参数:

headerRowIndex - 标题所在行，如果标题行在读取的内容行中间，这行做为数据将忽略，，从0开始计数

startRowIndex - 起始行（包含，从0开始计数）

beanType - 每行对应Bean的类型

返回:

Map的列表

从以下版本开始:

4.0.1

read

public <T> List<T> read(int headerRowIndex,
               int startRowIndex,
               int endRowIndex,
               Class<T> beanType)

读取Excel为Bean的列表

类型参数:

T - Bean类型

参数:

headerRowIndex - 标题所在行，如果标题行在读取的内容行中间，这行做为数据将忽略，，从0开始计数

startRowIndex - 起始行（包含，从0开始计数）

endRowIndex - 读取结束行（包含，从0开始计数）

beanType - 每行对应Bean的类型

返回:

Map的列表

readAsText

public String readAsText(boolean withSheetName)

读取为文本格式
使用ExcelExtractor 提取Excel内容

参数:

withSheetName - 是否附带sheet名

返回:

Excel文本

从以下版本开始:

4.1.0

getExtractor

public org.apache.poi.ss.extractor.ExcelExtractor getExtractor()

获取 ExcelExtractor 对象

返回:

ExcelExtractor

从以下版本开始:

4.1.0

readRow

public List<Object> readRow(int rowIndex)

读取某一行数据

参数:

rowIndex - 行号，从0开始

返回:

一行数据

从以下版本开始:

4.0.3

readCellValue

public Object readCellValue(int x,
                   int y)

读取某个单元格的值

参数:

x - X坐标，从0计数，既列号

y - Y坐标，从0计数，既行号

返回:

值，如果单元格无值返回null

从以下版本开始:

4.0.3

getWriter

public ExcelWriter getWriter()

获取Excel写出器
在读取Excel并做一定编辑后，获取写出器写出

返回:

ExcelWriter

从以下版本开始:

4.0.6