com.github.crab2died

类 ExcelUtils

java.lang.Object

com.github.crab2died.ExcelUtils

public final class ExcelUtils
extends Object

Excel4J的主要操作工具类

主要包含6大操作类型,并且每个类型都配有一个私有handler：
1.读取Excel操作基于注解映射,handler为readExcel2ObjectsHandler(org.apache.poi.ss.usermodel.Workbook, java.lang.Class<T>, int, int, int)
2.读取Excel操作无映射,handler为readExcel2ObjectsHandler(org.apache.poi.ss.usermodel.Workbook, java.lang.Class<T>, int, int, int)
3.基于模板、注解导出Excel,handler为exportExcelByModuleHandler(java.lang.String, int, java.util.List<?>, java.util.Map<java.lang.String, java.lang.String>, java.lang.Class, boolean)
4.基于模板、注解导出Map数据,handler为exportExcelByModuleHandler(java.lang.String, int, java.util.List<?>, java.util.Map<java.lang.String, java.lang.String>, java.lang.Class, boolean)
5.无模板基于注解导出,handler为exportExcelByMapHandler(java.lang.String, int, java.util.Map<java.lang.String, java.util.List<?>>, java.util.Map<java.lang.String, java.lang.String>, java.lang.Class, boolean)
6.无模板无注解导出,handler为exportExcelBySimpleHandler(java.util.List<?>, java.util.List<java.lang.String>, java.lang.String, boolean)
7.读取CSV操作基于注解,handler为readCSVByMapHandler(java.io.InputStream, java.lang.Class<T>) 8.基于注解导出CSV, handler为exportCSVByMapHandler(java.util.List<?>, java.lang.Class, boolean, java.lang.Appendable)

另外列举了部分常用的参数格式的方法(不同参数的排列组合实在是太多,没必要完全列出) 如遇没有自己需要的参数类型的方法,可通过最全的方法来自行变换

详细用法请关注: https://gitee.com/Crab2Died/Excel4J

作者:

Crab2Died

方法概要

限定符和类型	方法和说明
void	exportMap2Excel(String templatePath, int sheetIndex, Map<String,List<?>> data, Map<String,String> extendMap, Class clazz, boolean isWriteHeader, OutputStream os) 基于模板、注解导出Map[String, List[?]]
void	exportMap2Excel(String templatePath, int sheetIndex, Map<String,List<?>> data, Map<String,String> extendMap, Class clazz, boolean isWriteHeader, String targetPath) 基于模板、注解导出Map[String, List[?]]
void	exportMap2Excel(String templatePath, Map<String,List<?>> data, Class clazz, OutputStream os) 基于模板、注解导出Map[String, List[?]]
void	exportMap2Excel(String templatePath, Map<String,List<?>> data, Class clazz, String targetPath) 基于模板、注解导出Map[String, List[?]]
void	exportMap2Excel(String templatePath, Map<String,List<?>> data, Map<String,String> extendMap, Class clazz, OutputStream os) 基于模板、注解导出Map[String, List[?]]
void	exportMap2Excel(String templatePath, Map<String,List<?>> data, Map<String,String> extendMap, Class clazz, String targetPath) 基于模板、注解导出Map[String, List[?]]
void	exportObjects2CSV(List<?> data, Class clazz, boolean isWriteHeader, OutputStream os) 基于注解导出CSV文件流
void	exportObjects2CSV(List<?> data, Class clazz, boolean isWriteHeader, String path) 基于注解导出CSV文件
void	exportObjects2CSV(List<?> data, Class clazz, OutputStream os) 基于注解导出CSV文件流
void	exportObjects2CSV(List<?> data, Class clazz, String path) 基于注解导出CSV文件
void	exportObjects2Excel(List<?> data, Class clazz, boolean isWriteHeader, OutputStream os) 无模板、基于注解的数据导出
void	exportObjects2Excel(List<?> data, Class clazz, boolean isWriteHeader, String targetPath) 无模板、基于注解的数据导出
void	exportObjects2Excel(List<?> data, Class clazz, boolean isWriteHeader, String sheetName, boolean isXSSF, OutputStream os) 无模板、基于注解的数据导出
void	exportObjects2Excel(List<?> data, Class clazz, boolean isWriteHeader, String sheetName, boolean isXSSF, String targetPath) 无模板、基于注解的数据导出
void	exportObjects2Excel(List<?> data, Class clazz, OutputStream os) 无模板、基于注解的数据导出
void	exportObjects2Excel(List<?> data, Class clazz, String targetPath) 无模板、基于注解的数据导出
void	exportObjects2Excel(List<?> data, List<String> header, OutputStream os) 无模板、无注解的数据(形如List[?]
void	exportObjects2Excel(List<?> data, List<String> header, String targetPath) 无模板、无注解的数据(形如List[?]
void	exportObjects2Excel(List<?> data, List<String> header, String sheetName, boolean isXSSF, OutputStream os) 无模板、无注解的数据(形如List[?]
void	exportObjects2Excel(List<?> data, List<String> header, String sheetName, boolean isXSSF, String targetPath) 无模板、无注解的数据(形如List[?]
void	exportObjects2Excel(List<?> data, OutputStream os) 无模板、无注解的数据(形如List[?]
void	exportObjects2Excel(List<?> data, String targetPath) 无模板、无注解的数据(形如List[?]
void	exportObjects2Excel(String templatePath, int sheetIndex, List<?> data, Map<String,String> extendMap, Class clazz, boolean isWriteHeader, OutputStream os) 基于Excel模板与注解ExcelField导出Excel
void	exportObjects2Excel(String templatePath, int sheetIndex, List<?> data, Map<String,String> extendMap, Class clazz, boolean isWriteHeader, String targetPath) 基于Excel模板与注解ExcelField导出Excel
void	exportObjects2Excel(String templatePath, List<?> data, Class clazz, OutputStream os) 基于Excel模板与注解ExcelField导出Excel
void	exportObjects2Excel(String templatePath, List<?> data, Class clazz, String targetPath) 基于Excel模板与注解ExcelField导出Excel
void	exportObjects2Excel(String templatePath, List<?> data, Map<String,String> extendMap, Class clazz, boolean isWriteHeader, OutputStream os) 基于Excel模板与注解ExcelField导出Excel
void	exportObjects2Excel(String templatePath, List<?> data, Map<String,String> extendMap, Class clazz, boolean isWriteHeader, String targetPath) 基于Excel模板与注解ExcelField导出Excel
void	exportObjects2Excel(String templatePath, List<?> data, Map<String,String> extendMap, Class clazz, OutputStream os) 基于Excel模板与注解ExcelField导出Excel
void	exportObjects2Excel(String templatePath, List<?> data, Map<String,String> extendMap, Class clazz, String targetPath) 基于Excel模板与注解ExcelField导出Excel
static ExcelUtils	getInstance() 双检锁保证单例
void	mapSheet2Excel(List<MapSheetWrapper> sheetWrappers, String templatePath, OutputStream os) 基于模板、注解的多sheet导出Map[String, List[?]]
void	mapSheet2Excel(List<MapSheetWrapper> sheetWrappers, String templatePath, String targetPath) 基于模板、注解的多sheet导出Map[String, List[?]]
void	normalSheet2Excel(List<NormalSheetWrapper> sheetWrappers, String templatePath, OutputStream os) 基于Excel模板与注解ExcelField导出多sheet的Excel
void	normalSheet2Excel(List<NormalSheetWrapper> sheetWrappers, String templatePath, String targetPath) 基于Excel模板与注解ExcelField导出多sheet的Excel
void	noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets, boolean isXSSF, OutputStream os) 无模板、基于注解、多sheet数据
void	noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets, boolean isXSSF, String targetPath) 无模板、基于注解、多sheet数据
void	noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets, OutputStream os) 无模板、基于注解、多sheet数据
void	noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets, String targetPath) 无模板、基于注解、多sheet数据
<T> List<T>	readCSV2Objects(InputStream is, Class<T> clazz) 基于注解读取CSV文件
<T> List<T>	readCSV2Objects(String path, Class<T> clazz) 基于注解读取CSV文件
List<List<String>>	readExcel2List(InputStream is) 读取Excel表格数据,返回List[List[String]]类型的数据集合
List<List<String>>	readExcel2List(InputStream is, int offsetLine) 读取Excel表格数据,返回List[List[String]]类型的数据集合
List<List<String>>	readExcel2List(InputStream is, int offsetLine, int limitLine, int sheetIndex) 读取Excel表格数据,返回List[List[String]]类型的数据集合
List<List<String>>	readExcel2List(String excelPath) 读取Excel表格数据,返回List[List[String]]类型的数据集合
List<List<String>>	readExcel2List(String excelPath, int offsetLine) 读取Excel表格数据,返回List[List[String]]类型的数据集合
List<List<String>>	readExcel2List(String excelPath, int offsetLine, int limitLine, int sheetIndex) 读取Excel表格数据,返回List[List[String]]类型的数据集合
<T> List<T>	readExcel2Objects(InputStream is, Class<T> clazz) 读取Excel操作基于注解映射成绑定的java对象
<T> List<T>	readExcel2Objects(InputStream is, Class<T> clazz, int sheetIndex) 读取Excel操作基于注解映射成绑定的java对象
<T> List<T>	readExcel2Objects(InputStream is, Class<T> clazz, int offsetLine, int limitLine, int sheetIndex) 读取Excel操作基于注解映射成绑定的java对象
<T> List<T>	readExcel2Objects(String excelPath, Class<T> clazz) 读取Excel操作基于注解映射成绑定的java对象
<T> List<T>	readExcel2Objects(String excelPath, Class<T> clazz, int sheetIndex) 读取Excel操作基于注解映射成绑定的java对象
<T> List<T>	readExcel2Objects(String excelPath, Class<T> clazz, int offsetLine, int sheetIndex) 读取Excel操作基于注解映射成绑定的java对象
<T> List<T>	readExcel2Objects(String excelPath, Class<T> clazz, int offsetLine, int limitLine, int sheetIndex) 读取Excel操作基于注解映射成绑定的java对象
void	simpleSheet2Excel(List<SimpleSheetWrapper> sheets, boolean isXSSF, OutputStream os) 无模板、无注解、多sheet数据
void	simpleSheet2Excel(List<SimpleSheetWrapper> sheets, boolean isXSSF, String targetPath) 无模板、无注解、多sheet数据
void	simpleSheet2Excel(List<SimpleSheetWrapper> sheets, OutputStream os) 无模板、无注解、多sheet数据
void	simpleSheet2Excel(List<SimpleSheetWrapper> sheets, String targetPath) 无模板、无注解、多sheet数据

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

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

方法详细资料

getInstance

public static ExcelUtils getInstance()

双检锁保证单例

readExcel2Objects

public <T> List<T> readExcel2Objects(String excelPath,
                                     Class<T> clazz,
                                     int offsetLine,
                                     int limitLine,
                                     int sheetIndex)
                              throws Excel4JException,
                                     IOException

读取Excel操作基于注解映射成绑定的java对象

类型参数:

T - 绑定的数据类

参数:

excelPath - 待导出Excel的路径

clazz - 待绑定的类(绑定属性注解ExcelField)

offsetLine - Excel表头行(默认是0)

limitLine - 最大读取行数(默认表尾)

sheetIndex - Sheet索引(默认0)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4JException - 异常

IOException - 异常

readExcel2Objects

public <T> List<T> readExcel2Objects(InputStream is,
                                     Class<T> clazz,
                                     int offsetLine,
                                     int limitLine,
                                     int sheetIndex)
                              throws Excel4JException,
                                     IOException

读取Excel操作基于注解映射成绑定的java对象

类型参数:

T - 绑定的数据类

参数:

is - 待导出Excel的数据流

clazz - 待绑定的类(绑定属性注解ExcelField)

offsetLine - Excel表头行(默认是0)

limitLine - 最大读取行数(默认表尾)

sheetIndex - Sheet索引(默认0)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4JException - 异常

IOException - 异常

readExcel2Objects

public <T> List<T> readExcel2Objects(String excelPath,
                                     Class<T> clazz,
                                     int offsetLine,
                                     int sheetIndex)
                              throws Excel4JException,
                                     IOException

读取Excel操作基于注解映射成绑定的java对象

类型参数:

T - 绑定的数据类

参数:

excelPath - 待导出Excel的路径

clazz - 待绑定的类(绑定属性注解ExcelField)

offsetLine - Excel表头行(默认是0)

sheetIndex - Sheet索引(默认0)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4JException - 异常

IOException - 异常

readExcel2Objects

public <T> List<T> readExcel2Objects(String excelPath,
                                     Class<T> clazz,
                                     int sheetIndex)
                              throws Excel4JException,
                                     IOException

读取Excel操作基于注解映射成绑定的java对象

类型参数:

T - 绑定的数据类

参数:

excelPath - 待导出Excel的路径

clazz - 待绑定的类(绑定属性注解ExcelField)

sheetIndex - Sheet索引(默认0)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4JException - 异常

IOException - 异常

readExcel2Objects

public <T> List<T> readExcel2Objects(String excelPath,
                                     Class<T> clazz)
                              throws Excel4JException,
                                     IOException

读取Excel操作基于注解映射成绑定的java对象

类型参数:

T - 绑定的数据类

参数:

excelPath - 待导出Excel的路径

clazz - 待绑定的类(绑定属性注解ExcelField)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4JException - 异常

IOException - 异常

readExcel2Objects

public <T> List<T> readExcel2Objects(InputStream is,
                                     Class<T> clazz,
                                     int sheetIndex)
                              throws Excel4JException,
                                     IOException

读取Excel操作基于注解映射成绑定的java对象

类型参数:

T - 绑定的数据类

参数:

is - 待导出Excel的数据流

clazz - 待绑定的类(绑定属性注解ExcelField)

sheetIndex - Sheet索引(默认0)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4JException - 异常

IOException - 异常

readExcel2Objects

public <T> List<T> readExcel2Objects(InputStream is,
                                     Class<T> clazz)
                              throws Excel4JException,
                                     IOException

读取Excel操作基于注解映射成绑定的java对象

类型参数:

T - 绑定的数据类

参数:

is - 待导出Excel的数据流

clazz - 待绑定的类(绑定属性注解ExcelField)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4JException - 异常

IOException - 异常

readExcel2List

public List<List<String>> readExcel2List(String excelPath,
                                         int offsetLine,
                                         int limitLine,
                                         int sheetIndex)
                                  throws IOException

读取Excel表格数据,返回List[List[String]]类型的数据集合

参数:

excelPath - 待读取Excel的路径

offsetLine - Excel表头行(默认是0)

limitLine - 最大读取行数(默认表尾)

sheetIndex - Sheet索引(默认0)

返回:

返回List<List<String>>类型的数据集合

抛出:

IOException - 异常

readExcel2List

public List<List<String>> readExcel2List(InputStream is,
                                         int offsetLine,
                                         int limitLine,
                                         int sheetIndex)
                                  throws IOException

读取Excel表格数据,返回List[List[String]]类型的数据集合

参数:

is - 待读取Excel的数据流

offsetLine - Excel表头行(默认是0)

limitLine - 最大读取行数(默认表尾)

sheetIndex - Sheet索引(默认0)

返回:

返回List<List<String>>类型的数据集合

抛出:

IOException - 异常

readExcel2List

public List<List<String>> readExcel2List(String excelPath,
                                         int offsetLine)
                                  throws IOException

读取Excel表格数据,返回List[List[String]]类型的数据集合

参数:

excelPath - 待读取Excel的路径

offsetLine - Excel表头行(默认是0)

返回:

返回List<List<String>>类型的数据集合

抛出:

IOException - 异常

readExcel2List

public List<List<String>> readExcel2List(InputStream is,
                                         int offsetLine)
                                  throws IOException

读取Excel表格数据,返回List[List[String]]类型的数据集合

参数:

is - 待读取Excel的数据流

offsetLine - Excel表头行(默认是0)

返回:

返回List<List<String>>类型的数据集合

抛出:

IOException - 异常

readExcel2List

public List<List<String>> readExcel2List(String excelPath)
                                  throws IOException

读取Excel表格数据,返回List[List[String]]类型的数据集合

参数:

excelPath - 待读取Excel的路径

返回:

返回List<List<String>>类型的数据集合

抛出:

IOException - 异常

readExcel2List

public List<List<String>> readExcel2List(InputStream is)
                                  throws IOException

读取Excel表格数据,返回List[List[String]]类型的数据集合

参数:

is - 待读取Excel的数据流

返回:

返回List<List<String>>类型的数据集合

抛出:

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                int sheetIndex,
                                List<?> data,
                                Map<String,String> extendMap,
                                Class clazz,
                                boolean isWriteHeader,
                                String targetPath)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

sheetIndex - 指定导出Excel的sheet索引号(默认为0)

data - 待导出数据的集合

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

isWriteHeader - 是否写表头

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                int sheetIndex,
                                List<?> data,
                                Map<String,String> extendMap,
                                Class clazz,
                                boolean isWriteHeader,
                                OutputStream os)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

sheetIndex - 指定导出Excel的sheet索引号(默认为0)

data - 待导出数据的集合

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

isWriteHeader - 是否写表头

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                List<?> data,
                                Map<String,String> extendMap,
                                Class clazz,
                                boolean isWriteHeader,
                                String targetPath)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

data - 待导出数据的集合

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

isWriteHeader - 是否写表头

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                List<?> data,
                                Map<String,String> extendMap,
                                Class clazz,
                                boolean isWriteHeader,
                                OutputStream os)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

data - 待导出数据的集合

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

isWriteHeader - 是否写表头

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                List<?> data,
                                Map<String,String> extendMap,
                                Class clazz,
                                String targetPath)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

data - 待导出数据的集合

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                List<?> data,
                                Map<String,String> extendMap,
                                Class clazz,
                                OutputStream os)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

data - 待导出数据的集合

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                List<?> data,
                                Class clazz,
                                String targetPath)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

data - 待导出数据的集合

clazz - 映射对象Class

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(String templatePath,
                                List<?> data,
                                Class clazz,
                                OutputStream os)
                         throws Excel4JException

基于Excel模板与注解ExcelField导出Excel

参数:

templatePath - Excel模板路径

data - 待导出数据的集合

clazz - 映射对象Class

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

normalSheet2Excel

public void normalSheet2Excel(List<NormalSheetWrapper> sheetWrappers,
                              String templatePath,
                              String targetPath)
                       throws Excel4JException

基于Excel模板与注解ExcelField导出多sheet的Excel

参数:

sheetWrappers - sheet包装类

templatePath - Excel模板路径

targetPath - 导出Excel文件路径

抛出:

Excel4JException - 异常

normalSheet2Excel

public void normalSheet2Excel(List<NormalSheetWrapper> sheetWrappers,
                              String templatePath,
                              OutputStream os)
                       throws Excel4JException

基于Excel模板与注解ExcelField导出多sheet的Excel

参数:

sheetWrappers - sheet包装类

templatePath - Excel模板路径

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

exportMap2Excel

public void exportMap2Excel(String templatePath,
                            int sheetIndex,
                            Map<String,List<?>> data,
                            Map<String,String> extendMap,
                            Class clazz,
                            boolean isWriteHeader,
                            String targetPath)
                     throws Excel4JException

基于模板、注解导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

templatePath - Excel模板路径

sheetIndex - 指定导出Excel的sheet索引号(默认为0)

data - 待导出的Map<String, List<?>>类型数据

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

isWriteHeader - 是否写入表头

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

exportMap2Excel

public void exportMap2Excel(String templatePath,
                            int sheetIndex,
                            Map<String,List<?>> data,
                            Map<String,String> extendMap,
                            Class clazz,
                            boolean isWriteHeader,
                            OutputStream os)
                     throws Excel4JException

基于模板、注解导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

templatePath - Excel模板路径

sheetIndex - 指定导出Excel的sheet索引号(默认为0)

data - 待导出的Map<String, List<?>>类型数据

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

isWriteHeader - 是否写入表头

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

exportMap2Excel

public void exportMap2Excel(String templatePath,
                            Map<String,List<?>> data,
                            Map<String,String> extendMap,
                            Class clazz,
                            String targetPath)
                     throws Excel4JException

基于模板、注解导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

templatePath - Excel模板路径

data - 待导出的Map<String, List<?>>类型数据

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

exportMap2Excel

public void exportMap2Excel(String templatePath,
                            Map<String,List<?>> data,
                            Map<String,String> extendMap,
                            Class clazz,
                            OutputStream os)
                     throws Excel4JException

基于模板、注解导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

templatePath - Excel模板路径

data - 待导出的Map<String, List<?>>类型数据

extendMap - 扩展内容Map数据(具体就是key匹配替换模板#key内容,详情请查阅Excel模板定制方法)

clazz - 映射对象Class

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

exportMap2Excel

public void exportMap2Excel(String templatePath,
                            Map<String,List<?>> data,
                            Class clazz,
                            String targetPath)
                     throws Excel4JException

基于模板、注解导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

templatePath - Excel模板路径

data - 待导出的Map<String, List<?>>类型数据

clazz - 映射对象Class

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

exportMap2Excel

public void exportMap2Excel(String templatePath,
                            Map<String,List<?>> data,
                            Class clazz,
                            OutputStream os)
                     throws Excel4JException

基于模板、注解导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

templatePath - Excel模板路径

data - 待导出的Map<String, List<?>>类型数据

clazz - 映射对象Class

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

mapSheet2Excel

public void mapSheet2Excel(List<MapSheetWrapper> sheetWrappers,
                           String templatePath,
                           String targetPath)
                    throws Excel4JException

基于模板、注解的多sheet导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

sheetWrappers - sheet包装类

templatePath - Excel模板

targetPath - 导出Excel路径

抛出:

Excel4JException - 异常

mapSheet2Excel

public void mapSheet2Excel(List<MapSheetWrapper> sheetWrappers,
                           String templatePath,
                           OutputStream os)
                    throws Excel4JException

基于模板、注解的多sheet导出Map[String, List[?]]类型数据 模板定制详见定制说明

参数:

sheetWrappers - sheet包装类

templatePath - Excel模板

os - 输出流

抛出:

Excel4JException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                Class clazz,
                                boolean isWriteHeader,
                                String sheetName,
                                boolean isXSSF,
                                String targetPath)
                         throws Excel4JException,
                                IOException

无模板、基于注解的数据导出

参数:

data - 待导出数据

clazz - ExcelField映射对象Class

isWriteHeader - 是否写入表头

sheetName - 指定导出Excel的sheet名称

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                Class clazz,
                                boolean isWriteHeader,
                                String sheetName,
                                boolean isXSSF,
                                OutputStream os)
                         throws Excel4JException,
                                IOException

无模板、基于注解的数据导出

参数:

data - 待导出数据

clazz - ExcelField映射对象Class

isWriteHeader - 是否写入表头

sheetName - 指定导出Excel的sheet名称

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                Class clazz,
                                boolean isWriteHeader,
                                String targetPath)
                         throws Excel4JException,
                                IOException

无模板、基于注解的数据导出

参数:

data - 待导出数据

clazz - ExcelField映射对象Class

isWriteHeader - 是否写入表头

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                Class clazz,
                                boolean isWriteHeader,
                                OutputStream os)
                         throws Excel4JException,
                                IOException

无模板、基于注解的数据导出

参数:

data - 待导出数据

clazz - ExcelField映射对象Class

isWriteHeader - 是否写入表头

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                Class clazz,
                                OutputStream os)
                         throws Excel4JException,
                                IOException

无模板、基于注解的数据导出

参数:

data - 待导出数据

clazz - ExcelField映射对象Class

os - 生成的Excel待输出数据流

抛出:

Excel4JException - 异常

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                Class clazz,
                                String targetPath)
                         throws Excel4JException,
                                IOException

无模板、基于注解的数据导出

参数:

data - 待导出数据

clazz - ExcelField映射对象Class

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

IOException - 异常

noTemplateSheet2Excel

public void noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets,
                                  String targetPath)
                           throws Excel4JException,
                                  IOException

无模板、基于注解、多sheet数据

参数:

sheets - 待导出sheet数据

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

IOException - 异常

noTemplateSheet2Excel

public void noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets,
                                  boolean isXSSF,
                                  String targetPath)
                           throws Excel4JException,
                                  IOException

无模板、基于注解、多sheet数据

参数:

sheets - 待导出sheet数据

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

targetPath - 生成的Excel输出全路径

抛出:

Excel4JException - 异常

IOException - 异常

noTemplateSheet2Excel

public void noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets,
                                  OutputStream os)
                           throws Excel4JException,
                                  IOException

无模板、基于注解、多sheet数据

参数:

sheets - 待导出sheet数据

os - 生成的Excel输出文件流

抛出:

Excel4JException - 异常

IOException - 异常

noTemplateSheet2Excel

public void noTemplateSheet2Excel(List<NoTemplateSheetWrapper> sheets,
                                  boolean isXSSF,
                                  OutputStream os)
                           throws Excel4JException,
                                  IOException

无模板、基于注解、多sheet数据

参数:

sheets - 待导出sheet数据

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

os - 生成的Excel输出文件流

抛出:

Excel4JException - 异常

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                List<String> header,
                                String sheetName,
                                boolean isXSSF,
                                String targetPath)
                         throws IOException

无模板、无注解的数据(形如List[?]、List[List[?]]、List[Object[]])导出

参数:

data - 待导出数据

header - 设置表头信息

sheetName - 指定导出Excel的sheet名称

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

targetPath - 生成的Excel输出全路径

抛出:

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                List<String> header,
                                String sheetName,
                                boolean isXSSF,
                                OutputStream os)
                         throws IOException

无模板、无注解的数据(形如List[?]、List[List[?]]、List[Object[]])导出

参数:

data - 待导出数据

header - 设置表头信息

sheetName - 指定导出Excel的sheet名称

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

os - 生成的Excel待输出数据流

抛出:

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                List<String> header,
                                String targetPath)
                         throws IOException

无模板、无注解的数据(形如List[?]、List[List[?]]、List[Object[]])导出

参数:

data - 待导出数据

header - 设置表头信息

targetPath - 生成的Excel输出全路径

抛出:

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                List<String> header,
                                OutputStream os)
                         throws IOException

无模板、无注解的数据(形如List[?]、List[List[?]]、List[Object[]])导出

参数:

data - 待导出数据

header - 设置表头信息

os - 生成的Excel待输出数据流

抛出:

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                String targetPath)
                         throws IOException

无模板、无注解的数据(形如List[?]、List[List[?]]、List[Object[]])导出

参数:

data - 待导出数据

targetPath - 生成的Excel输出全路径

抛出:

IOException - 异常

exportObjects2Excel

public void exportObjects2Excel(List<?> data,
                                OutputStream os)
                         throws IOException

无模板、无注解的数据(形如List[?]、List[List[?]]、List[Object[]])导出

参数:

data - 待导出数据

os - 生成的Excel待输出数据流

抛出:

IOException - 异常

simpleSheet2Excel

public void simpleSheet2Excel(List<SimpleSheetWrapper> sheets,
                              String targetPath)
                       throws IOException

无模板、无注解、多sheet数据

参数:

sheets - 待导出sheet数据

targetPath - 生成的Excel输出全路径

抛出:

IOException - 异常

simpleSheet2Excel

public void simpleSheet2Excel(List<SimpleSheetWrapper> sheets,
                              boolean isXSSF,
                              String targetPath)
                       throws IOException

无模板、无注解、多sheet数据

参数:

sheets - 待导出sheet数据

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

targetPath - 生成的Excel输出全路径

抛出:

IOException - 异常

simpleSheet2Excel

public void simpleSheet2Excel(List<SimpleSheetWrapper> sheets,
                              OutputStream os)
                       throws IOException

无模板、无注解、多sheet数据

参数:

sheets - 待导出sheet数据

os - 生成的Excel待输出数据流

抛出:

IOException - 异常

simpleSheet2Excel

public void simpleSheet2Excel(List<SimpleSheetWrapper> sheets,
                              boolean isXSSF,
                              OutputStream os)
                       throws IOException

无模板、无注解、多sheet数据

参数:

sheets - 待导出sheet数据

isXSSF - 导出的Excel是否为Excel2007及以上版本(默认是)

os - 生成的Excel待输出数据流

抛出:

IOException - 异常

readCSV2Objects

public <T> List<T> readCSV2Objects(String path,
                                   Class<T> clazz)

基于注解读取CSV文件

参数:

path - 待读取文件路径

clazz - 待绑定的类(绑定属性注解ExcelField)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4jReadException - exception

readCSV2Objects

public <T> List<T> readCSV2Objects(InputStream is,
                                   Class<T> clazz)

基于注解读取CSV文件

参数:

is - 待读取文件输入流

clazz - 待绑定的类(绑定属性注解ExcelField)

返回:

返回转换为设置绑定的java对象集合

抛出:

Excel4jReadException - exception

exportObjects2CSV

public void exportObjects2CSV(List<?> data,
                              Class clazz,
                              String path)
                       throws Excel4JException

基于注解导出CSV文件

参数:

data - 待导出

clazz - ExcelField映射对象Class

path - 导出文件路径

抛出:

Excel4JException - exception

exportObjects2CSV

public void exportObjects2CSV(List<?> data,
                              Class clazz,
                              OutputStream os)
                       throws Excel4JException

基于注解导出CSV文件流

参数:

data - 待导出

clazz - ExcelField映射对象Class

os - 输出流

抛出:

Excel4JException - exception

exportObjects2CSV

public void exportObjects2CSV(List<?> data,
                              Class clazz,
                              boolean isWriteHeader,
                              String path)
                       throws Excel4JException

基于注解导出CSV文件

参数:

data - 待导出

clazz - ExcelField映射对象Class

isWriteHeader - 是否写入文件

path - 导出文件路径

抛出:

Excel4JException - exception

exportObjects2CSV

public void exportObjects2CSV(List<?> data,
                              Class clazz,
                              boolean isWriteHeader,
                              OutputStream os)
                       throws Excel4JException

基于注解导出CSV文件流

参数:

data - 待导出

clazz - ExcelField映射对象Class

isWriteHeader - 是否写入文件

os - 输出流

抛出:

Excel4JException - exception