com.xiaoleilu.hutool.poi.excel.ExcelReader Maven / Gradle / Ivy
package com.xiaoleilu.hutool.poi.excel;
import java.io.Closeable;
import java.io.File;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import com.xiaoleilu.hutool.bean.BeanUtil;
import com.xiaoleilu.hutool.collection.CollUtil;
import com.xiaoleilu.hutool.collection.IterUtil;
import com.xiaoleilu.hutool.io.IoUtil;
import com.xiaoleilu.hutool.lang.Assert;
import com.xiaoleilu.hutool.poi.excel.editors.TrimEditor;
import com.xiaoleilu.hutool.util.StrUtil;
/**
* Excel读取器
* 读取Excel工作簿
*
* @author Looly
* @since 3.1.0
*/
public class ExcelReader implements Closeable{
/** 是否被关闭 */
private boolean isClosed;
/** 工作簿 */
private Workbook workbook;
/** Excel中对应的Sheet */
private Sheet sheet;
/** 是否忽略空行 */
private boolean ignoreEmptyRow = true;
/** 单元格值处理接口 */
private CellEditor cellEditor;
/** 标题别名 */
private Map headerAlias = new HashMap<>();
// ------------------------------------------------------------------------------------------------------- Constructor start
/**
* 构造
*
* @param excelFilePath Excel文件路径,绝对路径或相对于ClassPath路径
* @param sheetIndex sheet序号,0表示第一个sheet
*/
public ExcelReader(String excelFilePath, int sheetIndex) {
this(ExcelUtil.loadBook(excelFilePath), sheetIndex);
}
/**
* 构造
*
* @param bookFile Excel文件
* @param sheetIndex sheet序号,0表示第一个sheet
*/
public ExcelReader(File bookFile, int sheetIndex) {
this(ExcelUtil.loadBook(bookFile), sheetIndex);
}
/**
* 构造
*
* @param bookFile Excel文件
* @param sheetName sheet名,第一个默认是sheet1
*/
public ExcelReader(File bookFile, String sheetName) {
this(ExcelUtil.loadBook(bookFile), sheetName);
}
/**
* 构造
*
* @param bookStream Excel文件的流
* @param sheetIndex sheet序号,0表示第一个sheet
*/
public ExcelReader(InputStream bookStream, int sheetIndex) {
this(ExcelUtil.loadBook(bookStream), sheetIndex);
}
/**
* 构造
*
* @param bookStream Excel文件的流
* @param sheetName sheet名,第一个默认是sheet1
*/
public ExcelReader(InputStream bookStream, String sheetName) {
this(ExcelUtil.loadBook(bookStream), sheetName);
}
/**
* 构造
*
* @param book {@link Workbook} 表示一个Excel文件
* @param sheetIndex sheet序号,0表示第一个sheet
*/
public ExcelReader(Workbook book, int sheetIndex) {
this(book.getSheetAt(sheetIndex));
}
/**
* 构造
*
* @param book {@link Workbook} 表示一个Excel文件
* @param sheetName sheet名,第一个默认是sheet1
*/
public ExcelReader(Workbook book, String sheetName) {
this(book.getSheet(sheetName));
this.workbook = book;
}
/**
* 构造
*
* @param sheet Excel中的sheet
*/
public ExcelReader(Sheet sheet) {
this.sheet = sheet;
}
// ------------------------------------------------------------------------------------------------------- Constructor end
// ------------------------------------------------------------------------------------------------------- Getters and Setters start
/**
* 是否忽略空行
*
* @return 是否忽略空行
*/
public boolean isIgnoreEmptyRow() {
return ignoreEmptyRow;
}
/**
* 设置是否忽略空行
*
* @param ignoreEmptyRow 是否忽略空行
* @return this
*/
public ExcelReader setIgnoreEmptyRow(boolean ignoreEmptyRow) {
this.ignoreEmptyRow = ignoreEmptyRow;
return this;
}
/**
* 设置单元格值处理逻辑
* 当Excel中的值并不能满足我们的读取要求时,通过传入一个编辑接口,可以对单元格值自定义,例如对数字和日期类型值转换为字符串等
*
* @param cellEditor 单元格值处理接口
* @return this
* @see TrimEditor
*/
public ExcelReader setCellEditor(CellEditor cellEditor) {
this.cellEditor = cellEditor;
return this;
}
/**
* 获得标题行的别名Map
*
* @return 别名Map
*/
public Map getHeaderAlias() {
return headerAlias;
}
/**
* 设置标题行的别名Map
*
* @param headerAlias 别名Map
* @return this
*/
public ExcelReader setHeaderAlias(Map headerAlias) {
this.headerAlias = headerAlias;
return this;
}
/**
* 增加标题别名
*
* @param header 标题
* @param alias 别名
* @return this
*/
public ExcelReader addHeaderAlias(String header, String alias) {
this.headerAlias.put(header, alias);
return this;
}
/**
* 去除标题别名
*
* @param header 标题
* @return this
*/
public ExcelReader removeHeaderAlias(String header) {
this.headerAlias.remove(header);
return this;
}
// ------------------------------------------------------------------------------------------------------- Getters and Setters end
/**
* 读取工作簿中指定的Sheet的所有行列数据
*
* @return 行的集合,一行使用List表示
*/
public List> read() {
return read(0, Integer.MAX_VALUE);
}
/**
* 读取工作簿中指定的Sheet
*
* @param startRowIndex 起始行(包含,从0开始计数)
* @param endRowIndex 结束行(包含,从0开始计数)
* @return 行的集合,一行使用List表示
*/
public List> read(int startRowIndex, int endRowIndex) {
Assert.isFalse(this.isClosed, "ExcelReader has been closed!");
List> resultList = new ArrayList<>();
startRowIndex = Math.max(startRowIndex, sheet.getFirstRowNum());// 读取起始行(包含)
endRowIndex = Math.min(endRowIndex, sheet.getLastRowNum());// 读取结束行(包含)
List
© 2015 - 2024 Weber Informatics LLC | Privacy Policy