ExcelUtil (hutool-poi 3.3.2 API)

java.lang.Object
- com.xiaoleilu.hutool.poi.excel.ExcelUtil

```
public class ExcelUtil
extends Object
```
Excel工具类

作者:

Looly

构造器概要

构造器
构造器和说明

ExcelUtil()

构造器
构造器和说明
`ExcelUtil()`

方法概要

方法
限定符和类型	方法和说明
`static org.apache.poi.ss.usermodel.Workbook`	`createBook(File destFile)` 根据文件路径创建新的工作簿
`static org.apache.poi.ss.usermodel.Workbook`	`createBook(String destFilePath)` 根据文件路径创建新的工作簿，文件路径
`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 ExcelWriter`	`getWriter()` 获得`ExcelWriter`，默认写出到第一个sheet 不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(OutputStream)`方法写出到流若写出到文件，还需调用`ExcelWriter.setDestFile(File)`方法自定义写出的文件，然后调用`ExcelWriter.flush()`方法写出到文件
`static ExcelWriter`	`getWriter(boolean isXlsx)` 获得`ExcelWriter`，默认写出到第一个sheet 不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(OutputStream)`方法写出到流若写出到文件，还需调用`ExcelWriter.setDestFile(File)`方法自定义写出的文件，然后调用`ExcelWriter.flush()`方法写出到文件
`static ExcelWriter`	`getWriter(File destFile)` 获得`ExcelWriter`，默认写出到第一个sheet，名字为sheet1
`static ExcelWriter`	`getWriter(File destFile, String sheetName)` 获得`ExcelWriter`
`static ExcelWriter`	`getWriter(String destFilePath)` 获得`ExcelWriter`，默认写出到第一个sheet
`static ExcelWriter`	`getWriter(String destFilePath, String sheetName)` 获得`ExcelWriter`
`static boolean`	`isXls(InputStream in)` 是否为XLS格式的Excel文件（HSSF） XLS文件主要用于Excel 97~2003创建
`static boolean`	`isXlsx(InputStream in)` 是否为XLSX格式的Excel文件（XSSF） XLSX文件主要用于Excel 2007+创建
`static org.apache.poi.ss.usermodel.Workbook`	`loadBook(File excelFile)` 加载工作簿
`static org.apache.poi.ss.usermodel.Workbook`	`loadBook(File excelFile, String password)` 加载工作簿
`static org.apache.poi.ss.usermodel.Workbook`	`loadBook(InputStream in)` 加载工作簿
`static org.apache.poi.ss.usermodel.Workbook`	`loadBook(String excelFilePath)` 加载工作簿
`static Excel03SaxReader`	`read03BySax(File file, int sheetIndex, RowHandler rowHandler)` Sax方式读取Excel03
`static Excel03SaxReader`	`read03BySax(InputStream in, int sheetIndex, RowHandler rowHandler)` Sax方式读取Excel03
`static Excel03SaxReader`	`read03BySax(String path, int sheetIndex, RowHandler rowHandler)` Sax方式读取Excel03
`static Excel07SaxReader`	`read07BySax(File file, int sheetIndex, RowHandler rowHandler)` Sax方式读取Excel07
`static Excel07SaxReader`	`read07BySax(InputStream in, int sheetIndex, RowHandler rowHandler)` Sax方式读取Excel07
`static Excel07SaxReader`	`read07BySax(String path, int sheetIndex, RowHandler rowHandler)` Sax方式读取Excel07
`static void`	`readBySax(File file, int sheetIndex, RowHandler rowHandler)` 通过Sax方式读取Excel，同时支持03和07格式
`static void`	`readBySax(InputStream in, int sheetIndex, RowHandler rowHandler)` 通过Sax方式读取Excel，同时支持03和07格式
`static void`	`readBySax(String path, int sheetIndex, RowHandler rowHandler)` 通过Sax方式读取Excel，同时支持03和07格式
`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

- 构造器详细资料
  - ExcelUtil
```
public ExcelUtil()
```
- 方法详细资料
  - readBySax
```
public static void readBySax(String path,
             int sheetIndex,
             RowHandler rowHandler)
```
    通过Sax方式读取Excel，同时支持03和07格式
    
    参数:
    path - Excel文件路径
    sheetIndex - sheet序号
    rowHandler - 行处理器
    从以下版本开始:
    
    3.2.0
  - readBySax
```
public static void readBySax(File file,
             int sheetIndex,
             RowHandler rowHandler)
```
    通过Sax方式读取Excel，同时支持03和07格式
    
    参数:
    file - Excel文件
    sheetIndex - sheet序号
    rowHandler - 行处理器
    从以下版本开始:
    
    3.2.0
  - readBySax
```
public static void readBySax(InputStream in,
             int sheetIndex,
             RowHandler rowHandler)
