ExcelWriter (hutool-码云(gitee.com))

java.lang.Object
- cn.hutool.poi.excel.ExcelBase<ExcelWriter>
- - cn.hutool.poi.excel.ExcelWriter

All Implemented Interfaces:: Closeable, AutoCloseable

Direct Known Subclasses:: BigExcelWriter

public class ExcelWriter
extends ExcelBase<ExcelWriter>

Excel 写入器
此工具用于通过POI将数据写出到Excel，此对象可完成以下两个功能

 1. 编辑已存在的Excel，可写出原Excel文件，也可写出到其它地方（到文件或到流）
 2. 新建一个空的Excel工作簿，完成数据填充后写出（到文件或到流）

Since:: 3.2.0
Author:: Looly

Field Summary

Fields
Modifier and Type Field and Description

protected File destFile
目标文件
- Fields inherited from class cn.hutool.poi.excel.ExcelBase
  isClosed, sheet, workbook

Fields
Modifier and Type	Field and Description
`protected File`	`destFile` 目标文件

Constructor Summary

Constructors
Constructor and Description
`ExcelWriter()` 构造，默认生成xls格式的Excel文件此构造不传入写出的Excel文件路径，只能调用`flush(OutputStream)`方法写出到流若写出到文件，还需调用`setDestFile(File)`方法自定义写出的文件，然后调用`flush()`方法写出到文件
`ExcelWriter(boolean isXlsx)` 构造此构造不传入写出的Excel文件路径，只能调用`flush(OutputStream)`方法写出到流若写出到文件，需要调用`flush(File)` 写出到文件
`ExcelWriter(boolean isXlsx, String sheetName)` 构造此构造不传入写出的Excel文件路径，只能调用`flush(OutputStream)`方法写出到流若写出到文件，需要调用`flush(File)` 写出到文件
`ExcelWriter(File destFile)` 构造，默认写出到第一个sheet，第一个sheet名为sheet1
`ExcelWriter(File destFile, String sheetName)` 构造
`ExcelWriter(org.apache.poi.ss.usermodel.Sheet sheet)` 构造此构造不传入写出的Excel文件路径，只能调用`flush(OutputStream)`方法写出到流若写出到文件，还需调用`setDestFile(File)`方法自定义写出的文件，然后调用`flush()`方法写出到文件
`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()`方法写出到文件

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ExcelWriter`	`addHeaderAlias(String name, String alias)` 增加标题别名
`ExcelWriter`	`addSelect(org.apache.poi.ss.util.CellRangeAddressList regions, String... selectList)` 增加下拉列表
`ExcelWriter`	`addSelect(int x, int y, String... selectList)` 增加下拉列表
`ExcelWriter`	`addValidationData(org.apache.poi.ss.usermodel.DataValidation dataValidation)` 增加单元格控制，比如下拉列表、日期验证、数字范围验证等
`ExcelWriter`	`autoSizeColumn(int columnIndex)` 设置某列为自动宽度，不考虑合并单元格此方法必须在指定列数据完全写出后调用才有效。
`ExcelWriter`	`autoSizeColumn(int columnIndex, boolean useMergedCells)` 设置某列为自动宽度此方法必须在指定列数据完全写出后调用才有效。
`ExcelWriter`	`autoSizeColumnAll()` 设置所有列为自动宽度，不考虑合并单元格此方法必须在指定列数据完全写出后调用才有效。列数计算是通过第一行计算的
`ExcelWriter`	`clearHeaderAlias()` 清空标题别名，key为Map中的key，value为别名
`void`	`close()` 关闭工作簿如果用户设定了目标文件，先写出目标文件后给关闭工作簿
`protected void`	`closeWithoutFlush()` 关闭工作簿但是不写出
`org.apache.poi.ss.usermodel.Font`	`createFont()` 创建字体
`org.apache.poi.ss.usermodel.CellStyle`	`createStyleForCell(int x, int y)` Deprecated. 请使用 `ExcelBase.createCellStyle(int, int)`
`ExcelWriter`	`disableDefaultStyle()` 禁用默认样式
`ExcelWriter`	`flush()` 将Excel Workbook刷出到预定义的文件如果用户未自定义输出的文件，将抛出`NullPointerException` 预定义文件可以通过`setDestFile(File)` 方法预定义，或者通过构造定义
`ExcelWriter`	`flush(File destFile)` 将Excel Workbook刷出到文件如果用户未自定义输出的文件，将抛出`NullPointerException`
`ExcelWriter`	`flush(OutputStream out)` 将Excel Workbook刷出到输出流
`ExcelWriter`	`flush(OutputStream out, boolean isCloseOut)` 将Excel Workbook刷出到输出流
`org.apache.poi.ss.usermodel.CellStyle`	`getCellStyle()` 获取单元格样式，获取样式后可自定义样式
`int`	`getCurrentRow()` 获得当前行
`String`	`getDisposition(String fileName, Charset charset)` 获取Content-Disposition头对应的值，可以通过调用以下方法快速设置下载Excel的头信息：
`org.apache.poi.ss.usermodel.CellStyle`	`getHeadCellStyle()` 获取头部样式，获取样式后可自定义样式
`StyleSet`	`getStyleSet()` 获取样式集，样式集可以自定义包括：
`ExcelWriter`	`merge(int lastColumn)` 合并当前行的单元格样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`merge(int firstRow, int lastRow, int firstColumn, int lastColumn, Object content, boolean isSetHeaderStyle)` 合并某行的单元格，并写入对象到单元格如果写到单元格中的内容非null，行号自动+1，否则当前行号不变样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`merge(int lastColumn, Object content)` 合并当前行的单元格，并写入对象到单元格如果写到单元格中的内容非null，行号自动+1，否则当前行号不变样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`merge(int lastColumn, Object content, boolean isSetHeaderStyle)` 合并某行的单元格，并写入对象到单元格如果写到单元格中的内容非null，行号自动+1，否则当前行号不变样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`passCurrentRow()` 跳过当前行
`ExcelWriter`	`passRows(int rows)` 跳过指定行数
`ExcelWriter`	`renameSheet(int sheet, String sheetName)` 重命名sheet
`ExcelWriter`	`renameSheet(String sheetName)` 重命名当前sheet
`ExcelWriter`	`reset()` 重置Writer，包括：
`ExcelWriter`	`resetRow()` 重置当前行为0
`ExcelWriter`	`setColumnWidth(int columnIndex, int width)` 设置列宽（单位为一个字符的宽度，例如传入width为10，表示10个字符的宽度）
`ExcelWriter`	`setCurrentRow(int rowIndex)` 设置当前所在行
`ExcelWriter`	`setCurrentRowToEnd()` 定位到最后一行的后边，用于追加数据
`ExcelWriter`	`setDefaultRowHeight(int height)` 设置默认行高，值为一个点的高度
`ExcelWriter`	`setDestFile(File destFile)` 设置写出的目标文件
`ExcelWriter`	`setFreezePane(int rowSplit)` 设置窗口冻结，之前冻结的窗口会被覆盖，如果rowSplit为0表示取消冻结
`ExcelWriter`	`setFreezePane(int colSplit, int rowSplit)` 设置窗口冻结，之前冻结的窗口会被覆盖，如果colSplit和rowSplit为0表示取消冻结
`ExcelWriter`	`setHeaderAlias(Map<String,String> headerAlias)` 设置标题别名，key为Map中的key，value为别名
`ExcelWriter`	`setHeaderOrFooter(String text, Align align, boolean isFooter)` 设置Excel页眉或页脚
`ExcelWriter`	`setOnlyAlias(boolean isOnlyAlias)` 设置是否只保留别名中的字段值，如果为true，则不设置alias的字段将不被输出，false表示原样输出
`ExcelWriter`	`setRowHeight(int rownum, int height)` 设置行高，值为一个点的高度
`ExcelWriter`	`setRowStyle(int y, org.apache.poi.ss.usermodel.CellStyle style)` 设置行样式
`ExcelWriter`	`setSheet(int sheetIndex)` 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认）在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet
`ExcelWriter`	`setSheet(String sheetName)` 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之。在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet。
`ExcelWriter`	`setStyle(org.apache.poi.ss.usermodel.CellStyle style, int x, int y)` 设置某个单元格的样式此方法用于多个单元格共享样式的情况可以调用`ExcelBase.getOrCreateCellStyle(int, int)` 方法创建或取得一个样式对象。
`ExcelWriter`	`setStyle(org.apache.poi.ss.usermodel.CellStyle style, String locationRef)` 设置某个单元格的样式此方法用于多个单元格共享样式的情况可以调用`ExcelBase.getOrCreateCellStyle(int, int)` 方法创建或取得一个样式对象。
`ExcelWriter`	`setStyleSet(StyleSet styleSet)` 设置样式集，如果不使用样式，传入`null`
`ExcelWriter`	`write(Iterable<?> data)` 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动增加样式为默认样式，可使用`getCellStyle()`方法调用后自定义默认样式默认的，当当前行号为0时，写出标题（如果为Map或Bean），否则不写标题
`ExcelWriter`	`write(Iterable<?> data, boolean isWriteKeyAsHead)` 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动增加样式为默认样式，可使用`getCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`write(Iterable<?> data, Comparator<String> comparator)` 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动增加样式为默认样式，可使用`getCellStyle()`方法调用后自定义默认样式 data中元素支持的类型有：
`ExcelWriter`	`writeCellValue(int x, int y, Object value)` 给指定单元格赋值，使用默认单元格样式
`ExcelWriter`	`writeCellValue(String locationRef, Object value)` 给指定单元格赋值，使用默认单元格样式
`ExcelWriter`	`writeHeadRow(Iterable<?> rowData)` 写出一行标题数据本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动+1 样式为默认标题样式，可使用`getHeadCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`writeRow(Iterable<?> rowData)` 写出一行数据本方法只是将数据写入Workbook中的Sheet，并不写出到文件写出的起始行为当前行号，可使用`getCurrentRow()`方法调用，根据写出的的行数，当前行号自动+1 样式为默认样式，可使用`getCellStyle()`方法调用后自定义默认样式
`ExcelWriter`	`writeRow(Map<?,?> rowMap, boolean isWriteKeyAsHead)` 将一个Map写入到Excel，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values 如果rowMap为空（包括null），则写出空行
`ExcelWriter`	`writeRow(Object rowBean, boolean isWriteKeyAsHead)` 写出一行，根据rowBean数据类型不同，写出情况如下：

Methods inherited from class cn.hutool.poi.excel.ExcelBase
createCellStyle, createCellStyle, createCellStyle, createColumnStyle, createRowStyle, getCell, getCell, getCell, getCell, getColumnCount, getColumnCount, getOrCreateCell, getOrCreateCell, getOrCreateCellStyle, getOrCreateCellStyle, getOrCreateColumnStyle, getOrCreateRow, getOrCreateRowStyle, getPhysicalRowCount, getRowCount, getSheet, getSheetCount, getSheetNames, getSheets, getWorkbook, isXlsx, setSheet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - destFile
```
protected File destFile
```
    目标文件
- Constructor Detail
  - ExcelWriter
```
public ExcelWriter()
```
    构造，默认生成xls格式的Excel文件
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，还需调用setDestFile(File)方法自定义写出的文件，然后调用flush()方法写出到文件
    
    Since:
    
    3.2.1
  - ExcelWriter
```
public ExcelWriter(boolean isXlsx)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，需要调用flush(File) 写出到文件
    
    Parameters:
    
    isXlsx - 是否为xlsx格式
    
    Since:
    
    3.2.1
  - ExcelWriter
