BigExcelWriter (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.poi.excel.ExcelBase<ExcelWriter,ExcelWriteConfig>
- - org.dromara.hutool.poi.excel.writer.ExcelWriter
  - - org.dromara.hutool.poi.excel.writer.BigExcelWriter

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class BigExcelWriter
extends ExcelWriter
```
大数据量Excel写出，只支持XLSX（Excel07版本）
通过封装SXSSFWorkbook，限制对滑动窗口中的行的访问来实现其低内存使用。
注意如果写出数据大于滑动窗口大小，就会写出到临时文件，此时写出的数据无法访问和编辑。

Since:

4.1.13

Author:

looly

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_WINDOW_SIZE
默认内存中保存的行数，默认100
- Fields inherited from class org.dromara.hutool.poi.excel.ExcelBase
  config, isClosed, sheet, targetFile, workbook

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_WINDOW_SIZE` 默认内存中保存的行数，默认100

Constructor Summary

Constructors
Constructor and Description
`BigExcelWriter()` 构造，默认生成xlsx格式的Excel文件此构造不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(java.io.OutputStream)`方法写出到流若写出到文件，还需调用`ExcelWriter.setTargetFile(File)`方法自定义写出的文件，然后调用`ExcelWriter.flush()`方法写出到文件
`BigExcelWriter(File destFile)` 构造，默认写出到第一个sheet，第一个sheet名为sheet1
`BigExcelWriter(File destFile, String sheetName)` 构造
`BigExcelWriter(int rowAccessWindowSize)` 构造此构造不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(java.io.OutputStream)`方法写出到流若写出到文件，需要调用`ExcelWriter.flush(File, boolean)` 写出到文件
`BigExcelWriter(int rowAccessWindowSize, boolean compressTmpFiles, boolean useSharedStringsTable, String sheetName)` 构造此构造不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(java.io.OutputStream)`方法写出到流若写出到文件，需要调用`ExcelWriter.flush(File, boolean)` 写出到文件
`BigExcelWriter(int rowAccessWindowSize, String sheetName)` 构造此构造不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(java.io.OutputStream)`方法写出到流若写出到文件，需要调用`ExcelWriter.flush(File, boolean)` 写出到文件
`BigExcelWriter(org.apache.poi.ss.usermodel.Sheet sheet)` 构造此构造不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(java.io.OutputStream)`方法写出到流若写出到文件，还需调用`ExcelWriter.setTargetFile(File)`方法自定义写出的文件，然后调用`ExcelWriter.flush()`方法写出到文件
`BigExcelWriter(String destFilePath)` 构造，默认写出到第一个sheet，第一个sheet名为sheet1
`BigExcelWriter(String destFilePath, String sheetName)` 构造
`BigExcelWriter(org.apache.poi.xssf.streaming.SXSSFWorkbook workbook, String sheetName)` 构造此构造不传入写出的Excel文件路径，只能调用`ExcelWriter.flush(java.io.OutputStream)`方法写出到流若写出到文件，还需调用`ExcelWriter.setTargetFile(File)`方法自定义写出的文件，然后调用`ExcelWriter.flush()`方法写出到文件

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigExcelWriter`	`autoSizeColumn(int columnIndex, boolean useMergedCells, float widthRatio)` 设置某列为自动宽度。
`BigExcelWriter`	`autoSizeColumnAll(boolean useMergedCells, float widthRatio)` 设置所有列为自动宽度，不考虑合并单元格此方法必须在指定列数据完全写出后调用才有效。
`void`	`close()` 关闭工作簿如果用户设定了目标文件，先写出目标文件后给关闭工作簿
`ExcelWriter`	`flush(OutputStream out, boolean isCloseOut)` 将Excel Workbook刷出到输出流

Methods inherited from class org.dromara.hutool.poi.excel.writer.ExcelWriter
addIgnoredErrors, addSelect, addSelect, addValidationData, closeWithoutFlush, disableDefaultStyle, fillOnce, flush, flush, flush, flush, getCurrentRow, getStyleSet, merge, merge, merge, merge, merge, passCurrentRow, passRows, renameSheet, renameSheet, reset, resetRow, setColumnStyle, setColumnStyleIfHasData, setColumnWidth, setConfig, setCurrentRow, setCurrentRowToEnd, setDefaultRowHeight, setFreezePane, setFreezePane, setHeaderOrFooter, setRowHeight, setRowStyle, setRowStyleIfHasData, setSheet, setSheet, setStyle, setStyle, setStyleSet, setTargetFile, write, write, write, writeCellValue, writeCellValue, writeCellValue, writeCol, writeCol, writeCol, writeCol, writeHeader, writeHeader, writeHeaderRow, writeLineShape, writeLineShape, writePic, writePic, writePic, writePic, writeRow, writeRow, writeSimpleShape

Methods inherited from class org.dromara.hutool.poi.excel.ExcelBase
checkClosed, cloneSheet, createCellStyle, createCellStyle, createCellStyle, createColumnStyle, createFont, createHyperlink, createHyperlink, createRowStyle, getCell, getCell, getCell, getCell, getColumnCount, getColumnCount, getConfig, getContentType, 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
  - DEFAULT_WINDOW_SIZE
```
public static final int DEFAULT_WINDOW_SIZE
```
    默认内存中保存的行数，默认100
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BigExcelWriter
```
public BigExcelWriter()
```
    构造，默认生成xlsx格式的Excel文件
    此构造不传入写出的Excel文件路径，只能调用ExcelWriter.flush(java.io.OutputStream)方法写出到流
    若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
  - BigExcelWriter
```
public BigExcelWriter(int rowAccessWindowSize)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用ExcelWriter.flush(java.io.OutputStream)方法写出到流
    若写出到文件，需要调用ExcelWriter.flush(File, boolean) 写出到文件
    
    Parameters:
    
    rowAccessWindowSize - 在内存中的行数
  - BigExcelWriter
```
public BigExcelWriter(int rowAccessWindowSize,
                      boolean compressTmpFiles,
                      boolean useSharedStringsTable,
                      String sheetName)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用ExcelWriter.flush(java.io.OutputStream)方法写出到流
    若写出到文件，需要调用ExcelWriter.flush(File, boolean) 写出到文件
    
    Parameters:
    
    rowAccessWindowSize - 在内存中的行数，-1表示不限制，此时需要手动刷出
    
    compressTmpFiles - 是否使用Gzip压缩临时文件
    
    useSharedStringsTable - 是否使用共享字符串表，一般大量重复字符串时开启可节省内存
    
    sheetName - 写出的sheet名称
    
    Since:
    
    5.7.23
  - BigExcelWriter
```
public BigExcelWriter(String destFilePath)
```
    构造，默认写出到第一个sheet，第一个sheet名为sheet1
    
    Parameters:
    
    destFilePath - 目标文件路径，可以不存在
  - BigExcelWriter
```
public BigExcelWriter(int rowAccessWindowSize,
                      String sheetName)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用ExcelWriter.flush(java.io.OutputStream)方法写出到流
    若写出到文件，需要调用ExcelWriter.flush(File, boolean) 写出到文件
    
    Parameters:
    
    rowAccessWindowSize - 在内存中的行数
    
    sheetName - sheet名，第一个sheet名并写出到此sheet，例如sheet1
    
    Since:
    
    4.1.8
  - BigExcelWriter
```
public BigExcelWriter(String destFilePath,
                      String sheetName)
```
    构造
    
    Parameters:
    
    destFilePath - 目标文件路径，可以不存在
    
    sheetName - sheet名，第一个sheet名并写出到此sheet，例如sheet1
  - BigExcelWriter
```
public BigExcelWriter(File destFile)
```
    构造，默认写出到第一个sheet，第一个sheet名为sheet1
    
    Parameters:
    
    destFile - 目标文件，可以不存在
  - BigExcelWriter
```
public BigExcelWriter(File destFile,
                      String sheetName)
```
    构造
    
    Parameters:
    
    destFile - 目标文件，可以不存在
    
    sheetName - sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
  - BigExcelWriter
```
public BigExcelWriter(org.apache.poi.xssf.streaming.SXSSFWorkbook workbook,
                      String sheetName)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用ExcelWriter.flush(java.io.OutputStream)方法写出到流
    若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
    
    Parameters:
    
    workbook - SXSSFWorkbook
    
    sheetName - sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
  - BigExcelWriter
```
public BigExcelWriter(org.apache.poi.ss.usermodel.Sheet sheet)
```
    构造
    此构造不传入写出的Excel文件路径，只能调用ExcelWriter.flush(java.io.OutputStream)方法写出到流
    若写出到文件，还需调用ExcelWriter.setTargetFile(File)方法自定义写出的文件，然后调用ExcelWriter.flush()方法写出到文件
    
    Parameters:
    
    sheet - Sheet
    
    Since:
    
    4.0.6
- Method Detail
  - autoSizeColumn
```
public BigExcelWriter autoSizeColumn(int columnIndex,
                                     boolean useMergedCells,
                                     float widthRatio)
```
    Description copied from class: ExcelWriter
    
    设置某列为自动宽度。注意有中文的情况下，需要根据需求调整宽度扩大比例。
    此方法必须在指定列数据完全写出后调用才有效。
    
    Overrides:
    
    autoSizeColumn in class ExcelWriter
    
    Parameters:
    
    columnIndex - 第几列，从0计数
    
    useMergedCells - 是否适用于合并单元格
    
    widthRatio - 列宽的倍数。如果所有内容都是英文，可以设为1，如果有中文，建议设置为 1.6-2.0之间。
    
    Returns:
    
    this
  - autoSizeColumnAll
```
public BigExcelWriter autoSizeColumnAll(boolean useMergedCells,
                                        float widthRatio)
```
    Description copied from class: ExcelWriter
    
    设置所有列为自动宽度，不考虑合并单元格
    此方法必须在指定列数据完全写出后调用才有效。
    列数计算是通过第一行计算的
    
    Overrides:
    
    autoSizeColumnAll in class ExcelWriter
    
    Parameters:
    
    useMergedCells - 是否适用于合并单元格
    
    widthRatio - 列宽的倍数。如果所有内容都是英文，可以设为1，如果有中文，建议设置为 1.6-2.0之间。
    
    Returns:
    
    this
  - flush
```
public ExcelWriter flush(OutputStream out,
                         boolean isCloseOut)
                  throws IORuntimeException
```
    Description copied from class: ExcelWriter
    
    将Excel Workbook刷出到输出流
    
    Overrides:
    
    flush in class ExcelWriter
    
    Parameters:
    
    out - 输出流
    
    isCloseOut - 是否关闭输出流
    
    Returns:
    
    this
    
    Throws:
    
    IORuntimeException - IO异常
  - close
```
public void close()
```
    Description copied from class: ExcelWriter
    
    关闭工作簿
    如果用户设定了目标文件，先写出目标文件后给关闭工作簿
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class ExcelWriter

Class BigExcelWriter

Field Summary

Fields inherited from class org.dromara.hutool.poi.excel.ExcelBase

Constructor Summary

Method Summary

Methods inherited from class org.dromara.hutool.poi.excel.writer.ExcelWriter

Methods inherited from class org.dromara.hutool.poi.excel.ExcelBase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_WINDOW_SIZE

Constructor Detail

BigExcelWriter

BigExcelWriter

BigExcelWriter

BigExcelWriter

BigExcelWriter

BigExcelWriter

BigExcelWriter

BigExcelWriter

BigExcelWriter

BigExcelWriter

Method Detail

autoSizeColumn

autoSizeColumnAll

flush

close