org.dromara.hutool.extra.compress.CompressUtil Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2023 looly([email protected])
* Hutool is licensed under Mulan PSL v2.
* You can use this software according to the terms and conditions of the Mulan PSL v2.
* You may obtain a copy of Mulan PSL v2 at:
* http://license.coscl.org.cn/MulanPSL2
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
* See the Mulan PSL v2 for more details.
*/
package org.dromara.hutool.extra.compress;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.text.StrUtil;
import org.dromara.hutool.extra.compress.archiver.Archiver;
import org.dromara.hutool.extra.compress.archiver.SevenZArchiver;
import org.dromara.hutool.extra.compress.archiver.StreamArchiver;
import org.dromara.hutool.extra.compress.extractor.Extractor;
import org.dromara.hutool.extra.compress.extractor.SevenZExtractor;
import org.dromara.hutool.extra.compress.extractor.StreamExtractor;
import org.apache.commons.compress.archivers.ArchiveStreamFactory;
import org.apache.commons.compress.archivers.StreamingNotSupportedException;
import org.apache.commons.compress.compressors.CompressorException;
import org.apache.commons.compress.compressors.CompressorInputStream;
import org.apache.commons.compress.compressors.CompressorOutputStream;
import org.apache.commons.compress.compressors.CompressorStreamFactory;
import java.io.File;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.charset.Charset;
/**
* 压缩工具类
* 基于commons-compress的压缩解压封装
*
* @author looly
* @since 5.5.0
*/
public class CompressUtil {
/**
* 获取压缩输出流，用于压缩指定内容，支持的格式例如：
*
* - {@value CompressorStreamFactory#GZIP}
* - {@value CompressorStreamFactory#BZIP2}
* - {@value CompressorStreamFactory#XZ}
* - {@value CompressorStreamFactory#PACK200}
* - {@value CompressorStreamFactory#SNAPPY_FRAMED}
* - {@value CompressorStreamFactory#LZ4_BLOCK}
* - {@value CompressorStreamFactory#LZ4_FRAMED}
* - {@value CompressorStreamFactory#ZSTANDARD}
* - {@value CompressorStreamFactory#DEFLATE}
*
*
* @param compressorName 压缩名称，见：{@link CompressorStreamFactory}
* @param out 输出流，可以输出到内存、网络或文件
* @return {@link CompressorOutputStream}
*/
public static CompressorOutputStream getOut(final String compressorName, final OutputStream out) {
try {
return new CompressorStreamFactory().createCompressorOutputStream(compressorName, out);
} catch (final CompressorException e) {
throw new CompressException(e);
}
}
/**
* 获取压缩输入流，用于解压缩指定内容，支持的格式例如：
*
* - {@value CompressorStreamFactory#GZIP}
* - {@value CompressorStreamFactory#BZIP2}
* - {@value CompressorStreamFactory#XZ}
* - {@value CompressorStreamFactory#PACK200}
* - {@value CompressorStreamFactory#SNAPPY_FRAMED}
* - {@value CompressorStreamFactory#LZ4_BLOCK}
* - {@value CompressorStreamFactory#LZ4_FRAMED}
* - {@value CompressorStreamFactory#ZSTANDARD}
* - {@value CompressorStreamFactory#DEFLATE}
*
*
* @param compressorName 压缩名称，见：{@link CompressorStreamFactory}，null表示自动检测
* @param in 输出流，可以输出到内存、网络或文件
* @return {@link CompressorOutputStream}
*/
public static CompressorInputStream getIn(String compressorName, InputStream in) {
in = IoUtil.toMarkSupport(in);
try {
if(StrUtil.isBlank(compressorName)){
compressorName = CompressorStreamFactory.detect(in);
}
return new CompressorStreamFactory().createCompressorInputStream(compressorName, in);
} catch (final CompressorException e) {
throw new CompressException(e);
}
}
/**
* 创建归档器，支持：
*
* - {@link ArchiveStreamFactory#AR}
* - {@link ArchiveStreamFactory#CPIO}
* - {@link ArchiveStreamFactory#JAR}
* - {@link ArchiveStreamFactory#TAR}
* - {@link ArchiveStreamFactory#ZIP}
* - {@link ArchiveStreamFactory#SEVEN_Z}
*
*
* @param charset 编码
* @param archiverName 归档类型名称，见{@link ArchiveStreamFactory}
* @param file 归档输出的文件
* @return Archiver
*/
public static Archiver createArchiver(final Charset charset, final String archiverName, final File file) {
if (ArchiveStreamFactory.SEVEN_Z.equalsIgnoreCase(archiverName)) {
return new SevenZArchiver(file);
}
return StreamArchiver.of(charset, archiverName, file);
}
/**
* 创建归档器，支持：
*
* - {@link ArchiveStreamFactory#AR}
* - {@link ArchiveStreamFactory#CPIO}
* - {@link ArchiveStreamFactory#JAR}
* - {@link ArchiveStreamFactory#TAR}
* - {@link ArchiveStreamFactory#ZIP}
* - {@link ArchiveStreamFactory#SEVEN_Z}
*
*
* @param charset 编码
* @param archiverName 归档类型名称，见{@link ArchiveStreamFactory}
* @param out 归档输出的流
* @return Archiver
*/
public static Archiver createArchiver(final Charset charset, final String archiverName, final OutputStream out) {
if (ArchiveStreamFactory.SEVEN_Z.equalsIgnoreCase(archiverName)) {
return new SevenZArchiver(out);
}
return StreamArchiver.of(charset, archiverName, out);
}
/**
* 创建归档解包器，支持：
*
* - {@link ArchiveStreamFactory#AR}
* - {@link ArchiveStreamFactory#CPIO}
* - {@link ArchiveStreamFactory#JAR}
* - {@link ArchiveStreamFactory#TAR}
* - {@link ArchiveStreamFactory#ZIP}
* - {@link ArchiveStreamFactory#SEVEN_Z}
*
*
* @param charset 编码，7z格式此参数无效
* @param file 归档文件
* @return {@link Extractor}
*/
public static Extractor createExtractor(final Charset charset, final File file) {
return createExtractor(charset, null, file);
}
/**
* 创建归档解包器，支持：
*
* - {@link ArchiveStreamFactory#AR}
* - {@link ArchiveStreamFactory#CPIO}
* - {@link ArchiveStreamFactory#JAR}
* - {@link ArchiveStreamFactory#TAR}
* - {@link ArchiveStreamFactory#ZIP}
* - {@link ArchiveStreamFactory#SEVEN_Z}
*
*
* @param charset 编码，7z格式此参数无效
* @param archiverName 归档类型名称，见{@link ArchiveStreamFactory}，null表示自动识别
* @param file 归档文件
* @return {@link Extractor}
*/
public static Extractor createExtractor(final Charset charset, final String archiverName, final File file) {
if (ArchiveStreamFactory.SEVEN_Z.equalsIgnoreCase(archiverName)) {
return new SevenZExtractor(file);
}
try {
return new StreamExtractor(charset, archiverName, file);
} catch (final CompressException e) {
final Throwable cause = e.getCause();
if (cause instanceof StreamingNotSupportedException && cause.getMessage().contains("7z")) {
return new SevenZExtractor(file);
}
throw e;
}
}
/**
* 创建归档解包器，支持：
*
* - {@link ArchiveStreamFactory#AR}
* - {@link ArchiveStreamFactory#CPIO}
* - {@link ArchiveStreamFactory#JAR}
* - {@link ArchiveStreamFactory#TAR}
* - {@link ArchiveStreamFactory#ZIP}
* - {@link ArchiveStreamFactory#SEVEN_Z}
*
*
* @param charset 编码，7z格式此参数无效
* @param in 归档输入的流
* @return {@link Extractor}
*/
public static Extractor createExtractor(final Charset charset, final InputStream in) {
return createExtractor(charset, null, in);
}
/**
* 创建归档解包器，支持：
*
* - {@link ArchiveStreamFactory#AR}
* - {@link ArchiveStreamFactory#CPIO}
* - {@link ArchiveStreamFactory#JAR}
* - {@link ArchiveStreamFactory#TAR}
* - {@link ArchiveStreamFactory#ZIP}
* - {@link ArchiveStreamFactory#SEVEN_Z}
*
*
* @param charset 编码，7z格式此参数无效
* @param archiverName 归档类型名称，见{@link ArchiveStreamFactory}，null表示自动识别
* @param in 归档输入的流
* @return {@link Extractor}
*/
public static Extractor createExtractor(final Charset charset, final String archiverName, final InputStream in) {
if (ArchiveStreamFactory.SEVEN_Z.equalsIgnoreCase(archiverName)) {
return new SevenZExtractor(in);
}
try {
return new StreamExtractor(charset, archiverName, in);
} catch (final CompressException e) {
final Throwable cause = e.getCause();
if (cause instanceof StreamingNotSupportedException && cause.getMessage().contains("7z")) {
return new SevenZExtractor(in);
}
throw e;
}
}
}