Operation API

操作类索引

• com.github.liaochong.myexcel.core.DefaultExcelReader
• com.github.liaochong.myexcel.core.DefaultExcelBuilder
• com.github.liaochong.myexcel.core.DefaultStreamExcelBuilder
• com.github.liaochong.myexcel.core.FreemarkerExcelBuilder
• com.github.liaochong.myexcel.core.BeetlExcelBuilder
• com.github.liaochong.myexcel.core.GroovyExcelBuilder
• com.github.liaochong.myexcel.core.HtmlToExcelFactory（核心类）
• com.github.liaochong.myexcel.core.HtmlToExcelStreamFactory（核心类，暂未开放）
• com.github.liaochong.myexcel.utils.AttachmentExportUtil（附件形式导出工具）
• com.github.liaochong.myexcel.utils.FileExportUtil（文件形式导出工具）

操作类：com.github.liaochong.myexcel.core.DefaultExcelReader

方法签名（Method）	描述（Desc）
static DefaultExcelReader of(Class<?> dataType)	根据需要操作的数据类型获取该类的实例对象，所有操作基于该实例对象
DefaultExcelReader sheet(int index)	设置需要导入的sheet索引，默认为0，即第一个sheet
DefaultExcelReader rowFilter(Predicate rowFilter)	行过滤器，只导出符合rowFilter的行
DefaultExcelReader parallelRead()	设置是否并行读取
List read(@NonNull InputStream fileInputStream) throws Exception	读取文件流
List read(@NonNull InputStream fileInputStream, String password) throws Exception	使用密码读取文件流
List read(@NonNull File file) throws Exception	读取文件
List read(@NonNull File file, String password) throws Exception	使用密码读取文件

操作类：com.github.liaochong.myexcel.core.DefaultExcelBuilder

方法签名（Method）	描述（Desc）
static DefaultExcelBuilder of(Class<?> dataType)	根据需要操作的数据类型获取该类的实例对象，所有操作基于该实例对象
static DefaultExcelBuilder getInstance()	已过期，请使用of方法代替，获取该类的实例对象，所有操作基于该实例对象
DefaultExcelBuilder sheetName(String sheetName)	设置导出的excel的sheet名称，建议在注解@ExcelTable中设置
DefaultExcelBuilder titles(List titles)	设置excel导出的对应的列标题，建议使用注解@ExcelColumn设置
DefaultExcelBuilder fieldDisplayOrder(List fieldDisplayOrder)	设置excel导出的对应的字段，其中包含展示顺序，建议使用注解设置
DefaultExcelBuilder workbookType(WorkbookType workbookType)	设置导出的excel的格式，如XLS（.xls）、XLSX（.xlsx）、SXLSX（.xlsx），其中SXLSX（.xlsx）表明采用低内存占用方式生成excel，海量数据导出时建议采用该方式
DefaultExcelBuilder rowAccessWindowSize(int rowAccessWindowSize)	该方法只在workbookType设置为SXLSX生效，设置允许内存中最大保存行数，降低poi的使用内存
Workbook build(List<?> data)	根据指定的数据列表生成最终的workbook

操作类：com.github.liaochong.myexcel.core.DefaultStreamExcelBuilder

方法签名（Method）	描述（Desc）
static DefaultStreamExcelBuilder of(Class<?> dataType)	根据需要操作的数据类型获取该类的实例对象，所有操作基于该实例对象
DefaultStreamExcelBuilder sheetName(String sheetName)	设置导出的excel的sheet名称，建议在注解@ExcelTable中设置
DefaultStreamExcelBuilder titles(List titles)	设置excel导出的对应的列标题，建议使用注解@ExcelColumn设置
DefaultStreamExcelBuilder fieldDisplayOrder(List fieldDisplayOrder)	设置excel导出的对应的字段，其中包含展示顺序
DefaultStreamExcelBuilder threadPool(ExecutorService executorService)	设置采用的线程池，如不设置，则不采用线程池
DefaultStreamExcelBuilder workbookType(WorkbookType workbookType)	设置导出的excel的格式，如XLS（.xls）、XLSX（.xlsx）、SXLSX（.xlsx），其中SXLSX（.xlsx）表明采用低内存占用方式生成excel，默认采用该方式
DefaultStreamExcelBuilder rowAccessWindowSize(int rowAccessWindowSize)	该方法只在workbookType设置为SXLSX生效，设置允许内存中最大保存行数，降低poi的使用内存
DefaultStreamExcelBuilder start(Class<?>... groups)	开始构建标志，用于启动生产者消费者模式，默认使用ArrayBlockingQueue，长度为处理器核心数目，其中groups代表需要导出的字段分组
DefaultStreamExcelBuilder start(int waitQueueSize, Class<?>... groups)	开始构建标志，用于启动生产者消费者模式，默认使用ArrayBlockingQueue，需要自定义使用的阻塞队列长度，其中groups代表需要导出的字段分组
void append(List<?> data)	追加数据方法，实现批次导出数据的关键
Workbook build()	最终构建，调用该方法后不允许再次追加数据，否则会报错
Workbook build(List<?> data)	根据指定的数据列表生成最终的workbook

操作类：com.github.liaochong.myexcel.core.FreemarkerExcelBuilder

方法签名（Method）	描述（Desc）
ExcelBuilder template(String path)	设置html模板路径
ExcelBuilder rowAccessWindowSize(int rowAccessWindowSize)	设置当生成模式为SXSSF模式时，内存中保留的行数，请务必在设置workbookType之前设置，否则不生效，此时将采用默认配置-100行
ExcelBuilder workbookType(WorkbookType workbookType)	设定导出的excel的文件类型，如.xls
ExcelBuilder useDefaultStyle()	使用工具包定义的单元格样式，此时自定义的样式将无效
ExcelBuilder freezePanes(FreezePane... freezePanes)	窗口冻结，即哪些行、列被冻结，序号从1开始
Workbook build()	开始构建Workbook

操作类：com.github.liaochong.myexcel.core.BeetlExcelBuilder

方法签名（Method）	描述（Desc）
ExcelBuilder template(String path)	设置html模板路径
ExcelBuilder rowAccessWindowSize(int rowAccessWindowSize)	设置当生成模式为SXSSF模式时，内存中保留的行数，请务必在设置workbookType之前设置，否则不生效，此时将采用默认配置-100行
ExcelBuilder workbookType(WorkbookType workbookType)	设定导出的excel的文件类型，如.xls
ExcelBuilder useDefaultStyle()	使用工具包定义的单元格样式，此时自定义的样式将无效
ExcelBuilder freezePanes(FreezePane... freezePanes)	窗口冻结，即哪些行、列被冻结，序号从1开始
Workbook build()	开始构建Workbook

操作类：com.github.liaochong.myexcel.core.GroovyExcelBuilder

方法签名（Method）	描述（Desc）
ExcelBuilder template(String path)	设置html模板路径
ExcelBuilder rowAccessWindowSize(int rowAccessWindowSize)	设置当生成模式为SXSSF模式时，内存中保留的行数，请务必在设置workbookType之前设置，否则不生效，此时将采用默认配置-100行
ExcelBuilder workbookType(WorkbookType workbookType)	设定导出的excel的文件类型，如.xls
ExcelBuilder useDefaultStyle()	使用工具包定义的单元格样式，此时自定义的样式将无效
ExcelBuilder freezePanes(FreezePane... freezePanes)	窗口冻结，即哪些行、列被冻结，序号从1开始
Workbook build()	开始构建Workbook

操作类：com.github.liaochong.myexcel.core.HtmlToExcelFactory

方法签名（Method）	描述（Desc）
static HtmlToExcelFactory readHtml(File htmlFile) throws Exception	读取Html文件
static HtmlToExcelFactory readHtml(String html)	读取字符串形式Html内容
static HtmlToExcelFactory readHtml(File htmlFile, HtmlToExcelFactory htmlToExcelFactory) throws Exception	指定htmlToExcelFactory读取Html文件
ExcelFactory rowAccessWindowSize(int rowAccessWindowSize)	设置当生成模式为SXSSF模式时，内存中保留的行数，请务必在设置workbookType之前设置，否则不生效，此时将采用默认配置-100行
ExcelFactory workbookType(WorkbookType workbookType)	设定导出的excel的文件类型，如.xls
ExcelFactory useDefaultStyle()	使用工具包定义的单元格样式，此时自定义的样式将无效
ExcelFactory freezePanes(FreezePane... freezePanes)	窗口冻结，即哪些行、列被冻结，序号从1开始
Workbook build()	根据Html内容以及其他设置构建Excel

操作类：com.github.liaochong.myexcel.utils.AttachmentExportUtil

方法签名（Method）	描述（Desc）
static void export(Workbook workbook, String fileName, HttpServletResponse response) throws IOException	以附件形式导出Excel，其中 fileName 为导出后的文件名称，建议不要携带文件后缀名，代码会根据工作簿类型自动添加，以防止设置错误

操作类：com.github.liaochong.myexcel.utils.FileExportUtil

方法签名（Method）	描述（Desc）
static void export(Workbook workbook, File file) throws IOException	导出Excel到某个文件中，无需后缀名，代码会根据工作簿类型自动添加，以防止设置错误