```
    通过Sax方式读取Excel，同时支持03和07格式
    
    参数:
    in - Excel流
    sheetIndex - sheet序号
    rowHandler - 行处理器
    从以下版本开始:
    
    3.2.0
  - read07BySax
```
public static Excel07SaxReader read07BySax(InputStream in,
                           int sheetIndex,
                           RowHandler rowHandler)
```
    Sax方式读取Excel07
    
    参数:
    in - 输入流
    sheetIndex - Sheet索引，-1表示全部Sheet, 0表示第一个Sheet
    rowHandler - 行处理器
    
    返回:
    Excel07SaxReader
    从以下版本开始:
    
    3.2.0
  - read07BySax
```
public static Excel07SaxReader read07BySax(File file,
                           int sheetIndex,
                           RowHandler rowHandler)
```
    Sax方式读取Excel07
    
    参数:
    file - 文件
    sheetIndex - Sheet索引，-1表示全部Sheet, 0表示第一个Sheet
    rowHandler - 行处理器
    
    返回:
    Excel07SaxReader
    从以下版本开始:
    
    3.2.0
  - read07BySax
```
public static Excel07SaxReader read07BySax(String path,
                           int sheetIndex,
                           RowHandler rowHandler)
```
    Sax方式读取Excel07
    
    参数:
    path - 路径
    sheetIndex - Sheet索引，-1表示全部Sheet, 0表示第一个Sheet
    rowHandler - 行处理器
    
    返回:
    Excel07SaxReader
    从以下版本开始:
    
    3.2.0
  - read03BySax
```
public static Excel03SaxReader read03BySax(InputStream in,
                           int sheetIndex,
                           RowHandler rowHandler)
```
    Sax方式读取Excel03
    
    参数:
    in - 输入流
    sheetIndex - Sheet索引，-1表示全部Sheet, 0表示第一个Sheet
    rowHandler - 行处理器
    
    返回:
    Excel07SaxReader
    从以下版本开始:
    
    3.2.0
  - read03BySax
```
public static Excel03SaxReader read03BySax(File file,
                           int sheetIndex,
                           RowHandler rowHandler)
```
    Sax方式读取Excel03
    
    参数:
    file - 文件
    sheetIndex - Sheet索引，-1表示全部Sheet, 0表示第一个Sheet
    rowHandler - 行处理器
    
    返回:
    Excel03SaxReader
    从以下版本开始:
    
    3.2.0
  - read03BySax
```
public static Excel03SaxReader read03BySax(String path,
                           int sheetIndex,
                           RowHandler rowHandler)
```
    Sax方式读取Excel03
    
    参数:
    path - 路径
    sheetIndex - Sheet索引，-1表示全部Sheet, 0表示第一个Sheet
    rowHandler - 行处理器
    
    返回:
    Excel03SaxReader
    从以下版本开始:
    
    3.2.0
  - getReader
```
public static ExcelReader getReader(String bookFilePath)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    默认调用第一个sheet
    
    参数:
    bookFilePath - Excel文件路径，绝对路径或相对于ClassPath路径
    
    返回:
    ExcelReader
    从以下版本开始:
    
    3.1.1
  - getReader
```
public static ExcelReader getReader(File bookFile)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    默认调用第一个sheet
    
    参数:
    bookFile - Excel文件
    
    返回:
    ExcelReader
  - getReader
```
public static ExcelReader getReader(String bookFilePath,
                    int sheetIndex)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    
    参数:
    bookFilePath - Excel文件路径，绝对路径或相对于ClassPath路径
    sheetIndex - sheet序号，0表示第一个sheet
    
    返回:
    ExcelReader
    从以下版本开始:
    
    3.1.1
  - getReader
```
public static ExcelReader getReader(File bookFile,
                    int sheetIndex)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    
    参数:
    bookFile - Excel文件
    sheetIndex - sheet序号，0表示第一个sheet
    
    返回:
    ExcelReader
  - getReader
```
public static ExcelReader getReader(File bookFile,
                    String sheetName)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    
    参数:
    bookFile - Excel文件
    sheetName - sheet名，第一个默认是sheet1
    
    返回:
    ExcelReader
  - getReader
```
public static ExcelReader getReader(InputStream bookStream)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    默认调用第一个sheet
    
    参数:
    bookStream - Excel文件的流
    
    返回:
    ExcelReader
  - getReader
```
public static ExcelReader getReader(InputStream bookStream,
                    int sheetIndex)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    
    参数:
    bookStream - Excel文件的流
    sheetIndex - sheet序号，0表示第一个sheet
    
    返回:
    ExcelReader
  - getReader