```
public ExcelWriter(String destFilePath)
```
    构造，默认写出到第一个sheet，第一个sheet名为sheet1
    
    Parameters:
    
    destFilePath - 目标文件路径，可以不存在
  - ExcelWriter
```
public ExcelWriter(boolean isXlsx,
                   String sheetName)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，需要调用flush(File) 写出到文件
    
    Parameters:
    
    isXlsx - 是否为xlsx格式
    
    sheetName - sheet名，第一个sheet名并写出到此sheet，例如sheet1
    
    Since:
    
    4.1.8
  - ExcelWriter
```
public ExcelWriter(String destFilePath,
                   String sheetName)
```
    构造
    
    Parameters:
    
    destFilePath - 目标文件路径，可以不存在
    
    sheetName - sheet名，第一个sheet名并写出到此sheet，例如sheet1
  - ExcelWriter
```
public ExcelWriter(File destFile)
```
    构造，默认写出到第一个sheet，第一个sheet名为sheet1
    
    Parameters:
    
    destFile - 目标文件，可以不存在
  - ExcelWriter
```
public ExcelWriter(File destFile,
                   String sheetName)
```
    构造
    
    Parameters:
    
    destFile - 目标文件，可以不存在
    
    sheetName - sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
  - ExcelWriter
```
public ExcelWriter(org.apache.poi.ss.usermodel.Workbook workbook,
                   String sheetName)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，还需调用setDestFile(File)方法自定义写出的文件，然后调用flush()方法写出到文件
    
    Parameters:
    
    workbook - Workbook
    
    sheetName - sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
  - ExcelWriter
