package com.alibaba.excel; import java.io.File; import java.io.InputStream; import java.io.OutputStream; import java.util.ArrayList; import java.util.List; import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.event.AnalysisEventListener; import com.alibaba.excel.event.WriteHandler; import com.alibaba.excel.metadata.Sheet; import com.alibaba.excel.read.builder.ExcelReaderBuilder; import com.alibaba.excel.read.builder.ExcelReaderSheetBuilder; import com.alibaba.excel.read.listener.ReadListener; import com.alibaba.excel.support.ExcelTypeEnum; import com.alibaba.excel.write.builder.ExcelWriterBuilder; import com.alibaba.excel.write.builder.ExcelWriterSheetBuilder; import com.alibaba.excel.write.builder.ExcelWriterTableBuilder; /** * Reader and writer factory class * *

Quick start

*

Read

*

Sample1

* *

Sample2

* *

Write

* *

Sample1

* *

Sample2

* * * * @author jipengfei */ public class EasyExcelFactory { /** * Quickly read small files,no more than 10,000 lines. * * @param in * the POI filesystem that contains the Workbook stream. * @param sheet * read sheet. * @return analysis result. * @deprecated please use 'EasyExcel.read(in).sheet(sheetNo).doReadSync();' */ @Deprecated public static List read(InputStream in, Sheet sheet) { final List rows = new ArrayList(); new ExcelReader(in, null, new AnalysisEventListener() { @Override public void invoke(Object object, AnalysisContext context) { rows.add(object); } @Override public void doAfterAllAnalysed(AnalysisContext context) {} }, false).read(sheet); return rows; } /** * Parsing large file * * @param in * the POI filesystem that contains the Workbook stream. * @param sheet * read sheet. * @param listener * Callback method after each row is parsed. * @deprecated please use 'EasyExcel.read(in,head,listener).sheet(sheetNo).doRead().finish();' */ @Deprecated public static void readBySax(InputStream in, Sheet sheet, AnalysisEventListener listener) { new ExcelReader(in, null, listener).read(sheet); } /** * Get ExcelReader. * * @param in * the POI filesystem that contains the Workbook stream. * @param listener * Callback method after each row is parsed. * @return ExcelReader. * @deprecated please use {@link EasyExcel#read()} build 'ExcelReader' */ @Deprecated public static ExcelReader getReader(InputStream in, AnalysisEventListener listener) { return new ExcelReader(in, null, listener); } /** * Get ExcelWriter * * @param outputStream * the java OutputStream you wish to write the value to. * @return new ExcelWriter. * @deprecated please use {@link EasyExcel#write()} */ @Deprecated public static ExcelWriter getWriter(OutputStream outputStream) { return write().file(outputStream).autoCloseStream(Boolean.FALSE).convertAllFiled(Boolean.FALSE).build(); } /** * Get ExcelWriter * * @param outputStream * the java OutputStream you wish to write the value to. * @param typeEnum * 03 or 07 * @param needHead * Do you need to write the header to the file? * @return new ExcelWriter * @deprecated please use {@link EasyExcel#write()} */ @Deprecated public static ExcelWriter getWriter(OutputStream outputStream, ExcelTypeEnum typeEnum, boolean needHead) { return write().file(outputStream).excelType(typeEnum).needHead(needHead).autoCloseStream(Boolean.FALSE) .convertAllFiled(Boolean.FALSE).build(); } /** * Get ExcelWriter with a template file * * @param temp * Append value after a POI file , Can be null(the template POI filesystem that contains the Workbook * stream) * @param outputStream * the java OutputStream you wish to write the value to * @param typeEnum * 03 or 07 * @return new ExcelWriter * @deprecated please use {@link EasyExcel#write()} */ @Deprecated public static ExcelWriter getWriterWithTemp(InputStream temp, OutputStream outputStream, ExcelTypeEnum typeEnum, boolean needHead) { return write().withTemplate(temp).file(outputStream).excelType(typeEnum).needHead(needHead) .autoCloseStream(Boolean.FALSE).convertAllFiled(Boolean.FALSE).build(); } /** * Get ExcelWriter with a template file * * @param temp * Append value after a POI file , Can be null(the template POI filesystem that contains the Workbook * stream) * @param outputStream * the java OutputStream you wish to write the value to * @param typeEnum * 03 or 07 * @param needHead * @param handler * User-defined callback * @return new ExcelWriter * @deprecated please use {@link EasyExcel#write()} */ @Deprecated public static ExcelWriter getWriterWithTempAndHandler(InputStream temp, OutputStream outputStream, ExcelTypeEnum typeEnum, boolean needHead, WriteHandler handler) { return write().withTemplate(temp).file(outputStream).excelType(typeEnum).needHead(needHead) .registerWriteHandler(handler).autoCloseStream(Boolean.FALSE).convertAllFiled(Boolean.FALSE).build(); } /** * Build excel the write * * @return */ public static ExcelWriterBuilder write() { return new ExcelWriterBuilder(); } /** * Build excel the write * * @param file * @return */ public static ExcelWriterBuilder write(File file) { return write(file, null); } /** * Build excel the write * * @param file * @param head * @return */ public static ExcelWriterBuilder write(File file, Class head) { ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder(); excelWriterBuilder.file(file); if (head != null) { excelWriterBuilder.head(head); } return excelWriterBuilder; } /** * Build excel the write * * @param pathName * @return */ public static ExcelWriterBuilder write(String pathName) { return write(pathName, null); } /** * Build excel the write * * @param pathName * @param head * @return */ public static ExcelWriterBuilder write(String pathName, Class head) { ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder(); excelWriterBuilder.file(pathName); if (head != null) { excelWriterBuilder.head(head); } return excelWriterBuilder; } /** * Build excel the write * * @param outputStream * @return */ public static ExcelWriterBuilder write(OutputStream outputStream) { return write(outputStream, null); } /** * Build excel the write * * @param outputStream * @param head * @return */ public static ExcelWriterBuilder write(OutputStream outputStream, Class head) { ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder(); excelWriterBuilder.file(outputStream); if (head != null) { excelWriterBuilder.head(head); } return excelWriterBuilder; } /** * Build excel the 'writerSheet' * * @return */ public static ExcelWriterSheetBuilder writerSheet() { return writerSheet(null, null); } /** * Build excel the 'writerSheet' * * @param sheetNo * @return */ public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo) { return writerSheet(sheetNo, null); } /** * Build excel the 'writerSheet' * * @param sheetName * @return */ public static ExcelWriterSheetBuilder writerSheet(String sheetName) { return writerSheet(null, sheetName); } /** * Build excel the 'writerSheet' * * @param sheetNo * @param sheetName * @return */ public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo, String sheetName) { ExcelWriterSheetBuilder excelWriterSheetBuilder = new ExcelWriterSheetBuilder(); if (sheetNo != null) { excelWriterSheetBuilder.sheetNo(sheetNo); } if (sheetName != null) { excelWriterSheetBuilder.sheetName(sheetName); } return excelWriterSheetBuilder; } /** * Build excel the 'writerTable' * * @return */ public static ExcelWriterTableBuilder writerTable() { return writerTable(null); } /** * Build excel the 'writerTable' * * @param tableNo * @return */ public static ExcelWriterTableBuilder writerTable(Integer tableNo) { ExcelWriterTableBuilder excelWriterTableBuilder = new ExcelWriterTableBuilder(); if (tableNo != null) { excelWriterTableBuilder.tableNo(tableNo); } return excelWriterTableBuilder; } /** * Build excel the read * * @return */ public static ExcelReaderBuilder read() { return new ExcelReaderBuilder(); } /** * Build excel the read * * @param file * @return */ public static ExcelReaderBuilder read(File file) { return read(file, null, null); } /** * Build excel the read * * @param file * @param readListener * @return */ public static ExcelReaderBuilder read(File file, ReadListener readListener) { return read(file, null, readListener); } /** * Build excel the read * * @param file * @param head * @param readListener * @return */ public static ExcelReaderBuilder read(File file, Class head, ReadListener readListener) { ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder(); excelReaderBuilder.file(file); if (head != null) { excelReaderBuilder.head(head); } if (readListener != null) { excelReaderBuilder.registerReadListener(readListener); } return excelReaderBuilder; } /** * Build excel the read * * @param pathName * @return */ public static ExcelReaderBuilder read(String pathName) { return read(pathName, null, null); } /** * Build excel the read * * @param pathName * @param readListener * @return */ public static ExcelReaderBuilder read(String pathName, ReadListener readListener) { return read(pathName, null, readListener); } /** * Build excel the read * * @param pathName * @param head * @param readListener * @return */ public static ExcelReaderBuilder read(String pathName, Class head, ReadListener readListener) { ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder(); excelReaderBuilder.file(pathName); if (head != null) { excelReaderBuilder.head(head); } if (readListener != null) { excelReaderBuilder.registerReadListener(readListener); } return excelReaderBuilder; } /** * Build excel the read * * @param inputStream * @return */ public static ExcelReaderBuilder read(InputStream inputStream) { return read(inputStream, null, null); } /** * Build excel the read * * @param inputStream * @param readListener * @return */ public static ExcelReaderBuilder read(InputStream inputStream, ReadListener readListener) { return read(inputStream, null, readListener); } /** * Build excel the read * * @param inputStream * @param head * @param readListener * @return */ public static ExcelReaderBuilder read(InputStream inputStream, Class head, ReadListener readListener) { ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder(); excelReaderBuilder.file(inputStream); if (head != null) { excelReaderBuilder.head(head); } if (readListener != null) { excelReaderBuilder.registerReadListener(readListener); } return excelReaderBuilder; } /** * Build excel the 'readSheet' * * @return */ public static ExcelReaderSheetBuilder readSheet() { return readSheet(null, null); } /** * Build excel the 'readSheet' * * @param sheetNo * @return */ public static ExcelReaderSheetBuilder readSheet(Integer sheetNo) { return readSheet(sheetNo, null); } /** * Build excel the 'readSheet' * * @param sheetName * @return */ public static ExcelReaderSheetBuilder readSheet(String sheetName) { return readSheet(null, sheetName); } /** * Build excel the 'readSheet' * * @param sheetNo * @param sheetName * @return */ public static ExcelReaderSheetBuilder readSheet(Integer sheetNo, String sheetName) { ExcelReaderSheetBuilder excelReaderSheetBuilder = new ExcelReaderSheetBuilder(); if (sheetNo != null) { excelReaderSheetBuilder.sheetNo(sheetNo); } if (sheetName != null) { excelReaderSheetBuilder.sheetName(sheetName); } return excelReaderSheetBuilder; } }