```
public static ExcelReader getReader(InputStream bookStream,
                    String sheetName)
```
    获取Excel读取器，通过调用ExcelReader的read或readXXX方法读取Excel内容
    
    参数:
    bookStream - Excel文件的流
    sheetName - sheet名，第一个默认是sheet1
    
    返回:
    ExcelReader
  - loadBook
```
public static org.apache.poi.ss.usermodel.Workbook loadBook(String excelFilePath)
```
    加载工作簿
    
    参数:
    excelFilePath - Excel文件路径，绝对路径或相对于ClassPath路径
    
    返回:
    Workbook
    从以下版本开始:
    
    3.1.1
  - loadBook
```
public static org.apache.poi.ss.usermodel.Workbook loadBook(File excelFile)
```
    加载工作簿
    
    参数:
    excelFile - Excel文件
    
    返回:
    Workbook
  - loadBook
```
public static org.apache.poi.ss.usermodel.Workbook loadBook(File excelFile,
                                            String password)
```
    加载工作簿
    
    参数:
    excelFile - Excel文件
    password - Excel工作簿密码，如果无密码传null
    
    返回:
    Workbook
  - loadBook
```
public static org.apache.poi.ss.usermodel.Workbook loadBook(InputStream in)
```
    加载工作簿
    
    参数:
    in - Excel输入流
    
    返回:
    Workbook
  - createBook
```
public static org.apache.poi.ss.usermodel.Workbook createBook(String destFilePath)
```
    根据文件路径创建新的工作簿，文件路径
    
    参数:
    destFilePath - 目标文件路径，文件可以不存在，通过扩展名判断Workbook类型
    
    返回:
    Workbook
    从以下版本开始:
    
    3.2.0
  - createBook
```
public static org.apache.poi.ss.usermodel.Workbook createBook(File destFile)
```
    根据文件路径创建新的工作簿
    
    参数:
    destFile - 目标文件，文件可以不存在
    
    返回:
    Workbook
    从以下版本开始:
    
    3.2.0
  - 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
  - getWriter
```
public static ExcelWriter getWriter()
```
    获得ExcelWriter，默认写出到第一个sheet
    不传入写出的Excel文件路径，只能调用ExcelWriter.flush(OutputStream)方法写出到流
    若写出到文件，还需调用ExcelWriter.setDestFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
    
    返回:
    ExcelWriter
    从以下版本开始:
    
    3.2.1
  - getWriter
```
public static ExcelWriter getWriter(boolean isXlsx)
```
    获得ExcelWriter，默认写出到第一个sheet
    不传入写出的Excel文件路径，只能调用ExcelWriter.flush(OutputStream)方法写出到流
    若写出到文件，还需调用ExcelWriter.setDestFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
    
    参数:
    isXlsx - 是否为xlsx格式
    
    返回:
    ExcelWriter
    从以下版本开始:
    
    3.2.1
  - getWriter
```
public static ExcelWriter getWriter(String destFilePath)
```
    获得ExcelWriter，默认写出到第一个sheet
    
    参数:
    destFilePath - 目标文件路径
    
    返回:
    ExcelWriter
  - getWriter
```
public static ExcelWriter getWriter(File destFile)
```
    获得ExcelWriter，默认写出到第一个sheet，名字为sheet1
    
    参数:
    destFile - 目标文件
    
    返回:
    ExcelWriter
  - getWriter
```
public static ExcelWriter getWriter(String destFilePath,
                    String sheetName)
```
    获得ExcelWriter
    
    参数:
    destFilePath - 目标文件路径
    sheetName - sheet表名
    
    返回:
    ExcelWriter
  - getWriter
```
public static ExcelWriter getWriter(File destFile,
                    String sheetName)
```
    获得ExcelWriter
    
    参数:
    destFile - 目标文件
    sheetName - sheet表名
    
    返回:
    ExcelWriter
  - isXls
```
public static boolean isXls(InputStream in)
```
    是否为XLS格式的Excel文件（HSSF）
    XLS文件主要用于Excel 97~2003创建
    
    参数:
    in - excel输入流
    
    返回:
    是否为XLS格式的Excel文件（HSSF）
  - isXlsx
```
public static boolean isXlsx(InputStream in)
```
    是否为XLSX格式的Excel文件（XSSF）
    XLSX文件主要用于Excel 2007+创建
    
    参数:
    in - excel输入流
    
    返回:
    是否为XLSX格式的Excel文件（XSSF）

类 ExcelUtil

构造器概要

方法概要

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

构造器详细资料

ExcelUtil

方法详细资料

readBySax

readBySax

readBySax

read07BySax

read07BySax

read07BySax

read03BySax

read03BySax

read03BySax

getReader

getReader

getReader

getReader

getReader

getReader

getReader

getReader

loadBook

loadBook

loadBook

loadBook

createBook

createBook

writeBook

getWriter

getWriter

getWriter

getWriter

getWriter

getWriter

isXls

isXlsx