* 1. 编辑已存在的Excel，可写出原Excel文件，也可写出到其它地方（到文件或到流） * 2. 新建一个空的Excel工作簿，完成数据填充后写出（到文件或到流） *- * + * * @author Looly + * @author wesley.zhang * @since 3.2.0 */ public class ExcelWriter extends ExcelBase
- * 1. 当前行游标归零 - * 2. 清空别名比较器 - *- * - * @return this - */ - public ExcelWriter reset() { - resetRow(); - this.aliasComparator = null; - return this; - } - - /** - * 重命名当前sheet - * - * @param sheetName 新的sheet名 - * @return this - * @since 4.1.8 - */ - public ExcelWriter renameSheet(String sheetName) { - return renameSheet(this.workbook.getSheetIndex(this.sheet), sheetName); - } - - /** - * 重命名sheet - * - * @param sheet sheet需要，0表示第一个sheet - * @param sheetName 新的sheet名 - * @return this - * @since 4.1.8 - */ - public ExcelWriter renameSheet(int sheet, String sheetName) { - this.workbook.setSheetName(sheet, sheetName); - return this; - } - - /** - * 设置所有列为自动宽度，不考虑合并单元格
- * 1. 头部样式 - * 2. 一般单元格样式 - * 3. 默认数字样式 - * 4. 默认日期样式 - *- * - * @return 样式集 - * @since 4.0.0 - */ - public StyleSet getStyleSet() { - return this.styleSet; - } - - /** - * 获取头部样式，获取样式后可自定义样式 - * - * @return 头部样式 - */ - public CellStyle getHeadCellStyle() { - return this.styleSet.headCellStyle; - } - - /** - * 获取单元格样式，获取样式后可自定义样式 - * - * @return 单元格样式 - */ - public CellStyle getCellStyle() { - return this.styleSet.cellStyle; - } - - /** - * 获得当前行 - * - * @return 当前行 - */ - public int getCurrentRow() { - return this.currentRow.get(); - } - - /** - * 获取Content-Disposition头对应的值，可以通过调用以下方法快速设置下载Excel的头信息： - * - *
- * response.setHeader("Content-Disposition", excelWriter.getDisposition("test.xlsx", CharsetUtil.CHARSET_UTF_8));
- *
- *
- * @param fileName 文件名，如果文件名没有扩展名，会自动按照生成Excel类型补齐扩展名，如果提供空，使用随机UUID
- * @param charset 编码，null则使用默认UTF-8编码
- * @return Content-Disposition值
- */
- public String getDisposition(String fileName, Charset charset) {
- if(null == charset) {
- charset = CharsetUtil.CHARSET_UTF_8;
- }
-
- if(StrUtil.isBlank(fileName)) {
- // 未提供文件名使用随机UUID作为文件名
- fileName = IdUtil.fastSimpleUUID();
- }
-
- fileName = StrUtil.addSuffixIfNot(URLUtil.encodeAll(fileName, charset), isXlsx() ? ".xlsx" : ".xls");
- return StrUtil.format("attachment; filename=\"{}\"; filename*={}''{}", fileName, charset.name(), fileName);
- }
-
- /**
- * 设置当前所在行
- *
- * @param rowIndex 行号
- * @return this
- */
- public ExcelWriter setCurrentRow(int rowIndex) {
- this.currentRow.set(rowIndex);
- return this;
- }
-
- /**
- * 跳过当前行
- *
- * @return this
- */
- public ExcelWriter passCurrentRow() {
- this.currentRow.incrementAndGet();
- return this;
- }
-
- /**
- * 跳过指定行数
- *
- * @param rows 跳过的行数
- * @return this
- */
- public ExcelWriter passRows(int rows) {
- this.currentRow.addAndGet(rows);
- return this;
- }
-
- /**
- * 重置当前行为0
- *
- * @return this
- */
- public ExcelWriter resetRow() {
- this.currentRow.set(0);
- return this;
- }
-
- /**
- * 设置写出的目标文件
- *
- * @param destFile 目标文件
- * @return this
- */
- public ExcelWriter setDestFile(File destFile) {
- this.destFile = destFile;
- return this;
- }
-
- /**
- * 设置标题别名，key为Map中的key，value为别名
- *
- * @param headerAlias 标题别名
- * @return this
- * @since 3.2.1
- */
- public ExcelWriter setHeaderAlias(Map- * data中元素支持的类型有： - * - *
- * 1. Iterable，即元素为一个集合，元素被当作一行，data表示多行- * - * @param data 数据 - * @return this - */ - public ExcelWriter write(Iterable data) { - return write(data, 0 == getCurrentRow()); - } - - /** - * 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
- * 2. Map，即元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
- * 3. Bean，即元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
- * 4. 其它类型，按照基本类型输出（例如字符串） - *
- * data中元素支持的类型有： - * - *
- * 1. Iterable，即元素为一个集合，元素被当作一行，data表示多行- * - * @param data 数据 - * @param isWriteKeyAsHead 是否强制写出标题行（Map或Bean） - * @return this - */ - public ExcelWriter write(Iterable data, boolean isWriteKeyAsHead) { - Assert.isFalse(this.isClosed, "ExcelWriter has been closed!"); - boolean isFirst = true; - for (Object object : data) { - writeRow(object, isFirst && isWriteKeyAsHead); - if (isFirst) { - isFirst = false; - } - } - return this; - } - - /** - * 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
- * 2. Map，即元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
- * 3. Bean，即元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
- * 4. 其它类型，按照基本类型输出（例如字符串） - *
- * 1. Map，即元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
- * 2. Bean，即元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
- *
- * 1、如果为Iterable，直接写出一行 - * 2、如果为Map，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values - * 3、如果为Bean，转为Map写出，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values - *- * - * @param rowBean 写出的Bean - * @param isWriteKeyAsHead 为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values - * @return this - * @see #writeRow(Iterable) - * @see #writeRow(Map, boolean) - * @since 4.1.5 - */ - @SuppressWarnings({"rawtypes", "unchecked"}) - public ExcelWriter writeRow(Object rowBean, boolean isWriteKeyAsHead) { - if (rowBean instanceof Iterable) { - return writeRow((Iterable) rowBean); - } - Map rowMap; - if (rowBean instanceof Map) { - if (MapUtil.isNotEmpty(this.headerAlias)) { - rowMap = MapUtil.newTreeMap((Map) rowBean, getInitedAliasComparator()); - } else { - rowMap = (Map) rowBean; - } - } else if (BeanUtil.isBean(rowBean.getClass())) { - if (MapUtil.isEmpty(this.headerAlias)) { - rowMap = BeanUtil.beanToMap(rowBean, new LinkedHashMap<>(), false, false); - } else { - // 别名存在情况下按照别名的添加顺序排序Bean数据 - rowMap = BeanUtil.beanToMap(rowBean, new TreeMap<>(getInitedAliasComparator()), false, false); - } - } else { - // 其它转为字符串默认输出 - return writeRow(CollUtil.newArrayList(rowBean), isWriteKeyAsHead); - } - return writeRow(rowMap, isWriteKeyAsHead); - } - - /** - * 将一个Map写入到Excel，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
- * 需要注意的是，共享样式会共享同一个{@link CellStyle}，一个单元格样式改变，全部改变。
- *
- * @param style 单元格样式
- * @param locationRef 单元格地址标识符，例如A11，B5
- * @return this
- * @since 5.1.4
- */
- public ExcelWriter setStyle(CellStyle style, String locationRef) {
- final CellLocation cellLocation = ExcelUtil.toLocation(locationRef);
- return setStyle(style, cellLocation.getX(), cellLocation.getY());
- }
-
- /**
- * 设置某个单元格的样式
- * 此方法用于多个单元格共享样式的情况
- * 可以调用{@link #getOrCreateCellStyle(int, int)} 方法创建或取得一个样式对象。
- *
- *
- * 需要注意的是，共享样式会共享同一个{@link CellStyle}，一个单元格样式改变，全部改变。
- *
- * @param style 单元格样式
- * @param x X坐标，从0计数，即列号
- * @param y Y坐标，从0计数，即行号
- * @return this
- * @since 4.6.3
- */
- public ExcelWriter setStyle(CellStyle style, int x, int y) {
- final Cell cell = getOrCreateCell(x, y);
- cell.setCellStyle(style);
- return this;
- }
-
- /**
- * 创建字体
- *
- * @return 字体
- * @since 4.1.0
- */
- public Font createFont() {
- return getWorkbook().createFont();
- }
-
- /**
- * 将Excel Workbook刷出到预定义的文件
+ * data中元素支持的类型有：
+ *
+ *
+ * data中元素支持的类型有：
+ *
+ *
+ * 1. Map，既元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
- * 如果用户未自定义输出的文件，将抛出{@link NullPointerException}
- * 预定义文件可以通过{@link #setDestFile(File)} 方法预定义，或者通过构造定义
- *
- * @return this
- * @throws IORuntimeException IO异常
- */
- public ExcelWriter flush() throws IORuntimeException {
- return flush(this.destFile);
- }
-
- /**
- * 将Excel Workbook刷出到文件
- * 如果用户未自定义输出的文件，将抛出{@link NullPointerException}
- *
- * @param destFile 写出到的文件
- * @return this
- * @throws IORuntimeException IO异常
- * @since 4.0.6
- */
- public ExcelWriter flush(File destFile) throws IORuntimeException {
- Assert.notNull(destFile, "[destFile] is null, and you must call setDestFile(File) first or call flush(OutputStream).");
- return flush(FileUtil.getOutputStream(destFile), true);
- }
-
- /**
- * 将Excel Workbook刷出到输出流
- *
- * @param out 输出流
- * @return this
- * @throws IORuntimeException IO异常
- */
- public ExcelWriter flush(OutputStream out) throws IORuntimeException {
- return flush(out, false);
- }
-
- /**
- * 将Excel Workbook刷出到输出流
- *
- * @param out 输出流
- * @param isCloseOut 是否关闭输出流
- * @return this
- * @throws IORuntimeException IO异常
- * @since 4.4.1
- */
- public ExcelWriter flush(OutputStream out, boolean isCloseOut) throws IORuntimeException {
- Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
- try {
- this.workbook.write(out);
- out.flush();
- } catch (IOException e) {
- throw new IORuntimeException(e);
- } finally {
- if (isCloseOut) {
- IoUtil.close(out);
- }
- }
- return this;
- }
-
- /**
- * 关闭工作簿
- * 如果用户设定了目标文件，先写出目标文件后给关闭工作簿
- */
- @Override
- public void close() {
- if (null != this.destFile) {
- flush();
- }
- closeWithoutFlush();
- }
-
- /**
- * 关闭工作簿但是不写出
- */
- protected void closeWithoutFlush() {
- super.close();
-
- // 清空对象
- this.currentRow = null;
- this.styleSet = null;
- }
-
- // -------------------------------------------------------------------------- Private method start
- /**
- * 为指定的key列表添加标题别名，如果没有定义key的别名，在onlyAlias为false时使用原key
- *
- * @param rowMap 一行数据
- * @return 别名列表
- */
- private Map aliasMap(Map rowMap) {
- if (MapUtil.isEmpty(this.headerAlias)) {
- return rowMap;
- }
-
- final Map
+ * 此构造不传入写出的Excel文件路径，只能调用{@link #flush(OutputStream)}方法写出到流
+ * 若写出到文件，还需调用{@link #setDestFile(File)}方法自定义写出的文件，然后调用{@link #flush()}方法写出到文件
+ *
+ * @since 3.2.1
+ */
+ public ExcelWriter() {
+ this(false);
+ }
+
+ /**
+ * 构造
+ * 此构造不传入写出的Excel文件路径，只能调用{@link #flush(OutputStream)}方法写出到流
+ * 若写出到文件，需要调用{@link #flush(File)} 写出到文件
+ *
+ * @param isXlsx 是否为xlsx格式
+ * @since 3.2.1
+ */
+ public ExcelWriter(boolean isXlsx) {
+ this(WorkbookUtil.createBook(isXlsx), null);
+ }
+
+ /**
+ * 构造，默认写出到第一个sheet，第一个sheet名为sheet1
+ *
+ * @param destFilePath 目标文件路径，可以不存在
+ */
+ public ExcelWriter(String destFilePath) {
+ this(destFilePath, null);
+ }
+
+ /**
+ * 构造
+ * 此构造不传入写出的Excel文件路径，只能调用{@link #flush(OutputStream)}方法写出到流
+ * 若写出到文件，需要调用{@link #flush(File)} 写出到文件
+ *
+ * @param isXlsx 是否为xlsx格式
+ * @param sheetName sheet名，第一个sheet名并写出到此sheet，例如sheet1
+ * @since 4.1.8
+ */
+ public ExcelWriter(boolean isXlsx, String sheetName) {
+ this(WorkbookUtil.createBook(isXlsx), sheetName);
+ }
+
+ /**
+ * 构造
+ *
+ * @param destFilePath 目标文件路径，可以不存在
+ * @param sheetName sheet名，第一个sheet名并写出到此sheet，例如sheet1
+ */
+ public ExcelWriter(String destFilePath, String sheetName) {
+ this(FileUtil.file(destFilePath), sheetName);
+ }
+
+ /**
+ * 构造，默认写出到第一个sheet，第一个sheet名为sheet1
+ *
+ * @param destFile 目标文件，可以不存在
+ */
+ public ExcelWriter(File destFile) {
+ this(destFile, null);
+ }
+
+ /**
+ * 构造
+ *
+ * @param destFile 目标文件，可以不存在
+ * @param sheetName sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
+ */
+ public ExcelWriter(File destFile, String sheetName) {
+ this(WorkbookUtil.createBookForWriter(destFile), sheetName);
+ this.destFile = destFile;
+ }
+
+ /**
+ * 构造
+ * 此构造不传入写出的Excel文件路径，只能调用{@link #flush(OutputStream)}方法写出到流
+ * 若写出到文件，还需调用{@link #setDestFile(File)}方法自定义写出的文件，然后调用{@link #flush()}方法写出到文件
+ *
+ * @param workbook {@link Workbook}
+ * @param sheetName sheet名，做为第一个sheet名并写出到此sheet，例如sheet1
+ */
+ public ExcelWriter(Workbook workbook, String sheetName) {
+ this(WorkbookUtil.getOrCreateSheet(workbook, sheetName));
+ }
+
+ /**
+ * 构造
+ * 此构造不传入写出的Excel文件路径，只能调用{@link #flush(OutputStream)}方法写出到流
+ * 若写出到文件，还需调用{@link #setDestFile(File)}方法自定义写出的文件，然后调用{@link #flush()}方法写出到文件
+ *
+ * @param sheet {@link Sheet}
+ * @since 4.0.6
+ */
+ public ExcelWriter(Sheet sheet) {
+ super(sheet);
+ this.styleSet = new StyleSet(workbook);
+ }
+
+ // -------------------------------------------------------------------------- Constructor end
+
+ @Override
+ public ExcelWriter setSheet(int sheetIndex) {
+ // 切换到新sheet需要重置开始行
+ reset();
+ return super.setSheet(sheetIndex);
+ }
+
+ @Override
+ public ExcelWriter setSheet(String sheetName) {
+ // 切换到新sheet需要重置开始行
+ reset();
+ return super.setSheet(sheetName);
+ }
+
+ /**
+ * 重置Writer，包括：
+ *
+ *
+ * 1. 当前行游标归零
+ * 2. 清空别名比较器
+ *
+ *
+ * @return this
+ */
+ public ExcelWriter reset() {
+ resetRow();
+ this.aliasComparator = null;
+ return this;
+ }
+
+ /**
+ * 重命名当前sheet
+ *
+ * @param sheetName 新的sheet名
+ * @return this
+ * @since 4.1.8
+ */
+ public ExcelWriter renameSheet(String sheetName) {
+ return renameSheet(this.workbook.getSheetIndex(this.sheet), sheetName);
+ }
+
+ /**
+ * 重命名sheet
+ *
+ * @param sheet sheet需要，0表示第一个sheet
+ * @param sheetName 新的sheet名
+ * @return this
+ * @since 4.1.8
+ */
+ public ExcelWriter renameSheet(int sheet, String sheetName) {
+ this.workbook.setSheetName(sheet, sheetName);
+ return this;
+ }
+
+ /**
+ * 设置所有列为自动宽度，不考虑合并单元格
+ * 此方法必须在指定列数据完全写出后调用才有效。
+ * 列数计算是通过第一行计算的
+ *
+ * @return this
+ * @since 4.0.12
+ */
+ public ExcelWriter autoSizeColumnAll() {
+ final int columnCount = this.getColumnCount();
+ for (int i = 0; i < columnCount; i++) {
+ autoSizeColumn(i);
+ }
+ return this;
+ }
+
+ /**
+ * 设置某列为自动宽度，不考虑合并单元格
+ * 此方法必须在指定列数据完全写出后调用才有效。
+ *
+ * @param columnIndex 第几列，从0计数
+ * @return this
+ * @since 4.0.12
+ */
+ public ExcelWriter autoSizeColumn(int columnIndex) {
+ this.sheet.autoSizeColumn(columnIndex);
+ return this;
+ }
+
+ /**
+ * 设置某列为自动宽度
+ * 此方法必须在指定列数据完全写出后调用才有效。
+ *
+ * @param columnIndex 第几列，从0计数
+ * @param useMergedCells 是否适用于合并单元格
+ * @return this
+ * @since 3.3.0
+ */
+ public ExcelWriter autoSizeColumn(int columnIndex, boolean useMergedCells) {
+ this.sheet.autoSizeColumn(columnIndex, useMergedCells);
+ return this;
+ }
+
+ /**
+ * 设置样式集，如果不使用样式，传入{@code null}
+ *
+ * @param styleSet 样式集，{@code null}表示无样式
+ * @return this
+ * @since 4.1.11
+ */
+ public ExcelWriter setStyleSet(StyleSet styleSet) {
+ this.styleSet = styleSet;
+ return this;
+ }
+
+ /**
+ * 获取样式集，样式集可以自定义包括：
+ *
+ *
+ * 1. 头部样式
+ * 2. 一般单元格样式
+ * 3. 默认数字样式
+ * 4. 默认日期样式
+ *
+ *
+ * @return 样式集
+ * @since 4.0.0
+ */
+ public StyleSet getStyleSet() {
+ return this.styleSet;
+ }
+
+ /**
+ * 获取头部样式，获取样式后可自定义样式
+ *
+ * @return 头部样式
+ */
+ public CellStyle getHeadCellStyle() {
+ return this.styleSet.headCellStyle;
+ }
+
+ /**
+ * 获取单元格样式，获取样式后可自定义样式
+ *
+ * @return 单元格样式
+ */
+ public CellStyle getCellStyle() {
+ return this.styleSet.cellStyle;
+ }
+
+ /**
+ * 获得当前行
+ *
+ * @return 当前行
+ */
+ public int getCurrentRow() {
+ return this.currentRow.get();
+ }
+
+ /**
+ * 设置当前所在行
+ *
+ * @param rowIndex 行号
+ * @return this
+ */
+ public ExcelWriter setCurrentRow(int rowIndex) {
+ this.currentRow.set(rowIndex);
+ return this;
+ }
+
+ /**
+ * 跳过当前行
+ *
+ * @return this
+ */
+ public ExcelWriter passCurrentRow() {
+ this.currentRow.incrementAndGet();
+ return this;
+ }
+
+ /**
+ * 跳过指定行数
+ *
+ * @param rows 跳过的行数
+ * @return this
+ */
+ public ExcelWriter passRows(int rows) {
+ this.currentRow.addAndGet(rows);
+ return this;
+ }
+
+ /**
+ * 重置当前行为0
+ *
+ * @return this
+ */
+ public ExcelWriter resetRow() {
+ this.currentRow.set(0);
+ return this;
+ }
+
+ /**
+ * 设置写出的目标文件
+ *
+ * @param destFile 目标文件
+ * @return this
+ */
+ public ExcelWriter setDestFile(File destFile) {
+ this.destFile = destFile;
+ return this;
+ }
+
+ /**
+ * 设置标题别名，key为Map中的key，value为别名
+ *
+ * @param headerAlias 标题别名
+ * @return this
+ * @since 3.2.1
+ */
+ public ExcelWriter setHeaderAlias(Map
+ * 样式为默认标题样式，可使用{@link #getHeadCellStyle()}方法调用后自定义默认样式
+ *
+ * @param lastColumn 合并到的最后一个列号
+ * @return this
+ */
+ public ExcelWriter merge(int lastColumn) {
+ return merge(lastColumn, null);
+ }
+
+ /**
+ * 合并当前行的单元格，并写入对象到单元格
+ * 如果写到单元格中的内容非null，行号自动+1，否则当前行号不变
+ * 样式为默认标题样式，可使用{@link #getHeadCellStyle()}方法调用后自定义默认样式
+ *
+ * @param lastColumn 合并到的最后一个列号
+ * @param content 合并单元格后的内容
+ * @return this
+ */
+ public ExcelWriter merge(int lastColumn, Object content) {
+ return merge(lastColumn, content, true);
+ }
+
+ /**
+ * 合并某行的单元格，并写入对象到单元格
+ * 如果写到单元格中的内容非null，行号自动+1，否则当前行号不变
+ * 样式为默认标题样式，可使用{@link #getHeadCellStyle()}方法调用后自定义默认样式
+ *
+ * @param lastColumn 合并到的最后一个列号
+ * @param content 合并单元格后的内容
+ * @param isSetHeaderStyle 是否为合并后的单元格设置默认标题样式
+ * @return this
+ * @since 4.0.10
+ */
+ public ExcelWriter merge(int lastColumn, Object content, boolean isSetHeaderStyle) {
+ Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
+
+ final int rowIndex = this.currentRow.get();
+ merge(rowIndex, rowIndex, 0, lastColumn, content, isSetHeaderStyle);
+
+ // 设置内容后跳到下一行
+ if (null != content) {
+ this.currentRow.incrementAndGet();
+ }
+ return this;
+ }
+
+ /**
+ * 合并某行的单元格，并写入对象到单元格
+ * 如果写到单元格中的内容非null，行号自动+1，否则当前行号不变
+ * 样式为默认标题样式，可使用{@link #getHeadCellStyle()}方法调用后自定义默认样式
+ *
+ * @param lastColumn 合并到的最后一个列号
+ * @param content 合并单元格后的内容
+ * @param isSetHeaderStyle 是否为合并后的单元格设置默认标题样式
+ * @return this
+ * @since 4.0.10
+ */
+ public ExcelWriter merge(int firstRow, int lastRow, int firstColumn, int lastColumn, Object content, boolean isSetHeaderStyle) {
+ Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
+
+ final CellStyle style = (isSetHeaderStyle && null != this.styleSet && null != this.styleSet.headCellStyle) ? this.styleSet.headCellStyle : this.styleSet.cellStyle;
+ CellUtil.mergingCells(this.sheet, firstRow, lastRow, firstColumn, lastColumn, style);
+
+ // 设置内容
+ if (null != content) {
+ final Cell cell = getOrCreateCell(firstColumn, firstRow);
+ CellUtil.setCellValue(cell, content, this.styleSet, isSetHeaderStyle);
+ }
+ return this;
+ }
+
+ /**
+ * 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
+ * 写出的起始行为当前行号，可使用{@link #getCurrentRow()}方法调用，根据写出的的行数，当前行号自动增加
+ * 样式为默认样式，可使用{@link #getCellStyle()}方法调用后自定义默认样式
+ * 默认的，当当前行号为0时，写出标题（如果为Map或Bean），否则不写标题
+ *
+ *
+ * 1. Iterable，既元素为一个集合，元素被当作一行，data表示多行
+ *
+ * @param data 数据
+ * @return this
+ */
+ public ExcelWriter write(Iterable data) {
+ return write(data, 0 == getCurrentRow());
+ }
+
+ /**
+ * 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
+ * 2. Map，既元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
+ * 3. Bean，既元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
+ * 4. 其它类型，按照基本类型输出（例如字符串）
+ *
+ * 写出的起始行为当前行号，可使用{@link #getCurrentRow()}方法调用，根据写出的的行数，当前行号自动增加
+ * 样式为默认样式，可使用{@link #getCellStyle()}方法调用后自定义默认样式
+ *
+ *
+ * 1. Iterable，既元素为一个集合，元素被当作一行，data表示多行
+ *
+ * @param data 数据
+ * @param isWriteKeyAsHead 是否强制写出标题行（Map或Bean）
+ * @return this
+ */
+ public ExcelWriter write(Iterable data, boolean isWriteKeyAsHead) {
+ Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
+ boolean isFirst = true;
+ for (Object object : data) {
+ writeRow(object, isFirst && isWriteKeyAsHead);
+ if (isFirst) {
+ isFirst = false;
+ }
+ }
+ return this;
+ }
+
+ /**
+ * 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件
+ * 2. Map，既元素为一个Map，第一个Map的keys作为首行，剩下的行为Map的values，data表示多行
+ * 3. Bean，既元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
+ * 4. 其它类型，按照基本类型输出（例如字符串）
+ *
+ * 写出的起始行为当前行号，可使用{@link #getCurrentRow()}方法调用，根据写出的的行数，当前行号自动增加
+ * 样式为默认样式，可使用{@link #getCellStyle()}方法调用后自定义默认样式
+ * data中元素支持的类型有：
+ *
+ *
+ * 2. Bean，既元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行
+ *
+ * 本方法只是将数据写入Workbook中的Sheet，并不写出到文件
+ * 写出的起始行为当前行号，可使用{@link #getCurrentRow()}方法调用，根据写出的的行数，当前行号自动+1
+ * 样式为默认标题样式，可使用{@link #getHeadCellStyle()}方法调用后自定义默认样式
+ *
+ * @param rowData 一行的数据
+ * @return this
+ */
+ public ExcelWriter writeHeadRow(Iterable rowData) {
+ Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
+ RowUtil.writeRow(this.sheet.createRow(this.currentRow.getAndIncrement()), rowData, this.styleSet, true);
+ return this;
+ }
+
+ /**
+ * 写出一行，根据rowBean数据类型不同，写出情况如下：
+ *
+ *
+ * 1、如果为Iterable，直接写出一行
+ * 2、如果为Map，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
+ * 3、如果为Bean，转为Map写出，isWriteKeyAsHead为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
+ *
+ *
+ * @param rowBean 写出的Bean
+ * @param isWriteKeyAsHead 为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
+ * @return this
+ * @see #writeRow(Iterable)
+ * @see #writeRow(Map, boolean)
+ * @since 4.1.5
+ */
+ @SuppressWarnings({"unchecked", "rawtypes"})
+ public ExcelWriter writeRow(Object rowBean, boolean isWriteKeyAsHead) {
+ if (rowBean instanceof Iterable) {
+ return writeRow((Iterable) rowBean);
+ }
+ Map rowMap = null;
+ if (rowBean instanceof Map) {
+ if (MapUtil.isNotEmpty(this.headerAlias)) {
+ rowMap = MapUtil.newTreeMap((Map) rowBean, getInitedAliasComparator());
+ } else {
+ rowMap = (Map) rowBean;
+ }
+ } else if (BeanUtil.isBean(rowBean.getClass())) {
+ if (MapUtil.isEmpty(this.headerAlias)) {
+ rowMap = BeanUtil.beanToMap(rowBean, new LinkedHashMap
+ * 如果rowMap为空（包括null），则写出空行
+ *
+ * @param rowMap 写出的Map，为空（包括null），则写出空行
+ * @param isWriteKeyAsHead 为true写出两行，Map的keys做为一行，values做为第二行，否则只写出一行values
+ * @return this
+ */
+ public ExcelWriter writeRow(Map rowMap, boolean isWriteKeyAsHead) {
+ Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
+ if (MapUtil.isEmpty(rowMap)) {
+ // 如果写出数据为null或空，跳过当前行
+ return passCurrentRow();
+ }
+
+ final Map aliasMap = aliasMap(rowMap);
+
+ if (isWriteKeyAsHead) {
+ writeHeadRow(aliasMap.keySet());
+ }
+ writeRow(aliasMap.values());
+ return this;
+ }
+
+ /**
+ * 写出一行数据
+ * 本方法只是将数据写入Workbook中的Sheet，并不写出到文件
+ * 写出的起始行为当前行号，可使用{@link #getCurrentRow()}方法调用，根据写出的的行数，当前行号自动+1
+ * 样式为默认样式，可使用{@link #getCellStyle()}方法调用后自定义默认样式
+ *
+ * @param rowData 一行的数据
+ * @return this
+ */
+ public ExcelWriter writeRow(Iterable rowData) {
+ Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
+ RowUtil.writeRow(this.sheet.createRow(this.currentRow.getAndIncrement()), rowData, this.styleSet, false);
+ return this;
+ }
+
+ /**
+ * 给指定单元格赋值，使用默认单元格样式
+ *
+ * @param x X坐标，从0计数，既列号
+ * @param y Y坐标，从0计数，既行号
+ * @param value 值
+ * @return this
+ * @since 4.0.2
+ */
+ public ExcelWriter writeCellValue(int x, int y, Object value) {
+ final Cell cell = getOrCreateCell(x, y);
+ CellUtil.setCellValue(cell, value, this.styleSet, false);
+ return this;
+ }
+
+ /**
+ * 为指定单元格创建样式
+ *
+ * @param x X坐标，从0计数，既列号
+ * @param y Y坐标，从0计数，既行号
+ * @return {@link CellStyle}
+ * @since 4.0.9
+ * @deprecated 请使用{@link #getOrCreateCellStyle(int, int)}
+ */
+ @Deprecated
+ public CellStyle createStyleForCell(int x, int y) {
+ final Cell cell = getOrCreateCell(x, y);
+ final CellStyle cellStyle = this.workbook.createCellStyle();
+ cell.setCellStyle(cellStyle);
+ return cellStyle;
+ }
+
+ /**
+ * 创建字体
+ *
+ * @return 字体
+ * @since 4.1.0
+ */
+ public Font createFont() {
+ return getWorkbook().createFont();
+ }
+
+ /**
+ * 将Excel Workbook刷出到预定义的文件
+ * 如果用户未自定义输出的文件，将抛出{@link NullPointerException}
+ * 预定义文件可以通过{@link #setDestFile(File)} 方法预定义，或者通过构造定义
+ *
+ * @return this
+ * @throws IORuntimeException IO异常
+ */
+ public ExcelWriter flush() throws IORuntimeException {
+ return flush(this.destFile);
+ }
+
+ /**
+ * 将Excel Workbook刷出到文件
+ * 如果用户未自定义输出的文件，将抛出{@link NullPointerException}
+ *
+ * @param destFile 写出到的文件
+ * @return this
+ * @throws IORuntimeException IO异常
+ * @since 4.0.6
+ */
+ public ExcelWriter flush(File destFile) throws IORuntimeException {
+ Assert.notNull(destFile, "[destFile] is null, and you must call setDestFile(File) first or call flush(OutputStream).");
+ return flush(FileUtil.getOutputStream(destFile), true);
+ }
+
+ /**
+ * 将Excel Workbook刷出到输出流
+ *
+ * @param out 输出流
+ * @return this
+ * @throws IORuntimeException IO异常
+ */
+ public ExcelWriter flush(OutputStream out) throws IORuntimeException {
+ return flush(out, false);
+ }
+
+ /**
+ * 将Excel Workbook刷出到输出流
+ *
+ * @param out 输出流
+ * @param isCloseOut 是否关闭输出流
+ * @return this
+ * @throws IORuntimeException IO异常
+ * @since 4.4.1
+ */
+ public ExcelWriter flush(OutputStream out, boolean isCloseOut) throws IORuntimeException {
+ Assert.isFalse(this.isClosed, "ExcelWriter has been closed!");
+ try {
+ this.workbook.write(out);
+ out.flush();
+ } catch (IOException e) {
+ throw new IORuntimeException(e);
+ } finally {
+ if (isCloseOut) {
+ IoUtil.close(out);
+ }
+ }
+ return this;
+ }
+
+ /**
+ * 关闭工作簿
+ * 如果用户设定了目标文件，先写出目标文件后给关闭工作簿
+ */
+ @Override
+ public void close() {
+ if (null != this.destFile) {
+ flush();
+ }
+ closeWithoutFlush();
+ }
+
+ /**
+ * 关闭工作簿但是不写出
+ */
+ protected void closeWithoutFlush() {
+ super.close();
+
+ // 清空对象
+ this.currentRow = null;
+ this.styleSet = null;
+ }
+
+ // -------------------------------------------------------------------------- Private method start
+
+ /**
+ * 为指定的key列表添加标题别名，如果没有定义key的别名，在onlyAlias为false时使用原key
+ *
+ * @param rowMap 键列表
+ * @return 别名列表
+ */
+ private Map aliasMap(Map rowMap) {
+ if (MapUtil.isEmpty(this.headerAlias)) {
+ return rowMap;
+ }
+ final Map