add fileNameEditor

This commit is contained in:
Looly
2024-05-09 12:16:40 +08:00
parent b967478c92
commit 1e87f43256
3 changed files with 38 additions and 35 deletions

View File

@@ -14,6 +14,7 @@ package org.dromara.hutool.extra.compress.archiver;
import java.io.Closeable; import java.io.Closeable;
import java.io.File; import java.io.File;
import java.util.function.Function;
import java.util.function.Predicate; import java.util.function.Predicate;
/** /**
@@ -52,7 +53,21 @@ public interface Archiver extends Closeable {
* @param filter 文件过滤器,指定哪些文件或目录可以加入,{@link Predicate#test(Object)}为{@code true}保留null表示全部加入 * @param filter 文件过滤器,指定哪些文件或目录可以加入,{@link Predicate#test(Object)}为{@code true}保留null表示全部加入
* @return this * @return this
*/ */
Archiver add(File file, String path, Predicate<File> filter); default Archiver add(final File file, final String path, final Predicate<File> filter){
return add(file, path, Function.identity(), filter);
}
/**
* 将文件或目录加入归档包,目录采取递归读取方式按照层级加入
*
* @param file 文件或目录
* @param path 文件或目录的初始路径null表示位于根路径
* @param fileNameEditor 文件名编辑器
* @param filter 文件过滤器,指定哪些文件或目录可以加入,{@link Predicate#test(Object)}为{@code true}保留null表示全部加入
* @return this
* @since 6.0.0
*/
Archiver add(File file, String path, Function<String, String> fileNameEditor, Predicate<File> filter);
/** /**
* 结束已经增加的文件归档,此方法不会关闭归档流,可以继续添加文件 * 结束已经增加的文件归档,此方法不会关闭归档流,可以继续添加文件

View File

@@ -24,6 +24,7 @@ import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.OutputStream; import java.io.OutputStream;
import java.nio.channels.SeekableByteChannel; import java.nio.channels.SeekableByteChannel;
import java.util.function.Function;
import java.util.function.Predicate; import java.util.function.Predicate;
/** /**
@@ -89,9 +90,9 @@ public class SevenZArchiver implements Archiver {
} }
@Override @Override
public SevenZArchiver add(final File file, final String path, final Predicate<File> filter) { public SevenZArchiver add(final File file, final String path, final Function<String, String> fileNameEditor, final Predicate<File> filter) {
try { try {
addInternal(file, path, filter); addInternal(file, path, fileNameEditor, filter);
} catch (final IOException e) { } catch (final IOException e) {
throw new IORuntimeException(e); throw new IORuntimeException(e);
} }
@@ -128,23 +129,21 @@ public class SevenZArchiver implements Archiver {
/** /**
* 将文件或目录加入归档包,目录采取递归读取方式按照层级加入 * 将文件或目录加入归档包,目录采取递归读取方式按照层级加入
* *
* @param file 文件或目录 * @param file 文件或目录
* @param path 文件或目录的初始路径null表示位于根路径 * @param path 文件或目录的初始路径null表示位于根路径
* @param filter 文件过滤器,指定哪些文件或目录可以加入,当{@link Predicate#test(Object)}为{@code true}保留null表示保留全部 * @param fileNameEditor 文件名编辑器
* @param filter 文件过滤器,指定哪些文件或目录可以加入,当{@link Predicate#test(Object)}为{@code true}保留null表示保留全部
*/ */
private void addInternal(final File file, final String path, final Predicate<File> filter) throws IOException { private void addInternal(final File file, final String path, final Function<String, String> fileNameEditor, final Predicate<File> filter) throws IOException {
if (null != filter && !filter.test(file)) { if (null != filter && !filter.test(file)) {
return; return;
} }
final SevenZOutputFile out = this.sevenZOutputFile; final SevenZOutputFile out = this.sevenZOutputFile;
final String entryName; String entryName = (null == fileNameEditor) ? file.getName() : fileNameEditor.apply(file.getName());
if (StrUtil.isNotEmpty(path)) { if (StrUtil.isNotEmpty(path)) {
// 非空拼接路径格式为path/name // 非空拼接路径格式为path/name
entryName = StrUtil.addSuffixIfNot(path, StrUtil.SLASH) + file.getName(); entryName = StrUtil.addSuffixIfNot(path, StrUtil.SLASH) + entryName;
} else {
// 路径空直接使用文件名或目录名
entryName = file.getName();
} }
out.putArchiveEntry(out.createArchiveEntry(file, entryName)); out.putArchiveEntry(out.createArchiveEntry(file, entryName));
@@ -153,7 +152,7 @@ public class SevenZArchiver implements Archiver {
final File[] files = file.listFiles(); final File[] files = file.listFiles();
if (ArrayUtil.isNotEmpty(files)) { if (ArrayUtil.isNotEmpty(files)) {
for (final File childFile : files) { for (final File childFile : files) {
addInternal(childFile, entryName, filter); addInternal(childFile, entryName, fileNameEditor, filter);
} }
} }
} else { } else {

View File

@@ -30,6 +30,7 @@ import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.OutputStream; import java.io.OutputStream;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import java.util.function.Function;
import java.util.function.Predicate; import java.util.function.Predicate;
/** /**
@@ -116,20 +117,10 @@ public class StreamArchiver implements Archiver {
((ArArchiveOutputStream) out).setLongFileMode(ArArchiveOutputStream.LONGFILE_BSD); ((ArArchiveOutputStream) out).setLongFileMode(ArArchiveOutputStream.LONGFILE_BSD);
} }
} }
/**
* 将文件或目录加入归档包,目录采取递归读取方式按照层级加入
*
* @param file 文件或目录
* @param path 文件或目录的初始路径null表示位于根路径
* @param predicate 文件过滤器,指定哪些文件或目录可以加入,当{@link Predicate#test(Object)}为{@code true}加入null表示全部加入
* @return this
* @throws IORuntimeException IO异常
*/
@Override @Override
public StreamArchiver add(final File file, final String path, final Predicate<File> predicate) throws IORuntimeException { public StreamArchiver add(final File file, final String path, final Function<String, String> fileNameEditor, final Predicate<File> predicate) throws IORuntimeException {
try { try {
addInternal(file, path, predicate); addInternal(file, path, fileNameEditor, predicate);
} catch (final IOException e) { } catch (final IOException e) {
throw new IORuntimeException(e); throw new IORuntimeException(e);
} }
@@ -165,24 +156,22 @@ public class StreamArchiver implements Archiver {
/** /**
* 将文件或目录加入归档包,目录采取递归读取方式按照层级加入 * 将文件或目录加入归档包,目录采取递归读取方式按照层级加入
* *
* @param file 文件或目录 * @param file 文件或目录
* @param path 文件或目录的初始路径,{@code null}表示位于根路径 * @param path 文件或目录的初始路径,{@code null}表示位于根路径
* @param predicate 文件过滤器,指定哪些文件或目录可以加入,当{@link Predicate#test(Object)}为{@code true}加入。 * @param fileNameEditor 文件名编辑器
* @param predicate 文件过滤器,指定哪些文件或目录可以加入,当{@link Predicate#test(Object)}为{@code true}加入。
*/ */
@SuppressWarnings({"rawtypes", "unchecked"}) @SuppressWarnings({"rawtypes", "unchecked"})
private void addInternal(final File file, final String path, final Predicate<File> predicate) throws IOException { private void addInternal(final File file, final String path, final Function<String, String> fileNameEditor, final Predicate<File> predicate) throws IOException {
if (null != predicate && !predicate.test(file)) { if (null != predicate && !predicate.test(file)) {
return; return;
} }
final ArchiveOutputStream out = this.out; final ArchiveOutputStream out = this.out;
final String entryName; String entryName = (fileNameEditor == null) ? file.getName() : fileNameEditor.apply(file.getName());
if (StrUtil.isNotEmpty(path)) { if (StrUtil.isNotEmpty(path)) {
// 非空拼接路径格式为path/name // 非空拼接路径格式为path/name
entryName = StrUtil.addSuffixIfNot(path, StrUtil.SLASH) + file.getName(); entryName = StrUtil.addSuffixIfNot(path, StrUtil.SLASH) + entryName;
} else {
// 路径空直接使用文件名或目录名
entryName = file.getName();
} }
out.putArchiveEntry(out.createArchiveEntry(file, entryName)); out.putArchiveEntry(out.createArchiveEntry(file, entryName));
@@ -191,7 +180,7 @@ public class StreamArchiver implements Archiver {
final File[] files = file.listFiles(); final File[] files = file.listFiles();
if (ArrayUtil.isNotEmpty(files)) { if (ArrayUtil.isNotEmpty(files)) {
for (final File childFile : files) { for (final File childFile : files) {
addInternal(childFile, entryName, predicate); addInternal(childFile, entryName, fileNameEditor, predicate);
} }
} else { } else {
// 空文件夹也需要关闭 // 空文件夹也需要关闭