```
public ExcelWriter(org.apache.poi.ss.usermodel.Sheet sheet)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用flush(OutputStream)方法写出到流
    若写出到文件，还需调用setDestFile(File)方法自定义写出的文件，然后调用flush()方法写出到文件
    
    Parameters:
    
    sheet - Sheet
    
    Since:
    
    4.0.6
- Method Detail
  - setSheet
```
public ExcelWriter setSheet(int sheetIndex)
```
    Description copied from class: ExcelBase
    
    自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认）
    在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet
    
    Overrides:
    
    setSheet in class ExcelBase<ExcelWriter>
    
    Parameters:
    
    sheetIndex - sheet序号，从0开始计数
    
    Returns:
    
    this
  - setSheet
```
public ExcelWriter setSheet(String sheetName)
```
    Description copied from class: ExcelBase
    
    自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之。
    在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet。
    
    Overrides:
    
    setSheet in class ExcelBase<ExcelWriter>
    
    Parameters:
    
    sheetName - sheet名
    
    Returns:
    
    this
  - reset
```
public ExcelWriter reset()
```
    重置Writer，包括：
```
 1. 当前行游标归零
 2. 清空别名比较器
 3. 清除标题缓存
 
```
    Returns:
    
    this
  - renameSheet
```
public ExcelWriter renameSheet(String sheetName)
```
    重命名当前sheet
    
    Parameters:
    
    sheetName - 新的sheet名
    
    Returns:
    
    this
    
    Since:
    
    4.1.8
  - renameSheet
```
public ExcelWriter renameSheet(int sheet,
                               String sheetName)
