cn.gjing.tools.excel.read.resolver.ExcelReader Maven / Gradle / Ivy
package cn.gjing.tools.excel.read.resolver;
import cn.gjing.tools.excel.Excel;
import cn.gjing.tools.excel.exception.ExcelInitException;
import cn.gjing.tools.excel.metadata.ExcelReaderResolver;
import cn.gjing.tools.excel.read.ExcelReaderContext;
import cn.gjing.tools.excel.read.listener.ExcelReadListener;
import cn.gjing.tools.excel.read.listener.ExcelResultReadListener;
import com.monitorjbl.xlsx.StreamingReader;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.Workbook;
import java.io.IOException;
import java.util.List;
import java.util.function.Supplier;
/**
* Excel reader
*
* @author Gjing
**/
public class ExcelReader {
private ExcelReaderContext context;
private ExcelReaderResolver readerResolver;
private final String defaultSheetName = "Sheet1";
private ExcelReader() {
}
public ExcelReader(ExcelReaderContext context, Excel excel) {
this.context = context;
this.chooseResolver(excel);
}
/**
* Choose excel read resolver
*
* @param excel Excel annotation of Excel entity
*/
private void chooseResolver(Excel excel) {
switch (excel.type()) {
case XLS:
try {
this.context.setWorkbook(new HSSFWorkbook(this.context.getInputStream()));
} catch (IOException e) {
throw new ExcelInitException("Init workbook error, " + e.getMessage());
}
break;
case XLSX:
Workbook workbook = StreamingReader.builder()
.rowCacheSize(excel.cacheRowSize())
.bufferSize(excel.bufferSize())
.open(this.context.getInputStream());
this.context.setWorkbook(workbook);
break;
default:
throw new ExcelInitException("No corresponding resolver was found");
}
this.readerResolver = new ReadExecutor<>();
this.readerResolver.init(this.context);
}
/**
* Read excel
*
* @return this
*/
public ExcelReader read() {
this.readerResolver.read(0, this.defaultSheetName);
return this;
}
/**
* Read the specified sheet
*
* @param sheetName sheet name
* @return this
*/
public ExcelReader read(String sheetName) {
this.readerResolver.read(0, sheetName);
return this;
}
/**
* Specifies that the Excel subscript to start reading.
* This line must be a real subscript,
*
* @param headerIndex subscript is evaluated from 0
* @return this
*/
public ExcelReader read(int headerIndex) {
this.readerResolver.read(headerIndex, this.defaultSheetName);
return this;
}
/**
* Read the specified sheet
*
* @param headerIndex Excel header starter index
* @param sheetName Excel Sheet name
* @return this
*/
public ExcelReader read(int headerIndex, String sheetName) {
this.readerResolver.read(headerIndex, sheetName);
return this;
}
/**
* Reset the resolver before you start reading the file
*
* @param excelReaderResolver Excel read resolver
* @return this
*/
public ExcelReader resetResolver(Supplier> excelReaderResolver) {
this.readerResolver = excelReaderResolver.get();
this.readerResolver.init(this.context);
return this;
}
/**
* Add readListeners
*
* @param readListenerList Read listeners
* @return this
*/
public ExcelReader addListener(List readListenerList) {
if (readListenerList != null) {
readListenerList.forEach(this.context::addListener);
}
return this;
}
/**
* Add readListeners
*
* @param readListener Read listener
* @return this
*/
public ExcelReader addListener(ExcelReadListener readListener) {
if (readListener != null) {
this.context.addListener(readListener);
}
return this;
}
/**
* Subscribe to the data after the import is complete
*
* @param excelResultReadListener resultReadListener
* @return this
*/
public ExcelReader subscribe(ExcelResultReadListener excelResultReadListener) {
this.context.setResultReadListener(excelResultReadListener);
return this;
}
/**
* Whether is need meta info(Such as header,title)
*
* @param need Read meta info
* @param checkTemplate Check that the excel template matches the entity
* @return this
*/
@Deprecated
public ExcelReader metaInfo(boolean need, boolean checkTemplate) {
this.context.setMetaInfo(need);
this.context.setCheckTemplate(checkTemplate);
return this;
}
/**
* Whether is need meta info(Such as header,title)
*
* @param need Read meta info
* @return this
*/
public ExcelReader metaInfo(boolean need) {
this.context.setMetaInfo(need);
return this;
}
/**
* Whether to check whether the Excel template matches when importing
*
* @param checkTemplate Check that the excel template matches the entity
* @return this
*/
public ExcelReader check(boolean checkTemplate) {
this.context.setCheckTemplate(checkTemplate);
return this;
}
/**
* The Excel read data end，please use finish method
*/
@Deprecated
public void end() {
this.finish();
}
/**
* The Excel read data end
*/
public void finish() {
try {
if (this.context.getInputStream() != null) {
this.context.getInputStream().close();
}
if (this.context.getWorkbook() != null) {
this.context.getWorkbook().close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}