ExcelWriter (hutool-poi 3.3.2 API)

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

所有已实现的接口:

Closeable, AutoCloseable
```
public class ExcelWriter
extends Object
implements Closeable
```
Excel 写入器
此工具用于通过POI将数据写出到Excel

从以下版本开始:

3.2.0

作者:

Looly

构造器概要

构造器
构造器和说明
`ExcelWriter()` 构造，默认生成xls格式的Excel文件此构造不传入写出的Excel文件路径，只能调用`flush(OutputStream)`方法写出到流若写出到文件，还需调用`setDestFile(File)`方法自定义写出的文件，然后调用`flush()`方法写出到文件
`ExcelWriter(boolean isXlsx)` 构造此构造不传入写出的Excel文件路径，只能调用`flush(OutputStream)`方法写出到流若写出到文件，还需调用`setDestFile(File)`方法自定义写出的文件，然后调用`flush()`方法写出到文件
`ExcelWriter(File destFile)` 构造，默认写出到第一个sheet，第一个sheet名为sheet1
`ExcelWriter(File destFile, String sheetName)` 构造
`ExcelWriter(String destFilePath)` 构造，默认写出到第一个sheet，第一个sheet名为sheet1
`ExcelWriter(String destFilePath, String sheetName)` 构造
`ExcelWriter(org.apache.poi.ss.usermodel.Workbook workbook, String sheetName)` 构造此构造不传入写出的Excel文件路径，只能调用`flush(OutputStream)`方法写出到流若写出到文件，还需调用`setDestFile(File)`方法自定义写出的文件，然后调用`flush()`方法写出到文件

方法概要

方法
限定符和类型	方法和说明
`ExcelWriter`	`autoSizeColumn(int columnIndex, boolean useMergedCells)` 设置某列为自动宽度
`void`	`close()` 关闭工作簿如果用户设定了目标文件，先写出目标文件后给关闭工作簿
`ExcelWriter`	`flush()` 将Excel Workbook刷出到预定义的文件如果用户未自定义输出的文件，将抛出`NullPointerException`
`ExcelWriter`	`flush(OutputStream out)` 将Excel Workbook刷出到输出流
`org.apache.poi.ss.usermodel.CellStyle`	`getCellStyle()` 获取单元格样式，获取样式后可自定义样式
`int`	`getCurrentRow()` 获得当前行
`org.apache.poi.ss.usermodel.CellStyle`	`getHeadCellStyle()` 获取头部样式，获取样式后可自定义样式
`org.apache.poi.ss.usermodel.Sheet`	`getSheet()` 获取当前Sheet
`org.apache.poi.ss.usermodel.Workbook`	`getWorkbook()` 获取Workbook
`ExcelWriter`	`merge(int lastColumn)` 合并当前行的单元格样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`merge(int lastColumn, Object content)` 合并某行的单元格，并写入对象到单元格如果写到单元格中的内容非null，行号自动+1，否则当前行号不变样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`passCurrentRow()` 跳过当前行
`ExcelWriter`	`passRows(int rows)` 跳过指定行数
`ExcelWriter`	`resetRow()` 重置当前行为0
`ExcelWriter`	`setCurrentRow(int rowIndex)` 设置当前所在行
`ExcelWriter`	`setDestFile(File destFile)` 设置写出的目标文件
`ExcelWriter`	`setHeaderAlias(Map<String,String> headerAlias)` 设置标题别名，key为Map中的key，value为别名
`ExcelWriter`	`write(Iterable<?> data)` 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动增加样式为默认样式，可使用`getCellStyle()`方法调用后自定义默认样式 data中元素支持的类型有： 1.
`<T> ExcelWriter`	`write(Iterable<T> data, Comparator<String> comparator)` 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动增加样式为默认样式，可使用`getCellStyle()`方法调用后自定义默认样式 data中元素支持的类型有： 1.
`ExcelWriter`	`writeHeadRow(Iterable<?> rowData)` 写出一行标题数据本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动+1 样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`writeRow(Iterable<?> rowData)` 写出一行数据本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动+1 样式为默认样式，可使用`getCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`writeRows(Map<?,?> rowMap, boolean isWriteKeys)` 将一个Map写入到Excel，isWriteKeys为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ExcelWriter
```
public ExcelWriter()
```
    构造，默认生成xls格式的Excel文件
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，还需调用setDestFile(File)方法自定义写出的文件，然后调用flush()方法写出到文件
    
    从以下版本开始:
    
    3.2.1
  - ExcelWriter
```
public ExcelWriter(boolean isXlsx)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，还需调用setDestFile(File)方法自定义写出的文件，然后调用flush()方法写出到文件
    
    参数:
    isXlsx - 是否为xlsx格式
    从以下版本开始:
    
    3.2.1
  - ExcelWriter
```
public ExcelWriter(String destFilePath)
```
    构造，默认写出到第一个sheet，第一个sheet名为sheet1
    
    参数:
    destFilePath - 目标文件路径，可以不存在
  - ExcelWriter
```
public ExcelWriter(String destFilePath,
           String sheetName)
```
    构造
    
    参数:
    destFilePath - 目标文件路径，可以不存在
    sheetName - sheet名，第一个sheet名并写出到此sheet，例如sheet1
  - ExcelWriter
```
public ExcelWriter(File destFile)
```
    构造，默认写出到第一个sheet，第一个sheet名为sheet1
    
    参数:
    destFile - 目标文件，可以不存在
  - ExcelWriter
```
public ExcelWriter(File destFile,
           String sheetName)
```
    构造
    
    参数:
    destFile - 目标文件，可以不存在
    sheetName - sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
  - ExcelWriter