```
    重命名sheet
    
    Parameters:
    
    sheet - sheet序号，0表示第一个sheet
    
    sheetName - 新的sheet名
    
    Returns:
    
    this
    
    Since:
    
    4.1.8
  - autoSizeColumnAll
```
public ExcelWriter autoSizeColumnAll()
```
    设置所有列为自动宽度，不考虑合并单元格
    此方法必须在指定列数据完全写出后调用才有效。
    列数计算是通过第一行计算的
    
    Returns:
    
    this
    
    Since:
    
    4.0.12
  - autoSizeColumn
```
public ExcelWriter autoSizeColumn(int columnIndex)
```
    设置某列为自动宽度，不考虑合并单元格
    此方法必须在指定列数据完全写出后调用才有效。
    
    Parameters:
    
    columnIndex - 第几列，从0计数
    
    Returns:
    
    this
    
    Since:
    
    4.0.12
  - autoSizeColumn
```
public ExcelWriter autoSizeColumn(int columnIndex,
                                  boolean useMergedCells)
```
    设置某列为自动宽度
    此方法必须在指定列数据完全写出后调用才有效。
    
    Parameters:
    
    columnIndex - 第几列，从0计数
    
    useMergedCells - 是否适用于合并单元格
    
    Returns:
    
    this
    
    Since:
    
    3.3.0
  - disableDefaultStyle
```
public ExcelWriter disableDefaultStyle()
```
    禁用默认样式
    
    Returns:
    
    this
    
    Since:
    
    4.6.3
    
    See Also:
    
    setStyleSet(StyleSet)
  - setStyleSet
```
public ExcelWriter setStyleSet(StyleSet styleSet)
```
    设置样式集，如果不使用样式，传入null
    
    Parameters:
    
    styleSet - 样式集，null表示无样式
    
    Returns:
    
    this
    
    Since:
    
    4.1.11
  - getStyleSet
```
public StyleSet getStyleSet()
```
    获取样式集，样式集可以自定义包括：
```
 1. 头部样式
 2. 一般单元格样式
 3. 默认数字样式
 4. 默认日期样式
 
```
    Returns:
    
    样式集
    
    Since:
    
    4.0.0
  - getHeadCellStyle
```
public org.apache.poi.ss.usermodel.CellStyle getHeadCellStyle()
```
    获取头部样式，获取样式后可自定义样式
    
    Returns:
    
    头部样式
  - getCellStyle
```
public org.apache.poi.ss.usermodel.CellStyle getCellStyle()
```
    获取单元格样式，获取样式后可自定义样式
    
    Returns:
    
    单元格样式
  - getCurrentRow
```
public int getCurrentRow()
```
    获得当前行
    
    Returns:
    
    当前行
  - getDisposition
```
public String getDisposition(String fileName,
                             Charset charset)
