org.dromara.hutool.poi.excel.WorkbookUtil 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.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.apache.poi.xssf.streaming.SXSSFWorkbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.dromara.hutool.core.io.IORuntimeException;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.io.file.FileUtil;
import org.dromara.hutool.core.text.StrUtil;
import org.dromara.hutool.poi.POIException;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
* Excel工作簿{@link Workbook}相关工具类
*
* @author looly
* @since 4.0.7
*/
public class WorkbookUtil {
/**
* 创建或加载工作簿（读写模式）
*
* @param excelFilePath Excel文件路径，绝对路径或相对于ClassPath路径
* @return {@link Workbook}
* @since 3.1.1
*/
public static Workbook createBook(final String excelFilePath) {
return createBook(excelFilePath, false);
}
/**
* 创建或加载工作簿
*
* @param excelFilePath Excel文件路径，绝对路径或相对于ClassPath路径
* @param readOnly 是否只读模式打开，true:是（不可编辑），false:否（可编辑）
* @return {@link Workbook}
* @since 3.1.1
*/
public static Workbook createBook(final String excelFilePath, final boolean readOnly) {
return createBook(FileUtil.file(excelFilePath), null, readOnly);
}
/**
* 创建或加载工作簿（读写模式）
*
* @param excelFile Excel文件
* @return {@link Workbook}
*/
public static Workbook createBook(final File excelFile) {
return createBook(excelFile, false);
}
/**
* 创建或加载工作簿
*
* @param excelFile Excel文件
* @param readOnly 是否只读模式打开，true:是（不可编辑），false:否（可编辑）
* @return {@link Workbook}
*/
public static Workbook createBook(final File excelFile, final boolean readOnly) {
return createBook(excelFile, null, readOnly);
}
/**
* 创建工作簿，用于Excel写出（读写模式）
*
*
* 1. excelFile为null时直接返回一个空的工作簿，默认xlsx格式
* 2. 文件已存在则通过流的方式读取到这个工作簿
* 3. 文件不存在则检查传入文件路径是否以xlsx为扩展名，是则创建xlsx工作簿，否则创建xls工作簿
*
*
* @param excelFile Excel文件
* @return {@link Workbook}
* @since 4.5.18
*/
public static Workbook createBookForWriter(final File excelFile) {
if (null == excelFile) {
return createBook(true);
}
if (excelFile.exists()) {
return createBook(FileUtil.getInputStream(excelFile));
}
return createBook(StrUtil.endWithIgnoreCase(excelFile.getName(), ".xlsx"));
}
/**
* 创建或加载工作簿（读写模式）
*
* @param excelFile Excel文件
* @param password Excel工作簿密码，如果无密码传{@code null}
* @return {@link Workbook}
*/
public static Workbook createBook(final File excelFile, final String password) {
return createBook(excelFile, password, false);
}
/**
* 创建或加载工作簿
*
* @param excelFile Excel文件
* @param password Excel工作簿密码，如果无密码传{@code null}
* @param readOnly 是否只读模式打开，true:是（不可编辑），false:否（可编辑）
* @return {@link Workbook}
* @since 5.7.23
*/
public static Workbook createBook(final File excelFile, final String password, final boolean readOnly) {
try {
return WorkbookFactory.create(excelFile, password, readOnly);
} catch (final Exception e) {
throw new POIException(e);
}
}
/**
* 创建或加载工作簿（只读模式）
*
* @param in Excel输入流
* @return {@link Workbook}
*/
public static Workbook createBook(final InputStream in) {
return createBook(in, null);
}
/**
* 创建或加载工作簿（只读模式）
*
* @param in Excel输入流，使用完毕自动关闭流
* @param password 密码
* @return {@link Workbook}
* @since 4.0.3
*/
public static Workbook createBook(final InputStream in, final String password) {
try {
return WorkbookFactory.create(IoUtil.toMarkSupport(in), password);
} catch (final Exception e) {
throw new POIException(e);
} finally {
IoUtil.closeQuietly(in);
}
}
/**
* 创建新的空白Excel工作簿
*
* @param isXlsx 是否为xlsx格式的Excel
* @return {@link Workbook}
* @since 4.1.0
*/
public static Workbook createBook(final boolean isXlsx) {
try {
return WorkbookFactory.create(isXlsx);
} catch (final IOException e) {
throw new IORuntimeException(e);
}
}
/**
* 创建或加载SXSSFWorkbook工作簿（读写模式）
*
* @param excelFilePath Excel文件路径，绝对路径或相对于ClassPath路径
* @return {@link SXSSFWorkbook}
* @since 4.1.13
*/
public static SXSSFWorkbook createSXSSFBook(final String excelFilePath) {
return createSXSSFBook(excelFilePath, false);
}
/**
* 创建或加载SXSSFWorkbook工作簿
*
* @param excelFilePath Excel文件路径，绝对路径或相对于ClassPath路径
* @param readOnly 是否只读模式打开，true:是（不可编辑），false:否（可编辑）
* @return {@link SXSSFWorkbook}
* @since 5.7.23
*/
public static SXSSFWorkbook createSXSSFBook(final String excelFilePath, final boolean readOnly) {
return createSXSSFBook(FileUtil.file(excelFilePath), null, readOnly);
}
/**
* 创建或加载SXSSFWorkbook工作簿（读写模式）
*
* @param excelFile Excel文件
* @return {@link SXSSFWorkbook}
* @since 4.1.13
*/
public static SXSSFWorkbook createSXSSFBook(final File excelFile) {
return createSXSSFBook(excelFile, false);
}
/**
* 创建或加载SXSSFWorkbook工作簿
*
* @param excelFile Excel文件
* @param readOnly 是否只读模式打开，true:是（不可编辑），false:否（可编辑）
* @return {@link SXSSFWorkbook}
* @since 5.7.23
*/
public static SXSSFWorkbook createSXSSFBook(final File excelFile, final boolean readOnly) {
return createSXSSFBook(excelFile, null, readOnly);
}
/**
* 创建或加载SXSSFWorkbook工作簿（读写模式）
*
* @param excelFile Excel文件
* @param password Excel工作簿密码，如果无密码传{@code null}
* @return {@link SXSSFWorkbook}
* @since 4.1.13
*/
public static SXSSFWorkbook createSXSSFBook(final File excelFile, final String password) {
return createSXSSFBook(excelFile, password, false);
}
/**
* 创建或加载{@link SXSSFWorkbook}工作簿
*
* @param excelFile Excel文件
* @param password Excel工作簿密码，如果无密码传{@code null}
* @param readOnly 是否只读模式打开，true:是（不可编辑），false:否（可编辑）
* @return {@link SXSSFWorkbook}
* @since 5.7.23
*/
public static SXSSFWorkbook createSXSSFBook(final File excelFile, final String password, final boolean readOnly) {
return toSXSSFBook(createBook(excelFile, password, readOnly));
}
/**
* 创建或加载{@link SXSSFWorkbook}工作簿（只读模式）
*
* @param in Excel输入流
* @return {@link SXSSFWorkbook}
* @since 5.7.1
*/
public static SXSSFWorkbook createSXSSFBook(final InputStream in) {
return createSXSSFBook(in, null);
}
/**
* 创建或加载{@link SXSSFWorkbook}工作簿（只读模式）
*
* @param in Excel输入流
* @param password 密码
* @return {@link SXSSFWorkbook}
* @since 4.1.13
*/
public static SXSSFWorkbook createSXSSFBook(final InputStream in, final String password) {
return toSXSSFBook(createBook(in, password));
}
/**
* 创建空的{@link SXSSFWorkbook}，用于大批量数据写出
*
* @return {@link SXSSFWorkbook}
* @since 4.1.13
*/
public static SXSSFWorkbook createSXSSFBook() {
return new SXSSFWorkbook();
}
/**
* 创建空的{@link SXSSFWorkbook}，用于大批量数据写出
*
* @param rowAccessWindowSize 在内存中的行数，-1表示不限制，此时需要手动刷出
* @return {@link SXSSFWorkbook}
* @since 4.1.13
*/
public static SXSSFWorkbook createSXSSFBook(final int rowAccessWindowSize) {
return new SXSSFWorkbook(rowAccessWindowSize);
}
/**
* 创建空的{@link SXSSFWorkbook}，用于大批量数据写出
*
* @param rowAccessWindowSize 在内存中的行数，-1表示不限制，此时需要手动刷出
* @param compressTmpFiles 是否使用Gzip压缩临时文件
* @param useSharedStringsTable 是否使用共享字符串表，一般大量重复字符串时开启可节省内存
* @return {@link SXSSFWorkbook}
* @since 5.7.23
*/
public static SXSSFWorkbook createSXSSFBook(final int rowAccessWindowSize, final boolean compressTmpFiles, final boolean useSharedStringsTable) {
return new SXSSFWorkbook(null, rowAccessWindowSize, compressTmpFiles, useSharedStringsTable);
}
/**
* 将Excel Workbook刷出到输出流，不关闭流
*
* @param book {@link Workbook}
* @param out 输出流
* @throws IORuntimeException IO异常
* @since 3.2.0
*/
public static void writeBook(final Workbook book, final OutputStream out) throws IORuntimeException {
try {
book.write(out);
} catch (final IOException e) {
throw new IORuntimeException(e);
}
}
// -------------------------------------------------------------------------------------------------------- Private method start
/**
* 将普通工作簿转换为SXSSFWorkbook
*
* @param book 工作簿
* @return SXSSFWorkbook
* @since 4.1.13
*/
private static SXSSFWorkbook toSXSSFBook(final Workbook book) {
if (book instanceof SXSSFWorkbook) {
return (SXSSFWorkbook) book;
}
if (book instanceof XSSFWorkbook) {
return new SXSSFWorkbook((XSSFWorkbook) book);
}
throw new POIException("The input is not a [xlsx] format.");
}
// -------------------------------------------------------------------------------------------------------- Private method end
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy