cn.hutool.poi.excel

类 WorkbookUtil

java.lang.Object

cn.hutool.poi.excel.WorkbookUtil

public class WorkbookUtil
extends Object

Excel工作簿Workbook相关工具类

从以下版本开始:

4.0.7

作者:

looly

构造器概要

构造器

构造器和说明
WorkbookUtil()

方法概要

方法

限定符和类型	方法和说明
static org.apache.poi.ss.usermodel.Workbook	createBook(boolean isXlsx) 根据文件类型创建新的工作簿，文件路径
static org.apache.poi.ss.usermodel.Workbook	createBook(File excelFile) 创建或加载工作簿
static org.apache.poi.ss.usermodel.Workbook	createBook(File excelFile, String password) 创建或加载工作簿，只读模式
static org.apache.poi.ss.usermodel.Workbook	createBook(InputStream in, boolean closeAfterRead) 创建或加载工作簿
static org.apache.poi.ss.usermodel.Workbook	createBook(InputStream in, String password, boolean closeAfterRead) 创建或加载工作簿
static org.apache.poi.ss.usermodel.Workbook	createBook(String excelFilePath) 创建或加载工作簿
static org.apache.poi.ss.usermodel.Workbook	createBookForWriter(File excelFile) 创建工作簿，用于Excel写出 1. excelFile为null时直接返回一个空的工作簿，默认xlsx格式 2.
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook() 创建SXSSFWorkbook，用于大批量数据写出
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(File excelFile) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(File excelFile, String password) 创建或加载SXSSFWorkbook工作簿，只读模式
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(InputStream in, boolean closeAfterRead) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(InputStream in, String password, boolean closeAfterRead) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(int rowAccessWindowSize) 创建SXSSFWorkbook，用于大批量数据写出
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(String excelFilePath) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.ss.usermodel.Sheet	getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book, String sheetName) 获取或者创建sheet表 如果sheet表在Workbook中已经存在，则获取之，否则创建之
static boolean	isEmpty(org.apache.poi.ss.usermodel.Sheet sheet) sheet是否为空
static void	writeBook(org.apache.poi.ss.usermodel.Workbook book, OutputStream out) 将Excel Workbook刷出到输出流，不关闭流

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

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

构造器详细资料

WorkbookUtil

public WorkbookUtil()

方法详细资料

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(String excelFilePath)

创建或加载工作簿

参数:

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

返回:

Workbook

从以下版本开始:

3.1.1

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(File excelFile)

创建或加载工作簿

参数:

excelFile - Excel文件

返回:

Workbook

createBookForWriter

public static org.apache.poi.ss.usermodel.Workbook createBookForWriter(File excelFile)

创建工作簿，用于Excel写出

 1. excelFile为null时直接返回一个空的工作簿，默认xlsx格式
 2. 文件已存在则通过流的方式读取到这个工作簿
 3. 文件不存在则检查传入文件路径是否以xlsx为扩展名，是则创建xlsx工作簿，否则创建xls工作簿
 

参数:

excelFile - Excel文件

返回:

Workbook

从以下版本开始:

4.5.18

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(File excelFile,
                                              String password)

创建或加载工作簿，只读模式

参数:

excelFile - Excel文件

password - Excel工作簿密码，如果无密码传null

返回:

Workbook

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(InputStream in,
                                              boolean closeAfterRead)

创建或加载工作簿

参数:

in - Excel输入流

closeAfterRead - 读取结束是否关闭流

返回:

Workbook

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(InputStream in,
                                              String password,
                                              boolean closeAfterRead)

创建或加载工作簿

参数:

in - Excel输入流

password - 密码

closeAfterRead - 读取结束是否关闭流

返回:

Workbook

从以下版本开始:

4.0.3

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(boolean isXlsx)

根据文件类型创建新的工作簿，文件路径

参数:

isXlsx - 是否为xlsx格式的Excel

返回:

Workbook

从以下版本开始:

4.1.0

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(String excelFilePath)

创建或加载SXSSFWorkbook工作簿

参数:

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

返回:

SXSSFWorkbook

从以下版本开始:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(File excelFile)

创建或加载SXSSFWorkbook工作簿

参数:

excelFile - Excel文件

返回:

SXSSFWorkbook

从以下版本开始:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(File excelFile,
                                                          String password)

创建或加载SXSSFWorkbook工作簿，只读模式

参数:

excelFile - Excel文件

password - Excel工作簿密码，如果无密码传null

返回:

SXSSFWorkbook

从以下版本开始:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(InputStream in,
                                                          boolean closeAfterRead)

创建或加载SXSSFWorkbook工作簿

参数:

in - Excel输入流

closeAfterRead - 读取结束是否关闭流

返回:

SXSSFWorkbook

从以下版本开始:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(InputStream in,
                                                          String password,
                                                          boolean closeAfterRead)

创建或加载SXSSFWorkbook工作簿

参数:

in - Excel输入流

password - 密码

closeAfterRead - 读取结束是否关闭流

返回:

SXSSFWorkbook

从以下版本开始:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook()

创建SXSSFWorkbook，用于大批量数据写出

返回:

SXSSFWorkbook

从以下版本开始:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(int rowAccessWindowSize)

创建SXSSFWorkbook，用于大批量数据写出

参数:

rowAccessWindowSize - 在内存中的行数

返回:

Workbook

从以下版本开始:

4.1.13

writeBook

public static void writeBook(org.apache.poi.ss.usermodel.Workbook book,
             OutputStream out)
                      throws IORuntimeException

将Excel Workbook刷出到输出流，不关闭流

参数:

book - Workbook

out - 输出流

抛出:

IORuntimeException - IO异常

从以下版本开始:

3.2.0

getOrCreateSheet

public static org.apache.poi.ss.usermodel.Sheet getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book,
                                                 String sheetName)

获取或者创建sheet表
如果sheet表在Workbook中已经存在，则获取之，否则创建之

参数:

book - 工作簿Workbook

sheetName - 工作表名

返回:

工作表Sheet

从以下版本开始:

4.0.2

isEmpty

public static boolean isEmpty(org.apache.poi.ss.usermodel.Sheet sheet)

sheet是否为空

参数:

sheet - Sheet

返回:

sheet是否为空

从以下版本开始:

4.0.1