```
public ExcelWriter(org.apache.poi.ss.usermodel.Workbook workbook,
           String sheetName)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，还需调用setDestFile(File)方法自定义写出的文件，然后调用flush()方法写出到文件
    
    参数:
    workbook - Workbook
    sheetName - sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
- 方法详细资料
  - getWorkbook
```
public org.apache.poi.ss.usermodel.Workbook getWorkbook()
```
    获取Workbook
    
    返回:
    Workbook
  - getSheet
```
public org.apache.poi.ss.usermodel.Sheet getSheet()
```
    获取当前Sheet
    
    返回:
    Sheet
  - autoSizeColumn
```
public ExcelWriter autoSizeColumn(int columnIndex,
                         boolean useMergedCells)
```
    设置某列为自动宽度
    
    参数:
    columnIndex - 第几列，从0计数
    useMergedCells - 是否适用于合并单元格
    
    返回:
    this
    从以下版本开始:
    
    3.3.0
  - getHeadCellStyle
```
public org.apache.poi.ss.usermodel.CellStyle getHeadCellStyle()
```
    获取头部样式，获取样式后可自定义样式
    
    返回:
    头部样式
  - getCellStyle
```
public org.apache.poi.ss.usermodel.CellStyle getCellStyle()
```
    获取单元格样式，获取样式后可自定义样式
    
    返回:
    单元格样式
  - getCurrentRow
```
public int getCurrentRow()
```
    获得当前行
    
    返回:
    当前行
  - setCurrentRow
```
public ExcelWriter setCurrentRow(int rowIndex)
```
    设置当前所在行
    
    参数:
    rowIndex - 行号
    
    返回:
    this
  - passCurrentRow
```
public ExcelWriter passCurrentRow()
```
    跳过当前行
    
    返回:
    this
  - passRows
```
public ExcelWriter passRows(int rows)
```
    跳过指定行数
    
    参数:
    rows - 跳过的行数
    
    返回:
    this
  - resetRow
```
public ExcelWriter resetRow()
```
    重置当前行为0
    
    返回:
    this
  - setDestFile
```
public ExcelWriter setDestFile(File destFile)
```
    设置写出的目标文件
    
    参数:
    destFile - 目标文件
    
    返回:
    this
  - setHeaderAlias
```
public ExcelWriter setHeaderAlias(Map<String,String> headerAlias)
```
    设置标题别名，key为Map中的key，value为别名
    
    参数:
    headerAlias - 标题别名
    
    返回:
    this
    从以下版本开始:
    
    3.2.1
  - merge
```
public ExcelWriter merge(int lastColumn)
```
    合并当前行的单元格
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    参数:
    lastColumn - 合并到的最后一个列号
    
    返回:
    this
  - merge
```
public ExcelWriter merge(int lastColumn,
                Object content)
```
    合并某行的单元格，并写入对象到单元格
    如果写到单元格中的内容非null，行号自动+1，否则当前行号不变
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    参数:
    lastColumn - 合并到的最后一个列号
    content - 合并单元格后的内容
    
    返回:
    this
  - write
```
public ExcelWriter write(Iterable<?> data)
```
    写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动增加
    样式为默认样式，可使用getCellStyle()方法调用后自定义默认样式
    data中元素支持的类型有：
    1. Iterable，既元素为一个集合，元素被当作一行，data表示多行
    2. Map，既元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
    3. Bean，既元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
    4. 无法识别，不输出
    
    参数:
    data - 数据
    
    返回:
    this
  - write
```
public <T> ExcelWriter write(Iterable<T> data,
                    Comparator<String> comparator)
```
    写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动增加
    样式为默认样式，可使用getCellStyle()方法调用后自定义默认样式
    data中元素支持的类型有：
    1. Map，既元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
    2. Bean，既元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
    
    参数:
    data - 数据
    comparator - 比较器
    
    返回:
    this
    从以下版本开始:
    
    3.2.3
  - writeHeadRow
```
public ExcelWriter writeHeadRow(Iterable<?> rowData)
```
    写出一行标题数据
    本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动+1
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    参数:
    rowData - 一行的数据
    
    返回:
    this
  - writeRow
```
public ExcelWriter writeRow(Iterable<?> rowData)
```
    写出一行数据
    本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动+1
    样式为默认样式，可使用getCellStyle()方法调用后自定义默认样式
    
    参数:
    rowData - 一行的数据
    
    返回:
    this
  - writeRows
```
public ExcelWriter writeRows(Map<?,?> rowMap,
                    boolean isWriteKeys)
```
    将一个Map写入到Excel，isWriteKeys为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
    
    参数:
    rowMap - 写出的Map
    isWriteKeys - 为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
    
    返回:
    this
  - flush
```
public ExcelWriter flush()
                  throws IORuntimeException
```
    将Excel Workbook刷出到预定义的文件
    如果用户未自定义输出的文件，将抛出NullPointerException
    
    返回:
    this
    
    抛出:
    
    IORuntimeException - IO异常
  - flush
```
public ExcelWriter flush(OutputStream out)
                  throws IORuntimeException
```
    将Excel Workbook刷出到输出流
    
    参数:
    out - 输出流
    
    返回:
    this
    
    抛出:
    
    IORuntimeException - IO异常
  - close
```
public void close()
```
    关闭工作簿
    如果用户设定了目标文件，先写出目标文件后给关闭工作簿
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable

类 ExcelWriter

构造器概要

方法概要

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

构造器详细资料

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

方法详细资料

getWorkbook

getSheet

autoSizeColumn

getHeadCellStyle

getCellStyle

getCurrentRow

setCurrentRow

passCurrentRow

passRows

resetRow

setDestFile

setHeaderAlias

merge

merge

write

write

writeHeadRow

writeRow

writeRows

flush

flush

close