```
    获取Content-Disposition头对应的值，可以通过调用以下方法快速设置下载Excel的头信息：
```
 response.setHeader("Content-Disposition", excelWriter.getDisposition("test.xlsx", CharsetUtil.CHARSET_UTF_8));
 
```
    Parameters:
    
    fileName - 文件名，如果文件名没有扩展名，会自动按照生成Excel类型补齐扩展名，如果提供空，使用随机UUID
    
    charset - 编码，null则使用默认UTF-8编码
    
    Returns:
    
    Content-Disposition值
  - setCurrentRow
```
public ExcelWriter setCurrentRow(int rowIndex)
```
    设置当前所在行
    
    Parameters:
    
    rowIndex - 行号
    
    Returns:
    
    this
  - setCurrentRowToEnd
```
public ExcelWriter setCurrentRowToEnd()
```
    定位到最后一行的后边，用于追加数据
    
    Returns:
    
    this
    
    Since:
    
    5.5.0
  - passCurrentRow
```
public ExcelWriter passCurrentRow()
```
    跳过当前行
    
    Returns:
    
    this
  - passRows
```
public ExcelWriter passRows(int rows)
```
    跳过指定行数
    
    Parameters:
    
    rows - 跳过的行数
    
    Returns:
    
    this
  - resetRow
```
public ExcelWriter resetRow()
```
    重置当前行为0
    
    Returns:
    
    this
  - setDestFile
```
public ExcelWriter setDestFile(File destFile)
```
    设置写出的目标文件
    
    Parameters:
    
    destFile - 目标文件
    
    Returns:
    
    this
  - setHeaderAlias
```
public ExcelWriter setHeaderAlias(Map<String,String> headerAlias)
```
    设置标题别名，key为Map中的key，value为别名
    
    Parameters:
    
    headerAlias - 标题别名
    
    Returns:
    
    this
    
    Since:
    
    3.2.1
  - clearHeaderAlias
```
public ExcelWriter clearHeaderAlias()
```
    清空标题别名，key为Map中的key，value为别名
    
    Returns:
    
    this
    
    Since:
    
    4.5.4
  - setOnlyAlias
```
public ExcelWriter setOnlyAlias(boolean isOnlyAlias)
```
    设置是否只保留别名中的字段值，如果为true，则不设置alias的字段将不被输出，false表示原样输出
    
    Parameters:
    
    isOnlyAlias - 是否只保留别名中的字段值
    
    Returns:
    
    this
    
    Since:
    
    4.1.22
  - addHeaderAlias
```
public ExcelWriter addHeaderAlias(String name,
                                  String alias)
```
    增加标题别名
    
    Parameters:
    
    name - 原标题
    
    alias - 别名
    
    Returns:
    
    this
    
    Since:
    
    4.1.5
  - setFreezePane
```
public ExcelWriter setFreezePane(int rowSplit)
```
    设置窗口冻结，之前冻结的窗口会被覆盖，如果rowSplit为0表示取消冻结
    
    Parameters:
    
    rowSplit - 冻结的行及行数，2表示前两行
    
    Returns:
    
    this
    
    Since:
    
    5.2.5
  - setFreezePane
```
public ExcelWriter setFreezePane(int colSplit,
                                 int rowSplit)
```
    设置窗口冻结，之前冻结的窗口会被覆盖，如果colSplit和rowSplit为0表示取消冻结
    
    Parameters:
    
    colSplit - 冻结的列及列数，2表示前两列
    
    rowSplit - 冻结的行及行数，2表示前两行
    
    Returns:
    
    this
    
    Since:
    
    5.2.5
  - setColumnWidth
```
public ExcelWriter setColumnWidth(int columnIndex,
                                  int width)
```
    设置列宽（单位为一个字符的宽度，例如传入width为10，表示10个字符的宽度）
    
    Parameters:
    
    columnIndex - 列号（从0开始计数，-1表示所有列的默认宽度）
    
    width - 宽度（单位1~256个字符宽度）
    
    Returns:
    
    this
    
    Since:
    
    4.0.8
  - setDefaultRowHeight
```
public ExcelWriter setDefaultRowHeight(int height)
```
    设置默认行高，值为一个点的高度
    
    Parameters:
    
    height - 高度
    
    Returns:
    
    this
    
    Since:
    
    4.6.5
  - setRowHeight
```
public ExcelWriter setRowHeight(int rownum,
                                int height)
```
    设置行高，值为一个点的高度
    
    Parameters:
    
    rownum - 行号（从0开始计数，-1表示所有行的默认高度）
    
    height - 高度
    
    Returns:
    
    this
    
    Since:
    
    4.0.8
  - setHeaderOrFooter
```
public ExcelWriter setHeaderOrFooter(String text,
                                     Align align,
                                     boolean isFooter)
```
    设置Excel页眉或页脚
    
    Parameters:
    
    text - 页脚的文本
    
    align - 对齐方式枚举 Align
    
    isFooter - 是否为页脚，false表示页眉，true表示页脚
    
    Returns:
    
    this
    
    Since:
    
    4.1.0
  - addSelect
```
public ExcelWriter addSelect(int x,
                             int y,
                             String... selectList)
```
    增加下拉列表
    
    Parameters:
    
    x - x坐标，列号，从0开始
    
    y - y坐标，行号，从0开始
    
    selectList - 下拉列表
    
    Returns:
    
    this
    
    Since:
    
    4.6.2
  - addSelect
```
public ExcelWriter addSelect(org.apache.poi.ss.util.CellRangeAddressList regions,
                             String... selectList)
```
    增加下拉列表
    
    Parameters:
    
    regions - CellRangeAddressList 指定下拉列表所占的单元格范围
    
    selectList - 下拉列表内容
    
    Returns:
    
    this
    
    Since:
    
    4.6.2
  - addValidationData
```
public ExcelWriter addValidationData(org.apache.poi.ss.usermodel.DataValidation dataValidation)
```
    增加单元格控制，比如下拉列表、日期验证、数字范围验证等
    
    Parameters:
    
    dataValidation - DataValidation
    
    Returns:
    
    this
    
    Since:
    
    4.6.2
  - merge
```
public ExcelWriter merge(int lastColumn)
```
    合并当前行的单元格
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    Parameters:
    
    lastColumn - 合并到的最后一个列号
    
    Returns:
    
    this
  - merge
```
public ExcelWriter merge(int lastColumn,
                         Object content)
```
    合并当前行的单元格，并写入对象到单元格
    如果写到单元格中的内容非null，行号自动+1，否则当前行号不变
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    Parameters:
    
    lastColumn - 合并到的最后一个列号
    
    content - 合并单元格后的内容
    
    Returns:
    
    this
  - merge
```
public ExcelWriter merge(int lastColumn,
                         Object content,
                         boolean isSetHeaderStyle)
```
    合并某行的单元格，并写入对象到单元格
    如果写到单元格中的内容非null，行号自动+1，否则当前行号不变
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    Parameters:
    
    lastColumn - 合并到的最后一个列号
    
    content - 合并单元格后的内容
    
    isSetHeaderStyle - 是否为合并后的单元格设置默认标题样式，只提取边框样式
    
    Returns:
    
    this
    
    Since:
    
    4.0.10
  - merge
```
public ExcelWriter merge(int firstRow,
                         int lastRow,
                         int firstColumn,
                         int lastColumn,
                         Object content,
                         boolean isSetHeaderStyle)
```
    合并某行的单元格，并写入对象到单元格
    如果写到单元格中的内容非null，行号自动+1，否则当前行号不变
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    Parameters:
    
    firstRow - 起始行，0开始
    
    lastRow - 结束行，0开始
    
    firstColumn - 起始列，0开始
    
    lastColumn - 结束列，0开始
    
    content - 合并单元格后的内容
    
    isSetHeaderStyle - 是否为合并后的单元格设置默认标题样式，只提取边框样式
    
    Returns:
    
    this
    
    Since:
    
    4.0.10
  - write
```
public ExcelWriter write(Iterable<?> data)
```
    写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动增加
    样式为默认样式，可使用getCellStyle()方法调用后自定义默认样式
    默认的，当当前行号为0时，写出标题（如果为Map或Bean），否则不写标题
    data中元素支持的类型有：
```
 1. Iterable，即元素为一个集合，元素被当作一行，data表示多行

 2. Map，即元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行 

 3. Bean，即元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行 

 4. 其它类型，按照基本类型输出（例如字符串）
 
```
    Parameters:
    
    data - 数据
    
    Returns:
    
    this
  - write
```
public ExcelWriter write(Iterable<?> data,
                         boolean isWriteKeyAsHead)
```
    写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动增加
    样式为默认样式，可使用getCellStyle()方法调用后自定义默认样式
    data中元素支持的类型有：
```
 1. Iterable，即元素为一个集合，元素被当作一行，data表示多行

 2. Map，即元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行 

 3. Bean，即元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行 

 4. 其它类型，按照基本类型输出（例如字符串）
 
```
    Parameters:
    
    data - 数据
    
    isWriteKeyAsHead - 是否强制写出标题行（Map或Bean）
    
    Returns:
    
    this
  - write
```
public ExcelWriter write(Iterable<?> data,
                         Comparator<String> comparator)
```
    写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动增加
    样式为默认样式，可使用getCellStyle()方法调用后自定义默认样式
    data中元素支持的类型有：
    1. Map，即元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
    2. Bean，即元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
    
    Parameters:
    
    data - 数据
    
    comparator - 比较器，用于字段名的排序
    
    Returns:
    
    this
    
    Since:
    
    3.2.3
  - writeHeadRow
```
public ExcelWriter writeHeadRow(Iterable<?> rowData)
```
    写出一行标题数据
    本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动+1
    样式为默认标题样式，可使用getHeadCellStyle()方法调用后自定义默认样式
    
    Parameters:
    
    rowData - 一行的数据
    
    Returns:
    
    this
  - writeRow
```
public ExcelWriter writeRow(Object rowBean,
                            boolean isWriteKeyAsHead)
```
    写出一行，根据rowBean数据类型不同，写出情况如下：
```
 1、如果为Iterable，直接写出一行
 2、如果为Map，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
 3、如果为Bean，转为Map写出，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
 
```
    Parameters:
    
    rowBean - 写出的Bean
    
    isWriteKeyAsHead - 为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
    
    Returns:
    
    this
    
    Since:
    
    4.1.5
    
    See Also:
    
    writeRow(Iterable), writeRow(Map, boolean)
  - writeRow
```
public ExcelWriter writeRow(Map<?,?> rowMap,
                            boolean isWriteKeyAsHead)
```
    将一个Map写入到Excel，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
    如果rowMap为空（包括null），则写出空行
    
    Parameters:
    
    rowMap - 写出的Map，为空（包括null），则写出空行
    
    isWriteKeyAsHead - 为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
    
    Returns:
    
    this
  - writeRow
```
public ExcelWriter writeRow(Iterable<?> rowData)
```
    写出一行数据
    本方法只是将数据写入Workbook中的Sheet，并不写出到文件
    写出的起始行为当前行号，可使用getCurrentRow()方法调用，根据写出的的行数，当前行号自动+1
    样式为默认样式，可使用getCellStyle()方法调用后自定义默认样式
    
    Parameters:
    
    rowData - 一行的数据
    
    Returns:
    
    this
  - writeCellValue
```
public ExcelWriter writeCellValue(String locationRef,
                                  Object value)
```
    给指定单元格赋值，使用默认单元格样式
    
    Parameters:
    
    locationRef - 单元格地址标识符，例如A11，B5
    
    value - 值
    
    Returns:
    
    this
    
    Since:
    
    5.1.4
  - writeCellValue
```
public ExcelWriter writeCellValue(int x,
                                  int y,
                                  Object value)
```
    给指定单元格赋值，使用默认单元格样式
    
    Parameters:
    
    x - X坐标，从0计数，即列号
    
    y - Y坐标，从0计数，即行号
    
    value - 值
    
    Returns:
    
    this
    
    Since:
    
    4.0.2
  - createStyleForCell
```
@Deprecated
public org.apache.poi.ss.usermodel.CellStyle createStyleForCell(int x,
                                                                            int y)
```
    Deprecated. 请使用 ExcelBase.createCellStyle(int, int)
    
    为指定单元格创建样式
    
    Parameters:
    
    x - X坐标，从0计数，即列号
    
    y - Y坐标，从0计数，即行号
    
    Returns:
    
    CellStyle
    
    Since:
    
    4.0.9
  - setStyle
```
public ExcelWriter setStyle(org.apache.poi.ss.usermodel.CellStyle style,
                            String locationRef)
