org.dromara.hutool.poi.excel

Class ExcelUtil

java.lang.Object

org.dromara.hutool.poi.excel.ExcelUtil

public class ExcelUtil
extends Object

Excel工具类,不建议直接使用index直接操作sheet，在wps/excel中sheet显示顺序与index无关，还有隐藏sheet

Author:

Looly

Field Summary

Fields

Modifier and Type	Field and Description
static String	XLS_CONTENT_TYPE xls的ContentType
static String	XLSX_CONTENT_TYPE xlsx的ContentType

Constructor Summary

Constructors

Constructor and Description
ExcelUtil()

Method Summary

Modifier and Type	Method and Description
static BigExcelWriter	getBigWriter() 获得BigExcelWriter，默认写出到第一个sheet 不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流 若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
static BigExcelWriter	getBigWriter(File destFile) 获得BigExcelWriter，默认写出到第一个sheet，名字为sheet1
static BigExcelWriter	getBigWriter(File destFile, String sheetName) 获得BigExcelWriter
static BigExcelWriter	getBigWriter(int rowAccessWindowSize) 获得BigExcelWriter，默认写出到第一个sheet 不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流 若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
static BigExcelWriter	getBigWriter(String destFilePath) 获得BigExcelWriter，默认写出到第一个sheet
static BigExcelWriter	getBigWriter(String destFilePath, String sheetName) 获得BigExcelWriter
static ExcelReader	getReader(File bookFile) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容 默认调用第一个sheet
static ExcelReader	getReader(File bookFile, int sheetIndex) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
static ExcelReader	getReader(File bookFile, String sheetName) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
static ExcelReader	getReader(InputStream bookStream) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容 默认调用第一个sheet，读取结束自动关闭流
static ExcelReader	getReader(InputStream bookStream, int sheetIndex) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容 读取结束自动关闭流
static ExcelReader	getReader(InputStream bookStream, String sheetName) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容 读取结束自动关闭流
static ExcelReader	getReader(String bookFilePath) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容 默认调用第一个sheet
static ExcelReader	getReader(String bookFilePath, int sheetIndex) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
static ExcelReader	getReader(String bookFilePath, String sheetName) 获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
static ExcelWriter	getWriter() 获得ExcelWriter，默认写出到第一个sheet 不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流 若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
static ExcelWriter	getWriter(boolean isXlsx) 获得ExcelWriter，默认写出到第一个sheet 不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流 若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
static ExcelWriter	getWriter(File templateFile) 获得ExcelWriter，默认写出到第一个sheet，名字为sheet1
static ExcelWriter	getWriter(File templateFilePath, String sheetName) 获得ExcelWriter
static ExcelWriter	getWriter(String templateFilePath) 获得ExcelWriter，默认写出到第一个sheet
static ExcelWriter	getWriter(String templateFilePath, String sheetName) 获得ExcelWriter
static ExcelWriter	getWriterWithSheet(String sheetName) 获得ExcelWriter，默认写出到第一个sheet
static void	readBySax(File file, int rid, RowHandler rowHandler) 通过Sax方式读取Excel，同时支持03和07格式
static void	readBySax(File file, String idOrRidOrSheetName, RowHandler rowHandler) 通过Sax方式读取Excel，同时支持03和07格式
static void	readBySax(InputStream in, int rid, RowHandler rowHandler) 通过Sax方式读取Excel，同时支持03和07格式
static void	readBySax(InputStream in, String idOrRidOrSheetName, RowHandler rowHandler) 通过Sax方式读取Excel，同时支持03和07格式
static void	readBySax(String path, int rid, RowHandler rowHandler) 通过Sax方式读取Excel，同时支持03和07格式
static void	readBySax(String path, String idOrRid, RowHandler rowHandler) 通过Sax方式读取Excel，同时支持03和07格式

Methods inherited from class java.lang.Object

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

Field Detail

XLS_CONTENT_TYPE

public static final String XLS_CONTENT_TYPE

xls的ContentType

See Also:

Constant Field Values

XLSX_CONTENT_TYPE

public static final String XLSX_CONTENT_TYPE

xlsx的ContentType

See Also:

Constant Field Values

Constructor Detail

ExcelUtil

public ExcelUtil()

Method Detail

readBySax

public static void readBySax(String path,
                             int rid,
                             RowHandler rowHandler)

通过Sax方式读取Excel，同时支持03和07格式

Parameters:

path - Excel文件路径

rid - sheet rid，-1表示全部Sheet, 0表示第一个Sheet

rowHandler - 行处理器

Since:

3.2.0

readBySax

public static void readBySax(String path,
                             String idOrRid,
                             RowHandler rowHandler)

通过Sax方式读取Excel，同时支持03和07格式

Parameters:

path - Excel文件路径

idOrRid - Excel中的sheet id或者rid编号，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet

rowHandler - 行处理器

Since:

5.4.4

readBySax

public static void readBySax(File file,
                             int rid,
                             RowHandler rowHandler)

通过Sax方式读取Excel，同时支持03和07格式

Parameters:

file - Excel文件

rid - sheet rid，-1表示全部Sheet, 0表示第一个Sheet

rowHandler - 行处理器

Since:

3.2.0

readBySax

public static void readBySax(File file,
                             String idOrRidOrSheetName,
                             RowHandler rowHandler)

通过Sax方式读取Excel，同时支持03和07格式

Parameters:

file - Excel文件

idOrRidOrSheetName - Excel中的sheet id或rid编号或sheet名称，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet

rowHandler - 行处理器

Since:

5.4.4

readBySax

public static void readBySax(InputStream in,
                             int rid,
                             RowHandler rowHandler)

通过Sax方式读取Excel，同时支持03和07格式

Parameters:

in - Excel流

rid - sheet rid，-1表示全部Sheet, 0表示第一个Sheet

rowHandler - 行处理器

Since:

3.2.0

readBySax

public static void readBySax(InputStream in,
                             String idOrRidOrSheetName,
                             RowHandler rowHandler)

通过Sax方式读取Excel，同时支持03和07格式

Parameters:

in - Excel流

idOrRidOrSheetName - Excel中的sheet id或rid编号或sheet名称，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet

rowHandler - 行处理器

Since:

5.4.4

getReader

public static ExcelReader getReader(String bookFilePath)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
默认调用第一个sheet

Parameters:

bookFilePath - Excel文件路径，绝对路径或相对于ClassPath路径

Returns:

ExcelReader

Since:

3.1.1

getReader

public static ExcelReader getReader(File bookFile)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
默认调用第一个sheet

Parameters:

bookFile - Excel文件

Returns:

ExcelReader

getReader

public static ExcelReader getReader(String bookFilePath,
                                    int sheetIndex)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容

Parameters:

bookFilePath - Excel文件路径，绝对路径或相对于ClassPath路径

sheetIndex - sheet序号，0表示第一个sheet

Returns:

ExcelReader

Since:

3.1.1

getReader

public static ExcelReader getReader(String bookFilePath,
                                    String sheetName)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容

Parameters:

bookFilePath - Excel文件路径，绝对路径或相对于ClassPath路径

sheetName - sheet名，第一个默认是sheet1

Returns:

ExcelReader

Since:

5.8.0

getReader

public static ExcelReader getReader(File bookFile,
                                    int sheetIndex)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容

Parameters:

bookFile - Excel文件

sheetIndex - sheet序号，0表示第一个sheet

Returns:

ExcelReader

getReader

public static ExcelReader getReader(File bookFile,
                                    String sheetName)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容

Parameters:

bookFile - Excel文件

sheetName - sheet名，第一个默认是sheet1

Returns:

ExcelReader

getReader

public static ExcelReader getReader(InputStream bookStream)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
默认调用第一个sheet，读取结束自动关闭流

Parameters:

bookStream - Excel文件的流

Returns:

ExcelReader

getReader

public static ExcelReader getReader(InputStream bookStream,
                                    int sheetIndex)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
读取结束自动关闭流

Parameters:

bookStream - Excel文件的流

sheetIndex - sheet序号，0表示第一个sheet

Returns:

ExcelReader

getReader

public static ExcelReader getReader(InputStream bookStream,
                                    String sheetName)

获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
读取结束自动关闭流

Parameters:

bookStream - Excel文件的流

sheetName - sheet名，第一个默认是sheet1

Returns:

ExcelReader

getWriter

public static ExcelWriter getWriter()

获得ExcelWriter，默认写出到第一个sheet
不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流
若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件

Returns:

ExcelWriter

Since:

3.2.1

getWriter

public static ExcelWriter getWriter(boolean isXlsx)

获得ExcelWriter，默认写出到第一个sheet
不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流
若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件

Parameters:

isXlsx - 是否为xlsx格式

Returns:

ExcelWriter

Since:

3.2.1

getWriter

public static ExcelWriter getWriter(String templateFilePath)

获得ExcelWriter，默认写出到第一个sheet

Parameters:

templateFilePath - 模板文件路径

Returns:

ExcelWriter

getWriterWithSheet

public static ExcelWriter getWriterWithSheet(String sheetName)

获得ExcelWriter，默认写出到第一个sheet

Parameters:

sheetName - Sheet名

Returns:

ExcelWriter

Since:

4.5.18

getWriter

public static ExcelWriter getWriter(File templateFile)

获得ExcelWriter，默认写出到第一个sheet，名字为sheet1

Parameters:

templateFile - 目标文件

Returns:

ExcelWriter

getWriter

public static ExcelWriter getWriter(String templateFilePath,
                                    String sheetName)

获得ExcelWriter

Parameters:

templateFilePath - 目标文件路径

sheetName - sheet表名

Returns:

ExcelWriter

getWriter

public static ExcelWriter getWriter(File templateFilePath,
                                    String sheetName)

获得ExcelWriter

Parameters:

templateFilePath - 目标文件

sheetName - sheet表名

Returns:

ExcelWriter

getBigWriter

public static BigExcelWriter getBigWriter()

获得BigExcelWriter，默认写出到第一个sheet
不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流
若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件

Returns:

BigExcelWriter

Since:

4.1.13

getBigWriter

public static BigExcelWriter getBigWriter(int rowAccessWindowSize)

获得BigExcelWriter，默认写出到第一个sheet
不传入写出的Excel文件路径，只能调用ExcelWriter#flush(OutputStream)方法写出到流
若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件

Parameters:

rowAccessWindowSize - 在内存中的行数

Returns:

BigExcelWriter

Since:

4.1.13

getBigWriter

public static BigExcelWriter getBigWriter(String destFilePath)

获得BigExcelWriter，默认写出到第一个sheet

Parameters:

destFilePath - 目标文件路径

Returns:

BigExcelWriter

getBigWriter

public static BigExcelWriter getBigWriter(File destFile)

获得BigExcelWriter，默认写出到第一个sheet，名字为sheet1

Parameters:

destFile - 目标文件

Returns:

BigExcelWriter

getBigWriter

public static BigExcelWriter getBigWriter(String destFilePath,
                                          String sheetName)

获得BigExcelWriter

Parameters:

destFilePath - 目标文件路径

sheetName - sheet表名

Returns:

BigExcelWriter

getBigWriter

public static BigExcelWriter getBigWriter(File destFile,
                                          String sheetName)

获得BigExcelWriter

Parameters:

destFile - 目标文件

sheetName - sheet表名

Returns:

BigExcelWriter