org.dromara.hutool.poi.GlobalPoiConfig 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;
import org.apache.poi.openxml4j.util.ZipSecureFile;
/**
* POI的全局设置
*
* @author Looly
* @see ZipSecureFile
* @since 5.8.30
*/
public class GlobalPoiConfig {
/**
* 设置解压时的最小压缩比例
* 为了避免`Zip Bomb`，POI中设置了最小压缩比例，这个比例为：
*
* 压缩后的大小/解压后的大小
*
*
* POI的默认值是0.01（即最小压缩到1%），如果文档中的文件压缩比例小于这个值，就会报错。
* 如果文件中确实存在高压缩比的文件，可以通过这个全局方法自定义比例，从而避免错误。
*
* @param ratio 解压后的文件大小与原始文件大小的最小比率，小于等于0表示不检查
*/
public static void setMinInflateRatio(final double ratio) {
ZipSecureFile.setMinInflateRatio(ratio);
}
/**
* 设置单个Zip文件中最大文件大小，默认为4GB，即32位zip格式的最大值。
*
* @param maxEntrySize 单个Zip文件中最大文件大小，必须大于0
*/
public static void setMaxEntrySize(final long maxEntrySize) {
ZipSecureFile.setMaxEntrySize(maxEntrySize);
}
/**
* 设置解压前文本的最大字符数，超过抛出异常。
*
* @param maxTextSize 文本的最大字符数
* @throws IllegalArgumentException for negative maxTextSize
*/
public static void setMaxTextSize(final long maxTextSize) {
ZipSecureFile.setMaxTextSize(maxTextSize);
}
}