```
    设置某个单元格的样式
    此方法用于多个单元格共享样式的情况
    可以调用ExcelBase.getOrCreateCellStyle(int, int) 方法创建或取得一个样式对象。
    需要注意的是，共享样式会共享同一个CellStyle，一个单元格样式改变，全部改变。
    
    Parameters:
    
    style - 单元格样式
    
    locationRef - 单元格地址标识符，例如A11，B5
    
    Returns:
    
    this
    
    Since:
    
    5.1.4
  - setStyle
```
public ExcelWriter setStyle(org.apache.poi.ss.usermodel.CellStyle style,
                            int x,
                            int y)
```
    设置某个单元格的样式
    此方法用于多个单元格共享样式的情况
    可以调用ExcelBase.getOrCreateCellStyle(int, int) 方法创建或取得一个样式对象。
    需要注意的是，共享样式会共享同一个CellStyle，一个单元格样式改变，全部改变。
    
    Parameters:
    
    style - 单元格样式
    
    x - X坐标，从0计数，即列号
    
    y - Y坐标，从0计数，即行号
    
    Returns:
    
    this
    
    Since:
    
    4.6.3
  - setRowStyle
```
public ExcelWriter setRowStyle(int y,
                               org.apache.poi.ss.usermodel.CellStyle style)
```
    设置行样式
    
    Parameters:
    
    y - Y坐标，从0计数，即行号
    
    style - 样式
    
    Returns:
    
    this
    
    Since:
    
    5.4.5
    
    See Also:
    
    Row.setRowStyle(CellStyle)
  - createFont
```
public org.apache.poi.ss.usermodel.Font createFont()
```
    创建字体
    
    Returns:
    
    字体
    
    Since:
    
    4.1.0
  - flush
```
public ExcelWriter flush()
                  throws IORuntimeException
```
    将Excel Workbook刷出到预定义的文件
    如果用户未自定义输出的文件，将抛出NullPointerException
    预定义文件可以通过setDestFile(File) 方法预定义，或者通过构造定义
    
    Returns:
    
    this
    
    Throws:
    
    IORuntimeException - IO异常
  - flush
```
public ExcelWriter flush(File destFile)
                  throws IORuntimeException
```
    将Excel Workbook刷出到文件
    如果用户未自定义输出的文件，将抛出NullPointerException
    
    Parameters:
    
    destFile - 写出到的文件
    
    Returns:
    
    this
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    4.0.6
  - flush
```
public ExcelWriter flush(OutputStream out)
                  throws IORuntimeException
```
    将Excel Workbook刷出到输出流
    
    Parameters:
    
    out - 输出流
    
    Returns:
    
    this
    
    Throws:
    
    IORuntimeException - IO异常
  - flush
```
public ExcelWriter flush(OutputStream out,
                         boolean isCloseOut)
                  throws IORuntimeException
```
    将Excel Workbook刷出到输出流
    
    Parameters:
    
    out - 输出流
    
    isCloseOut - 是否关闭输出流
    
    Returns:
    
    this
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    4.4.1
  - close
```
public void close()
```
    关闭工作簿
    如果用户设定了目标文件，先写出目标文件后给关闭工作簿
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class ExcelBase<ExcelWriter>
  - closeWithoutFlush
```
protected void closeWithoutFlush()
```
    关闭工作簿但是不写出

Class ExcelWriter

Field Summary

Fields inherited from class cn.hutool.poi.excel.ExcelBase

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.poi.excel.ExcelBase

Methods inherited from class java.lang.Object

Field Detail

destFile

Constructor Detail

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

ExcelWriter

Method Detail

setSheet

setSheet

reset

renameSheet

renameSheet

autoSizeColumnAll

autoSizeColumn

autoSizeColumn

disableDefaultStyle

setStyleSet

getStyleSet

getHeadCellStyle

getCellStyle

getCurrentRow

getDisposition

setCurrentRow

setCurrentRowToEnd

passCurrentRow

passRows

resetRow

setDestFile

setHeaderAlias

clearHeaderAlias

setOnlyAlias

addHeaderAlias

setFreezePane

setFreezePane

setColumnWidth

setDefaultRowHeight

setRowHeight

setHeaderOrFooter

addSelect

addSelect

addValidationData

merge

merge

merge

merge

write

write

write

writeHeadRow

writeRow

writeRow

writeRow

writeCellValue

writeCellValue

createStyleForCell

setStyle

setStyle

setRowStyle

createFont

flush

flush

flush

flush

close

closeWithoutFlush