org.dromara.hutool.poi.excel.ExcelBase Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.poi.excel;
import org.apache.poi.common.usermodel.HyperlinkType;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.xssf.streaming.SXSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.lang.Assert;
import org.dromara.hutool.poi.excel.cell.CellUtil;
import org.dromara.hutool.poi.excel.style.StyleUtil;
import java.io.Closeable;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
/**
* Excel基础类，用于抽象ExcelWriter和ExcelReader中共用部分的对象和方法
*
* @param 子类类型，用于返回this
* @param ExcelConfig类型
* @author looly
* @since 4.1.4
*/
public class ExcelBase, C extends ExcelConfig> implements Closeable {
/**
* Excel配置，此项不为空
*/
protected C config;
/**
* 是否被关闭
*/
protected boolean isClosed;
/**
* 目标文件，如果用户读取为流或自行创建的Workbook或Sheet,此参数为{@code null}
*/
protected File targetFile;
/**
* 工作簿
*/
protected Workbook workbook;
/**
* Excel中对应的Sheet
*/
protected Sheet sheet;
/**
* 构造
*
* @param config config
* @param sheet Excel中的sheet
*/
public ExcelBase(final C config, final Sheet sheet) {
this.config = Assert.notNull(config);
this.sheet = Assert.notNull(sheet, "No Sheet provided.");
this.workbook = sheet.getWorkbook();
}
/**
* 设置Excel配置
*
* @param config Excel配置
* @return this
*/
@SuppressWarnings("unchecked")
public T setConfig(final C config) {
this.config = config;
return (T) this;
}
/**
* 获取Excel配置
*
* @return Excel配置
*/
public C getConfig() {
return this.config;
}
/**
* 获取Workbook
*
* @return Workbook
*/
public Workbook getWorkbook() {
return this.workbook;
}
// region ----- sheet ops
/**
* 返回工作簿表格数
*
* @return 工作簿表格数
* @since 4.0.10
*/
public int getSheetCount() {
return this.workbook.getNumberOfSheets();
}
/**
* 获取此工作簿所有Sheet表
*
* @return sheet表列表
* @since 4.0.3
*/
public List getSheets() {
final int totalSheet = getSheetCount();
final List result = new ArrayList<>(totalSheet);
for (int i = 0; i < totalSheet; i++) {
result.add(this.workbook.getSheetAt(i));
}
return result;
}
/**
* 获取表名列表
*
* @return 表名列表
* @since 4.0.3
*/
public List getSheetNames() {
final int totalSheet = workbook.getNumberOfSheets();
final List result = new ArrayList<>(totalSheet);
for (int i = 0; i < totalSheet; i++) {
result.add(this.workbook.getSheetAt(i).getSheetName());
}
return result;
}
/**
* 获取当前Sheet
*
* @return {@link Sheet}
*/
public Sheet getSheet() {
return this.sheet;
}
/**
* 重命名当前sheet
*
* @param newName 新名字
* @return this
* @see Workbook#setSheetName(int, String)
* @since 5.7.10
*/
@SuppressWarnings("unchecked")
public T renameSheet(final String newName) {
this.workbook.setSheetName(this.workbook.getSheetIndex(this.sheet), newName);
return (T) this;
}
/**
* 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之。
* 在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet。
*
* @param sheetName sheet名
* @return this
* @since 4.0.10
*/
public T setSheet(final String sheetName) {
return setSheet(SheetUtil.getOrCreateSheet(this.workbook, sheetName));
}
/**
* 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认）
* 在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet
*
* @param sheetIndex sheet序号，从0开始计数
* @return this
* @since 4.0.10
*/
public T setSheet(final int sheetIndex) {
return setSheet(SheetUtil.getOrCreateSheet(this.workbook, sheetIndex));
}
/**
* 设置自定义Sheet
*
* @param sheet 自定义sheet，可以通过{@link SheetUtil#getOrCreateSheet(Workbook, String)} 创建
* @return this
* @since 5.2.1
*/
@SuppressWarnings("unchecked")
public T setSheet(final Sheet sheet) {
this.sheet = sheet;
return (T) this;
}
/**
* 复制当前sheet为新sheet
*
* @param sheetIndex sheet位置
* @param newSheetName 新sheet名
* @param setAsCurrentSheet 是否切换为当前sheet
* @return this
* @since 5.7.10
*/
@SuppressWarnings("unchecked")
public T cloneSheet(final int sheetIndex, final String newSheetName, final boolean setAsCurrentSheet) {
final Sheet sheet;
if (this.workbook instanceof XSSFWorkbook) {
final XSSFWorkbook workbook = (XSSFWorkbook) this.workbook;
sheet = workbook.cloneSheet(sheetIndex, newSheetName);
} else {
sheet = this.workbook.cloneSheet(sheetIndex);
// issue#I8QIBB，clone后的sheet的index应该重新获取
this.workbook.setSheetName(workbook.getSheetIndex(sheet), newSheetName);
}
if (setAsCurrentSheet) {
this.sheet = sheet;
}
return (T) this;
}
// endregion
// region ----- cell ops
/**
* 获取指定坐标单元格，单元格不存在时返回{@code null}
*
* @param locationRef 单元格地址标识符，例如A11，B5
* @return {@link Cell}
* @since 5.1.4
*/
public Cell getCell(final String locationRef) {
final CellReference cellReference = new CellReference(locationRef);
return getCell(cellReference.getCol(), cellReference.getRow());
}
/**
* 获取指定坐标单元格，单元格不存在时返回{@code null}
*
* @param x X坐标，从0计数，即列号
* @param y Y坐标，从0计数，即行号
* @return {@link Cell}
* @since 4.0.5
*/
public Cell getCell(final int x, final int y) {
return getCell(x, y, false);
}
/**
* 获取或创建指定坐标单元格
*
* @param locationRef 单元格地址标识符，例如A11，B5
* @return {@link Cell}
* @since 5.1.4
*/
public Cell getOrCreateCell(final String locationRef) {
final CellReference cellReference = new CellReference(locationRef);
return getOrCreateCell(cellReference.getCol(), cellReference.getRow());
}
/**
* 获取或创建指定坐标单元格
*
* @param x X坐标，从0计数，即列号
* @param y Y坐标，从0计数，即行号
* @return {@link Cell}
* @since 4.0.6
*/
public Cell getOrCreateCell(final int x, final int y) {
return getCell(x, y, true);
}
/**
* 获取指定坐标单元格，如果isCreateIfNotExist为false，则在单元格不存在时返回{@code null}
*
* @param locationRef 单元格地址标识符，例如A11，B5
* @param isCreateIfNotExist 单元格不存在时是否创建
* @return {@link Cell}
* @since 5.1.4
*/
public Cell getCell(final String locationRef, final boolean isCreateIfNotExist) {
final CellReference cellReference = new CellReference(locationRef);
return getCell(cellReference.getCol(), cellReference.getRow(), isCreateIfNotExist);
}
/**
* 获取指定坐标单元格，如果isCreateIfNotExist为false，则在单元格不存在时返回{@code null}
*
* @param x X坐标，从0计数，即列号
* @param y Y坐标，从0计数，即行号
* @param isCreateIfNotExist 单元格不存在时是否创建
* @return {@link Cell}
* @since 4.0.6
*/
public Cell getCell(final int x, final int y, final boolean isCreateIfNotExist) {
return CellUtil.getCell(this.sheet, x, y, isCreateIfNotExist);
}
// endregion
// region ----- row ops
/**
* 获取或者创建行
*
* @param y Y坐标，从0计数，即行号
* @return {@link Row}
* @since 4.1.4
*/
public Row getOrCreateRow(final int y) {
return RowUtil.getOrCreateRow(this.sheet, y);
}
/**
* 获取总行数，计算方法为：
*
*
* 最后一行序号 + 1
*
*
* @return 行数
* @since 4.5.4
*/
public int getRowCount() {
return this.sheet.getLastRowNum() + 1;
}
/**
* 获取有记录的行数，计算方法为：
*
*
* 最后一行序号 - 第一行序号 + 1
*
*
* @return 行数
* @since 4.5.4
*/
public int getPhysicalRowCount() {
return this.sheet.getPhysicalNumberOfRows();
}
// endregion
// region ----- style ops
/**
* 为指定单元格获取或者创建样式，返回样式后可以设置样式内容
*
* @param locationRef 单元格地址标识符，例如A11，B5
* @return {@link CellStyle}
* @since 5.1.4
*/
public CellStyle getOrCreateCellStyle(final String locationRef) {
final CellReference cellReference = new CellReference(locationRef);
return getOrCreateCellStyle(cellReference.getCol(), cellReference.getRow());
}
/**
* 为指定单元格获取或者创建样式，返回样式后可以设置样式内容
*
* @param x X坐标，从0计数，即列号
* @param y Y坐标，从0计数，即行号
* @return {@link CellStyle}
* @since 4.1.4
*/
public CellStyle getOrCreateCellStyle(final int x, final int y) {
final CellStyle cellStyle = getOrCreateCell(x, y).getCellStyle();
return StyleUtil.isNullOrDefaultStyle(this.workbook, cellStyle) ? createCellStyle(x, y) : cellStyle;
}
/**
* 为指定单元格创建样式，返回样式后可以设置样式内容
*
* @param locationRef 单元格地址标识符，例如A11，B5
* @return {@link CellStyle}
* @since 5.1.4
*/
public CellStyle createCellStyle(final String locationRef) {
final CellReference cellReference = new CellReference(locationRef);
return createCellStyle(cellReference.getCol(), cellReference.getRow());
}
/**
* 为指定单元格创建样式，返回样式后可以设置样式内容
*
* @param x X坐标，从0计数，即列号
* @param y Y坐标，从0计数，即行号
* @return {@link CellStyle}
* @since 4.6.3
*/
public CellStyle createCellStyle(final int x, final int y) {
final Cell cell = getOrCreateCell(x, y);
final CellStyle cellStyle = this.workbook.createCellStyle();
cell.setCellStyle(cellStyle);
return cellStyle;
}
/**
* 创建单元格样式
*
* @return {@link CellStyle}
* @see Workbook#createCellStyle()
* @since 5.4.0
*/
public CellStyle createCellStyle() {
return StyleUtil.createCellStyle(this.workbook);
}
/**
* 获取或创建某一行的样式，返回样式后可以设置样式内容
* 需要注意，此方法返回行样式，设置背景色在单元格设置值后会被覆盖，需要单独设置其单元格的样式。
*
* @param y Y坐标，从0计数，即行号
* @return {@link CellStyle}
* @since 4.1.4
*/
public CellStyle getOrCreateRowStyle(final int y) {
final CellStyle rowStyle = getOrCreateRow(y).getRowStyle();
return StyleUtil.isNullOrDefaultStyle(this.workbook, rowStyle) ? createRowStyle(y) : rowStyle;
}
/**
* 创建某一行的样式，返回样式后可以设置样式内容
*
* @param y Y坐标，从0计数，即行号
* @return {@link CellStyle}
* @since 4.6.3
*/
public CellStyle createRowStyle(final int y) {
final CellStyle rowStyle = this.workbook.createCellStyle();
getOrCreateRow(y).setRowStyle(rowStyle);
return rowStyle;
}
/**
* 获取或创建某一列的样式，返回样式后可以设置样式内容
* 需要注意，此方法返回行样式，设置背景色在单元格设置值后会被覆盖，需要单独设置其单元格的样式。
*
* @param x X坐标，从0计数，即列号
* @return {@link CellStyle}
* @since 4.1.4
*/
public CellStyle getOrCreateColumnStyle(final int x) {
final CellStyle columnStyle = this.sheet.getColumnStyle(x);
return StyleUtil.isNullOrDefaultStyle(this.workbook, columnStyle) ? createColumnStyle(x) : columnStyle;
}
/**
* 创建某一列的样式，返回样式后可以设置样式内容
*
* @param x X坐标，从0计数，即列号
* @return {@link CellStyle}
* @since 4.6.3
*/
public CellStyle createColumnStyle(final int x) {
final CellStyle columnStyle = this.workbook.createCellStyle();
this.sheet.setDefaultColumnStyle(x, columnStyle);
return columnStyle;
}
/**
* 创建字体
*
* @return 字体
* @since 4.1.0
*/
public Font createFont() {
return getWorkbook().createFont();
}
// endregion
// region ----- hyperlink ops
/**
* 创建 {@link Hyperlink}，默认内容（标签为链接地址本身）
*
* @param type 链接类型
* @param address 链接地址
* @return 链接
* @since 5.7.13
*/
public Hyperlink createHyperlink(final HyperlinkType type, final String address) {
return createHyperlink(type, address, address);
}
/**
* 创建 {@link Hyperlink}，默认内容
*
* @param type 链接类型
* @param address 链接地址
* @param label 标签，即单元格中显示的内容
* @return 链接
* @since 5.7.13
*/
public Hyperlink createHyperlink(final HyperlinkType type, final String address, final String label) {
final Hyperlink hyperlink = this.workbook.getCreationHelper().createHyperlink(type);
hyperlink.setAddress(address);
hyperlink.setLabel(label);
return hyperlink;
}
// endregion
/**
* 获取第一行总列数，计算方法为：
*
*
* 最后一列序号 + 1
*
*
* @return 列数
*/
public int getColumnCount() {
return getColumnCount(0);
}
/**
* 获取总列数，计算方法为：
*
*
* 最后一列序号 + 1
*
*
* @param rowNum 行号
* @return 列数，-1表示获取失败
*/
public int getColumnCount(final int rowNum) {
final Row row = this.sheet.getRow(rowNum);
if (null != row) {
// getLastCellNum方法返回序号+1的值
return row.getLastCellNum();
}
return -1;
}
/**
* 判断是否为xlsx格式的Excel表（Excel07格式）
*
* @return 是否为xlsx格式的Excel表（Excel07格式）
* @since 4.6.2
*/
public boolean isXlsx() {
return this.sheet instanceof XSSFSheet || this.sheet instanceof SXSSFSheet;
}
/**
* 获取Content-Type头对应的值，可以通过调用以下方法快速设置下载Excel的头信息：
*
*
* response.setContentType(excelWriter.getContentType());
*
*
* @return Content-Type值
* @since 5.6.7
*/
public String getContentType() {
return isXlsx() ? ExcelUtil.XLSX_CONTENT_TYPE : ExcelUtil.XLS_CONTENT_TYPE;
}
/**
* 关闭工作簿
* 如果用户设定了目标文件，先写出目标文件后给关闭工作簿
*/
@Override
public void close() {
IoUtil.closeQuietly(this.workbook);
this.sheet = null;
this.workbook = null;
this.isClosed = true;
}
/**
* 校验Excel是否已经关闭
*/
protected void checkClosed() {
Assert.isFalse(this.isClosed, "Excel has been closed!");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy