
OpenHarmony三方组件:CommonsCompress
简介
commons-compress组件定义了一个用于处理压缩和存档格式的 API,包含bzip2、gzip、lzma、xz、Snappy、LZ4、Brotli、DEFLATE、Zstandard 和 ar、cpio、tar、zip、dump、7z等格式的压缩/解压功能。
下载
OpenHarmony npm环境配置等更多内容,请参照 如何安装OpenHarmony npm包 。
使用说明
配置全局路径
需要在MainAbility文件配置全局路径
zip 压缩功能
指定文件夹路径压缩zip文件夹。
zip 解压功能
指定文件夹路径解压zip文件夹。
gzip 压缩功能
指定文件夹路径压缩gz文件夹。
gzip 解压功能
指定文件夹路径解压gz文件夹。
xz 压缩功能
指定文件夹路径压缩XZ文件夹。
xz 解压功能
指定文件夹路径解压XZ文件夹。
Z 解压功能
指定文件夹路径解压Z文件夹。
zstd 压缩解压功能
指定文件夹路径压缩解压zstd 文件夹。
ar 压缩功能
指定文件夹路径压缩ar文件夹。
ar 解压功能
指定文件夹路径解压ar文件夹。
brotli 解压功能
指定文件夹路径解压brotli文件夹。
bzip2 压缩功能
指定文件夹路径压缩bzip2文件夹。
bzip2 解压功能
指定文件夹路径解压bzip2文件夹。
lz4 压缩功能
指定文件夹路径压缩lz4文件夹。
lz4 解压功能
指定文件夹路径解压lz4文件夹。
lzma,sevenz7 压缩功能
指定文件夹路径压缩lzma,sevenz7文件夹。
lzma,sevenz7 解压功能
指定文件夹路径解压lzma,sevenz7文件夹。
tar 压缩功能
指定文件夹路径解压tar文件夹。
tar 解压功能
指定文件夹路径解压tar文件夹。
snappy 压缩解压功能
指定文件夹路径压缩解压sz文件夹。
dump 解压功能
指定文件夹路径解压dump文件夹。
deflate 压缩功能
指定文件夹路径压缩deflate文件夹。
deflate 解压功能
指定文件夹路径解压deflate文件夹。
cpio 压缩功能
指定文件夹路径压缩cpio文件夹。
cpio 解压功能
指定文件夹路径解压cpio文件夹。
目录
接口说明
接口 | 参数 | 功能 |
createArchiveOutputStream(archiverName: string, out: OutputStream) | archiverName:存档名称 out:存档输出流 | 创建存档输出流。 |
zipCompress(path: string, dest: string) | path:文件路径 dest:生成后的文件名称 | zip压缩方法。 |
zipDeCompress(path: string, target?: string) | path:解压后的文件路径和名称 target:解压后的路径 | zip解压方法。 |
gzipFile(src: string, dest: string) | src:文件路径 dest:生成后的文件名称 | gzip压缩方法。 |
unGzipFile(src: string, target: string) | path:解压后的文件路径和名称 target:解压后的路径 | gzip解压方法。 |
createCompressorOutputStream(name: string, out: OutputStream) | name:压缩器名称 out:输出流 | 从存档程序名称和输出流创建存档输出流。 |
createCompressorInputStream( name: string, inputStream: InputStream, actualDecompressConcatenated: boolean) | name:压缩器名称 inputStream:输入流 actualDecompressConcatenated:解压级 | 从存档程序名称和输入流创建存档输入流。 |
copy(input: InputStream, output: OutputStream) | input:输入流 output:输出流 | 将输入流的内容复制到输出流中。 |
setFilePath(path: string) | path:指定路径 | 打开指定文件路径。 |
createCompressorInputStream2(name: string, inputStream: InputStream) | name:压缩器名称 inputStream:输入流 | 从压缩器名称和输入创建压缩器输入流。 |
readFully(input: InputStream, array: Int8Array) | input:输入流 array:需要填充数组 | 从输入中读取尽可能多的信息,以填充给定的数组。 |
ZSTDCompress(path: string, filepath: string, level: number) | path:需要压缩的文件包路径, filepath:压缩文件存放的路径,level:压缩等级(1~9) | zstd压缩方法 |
ZSTDDecompress(path: string, dest: string) | path:需要解压的文件包路径,dest:解压文件存放的路径 | zstd解压方法。 |
lz4Compressed(src: string, dest: string) | src:文件路径 dest:生成后的文件名称 | 压缩为lz4文件。 |
lz4Decompressed(src: string, target: string) | path:解压后的文件路径和名称 target:解压后的路径 | 解压lz4文件。 |
createArchiveOutputStreamLittle(archiverName: string, out: OutputStream) | archiverName:存档名称 out:输出流 | 创建存档输出流。 |
createArchiveInputStream( archiverName: string, inputStream: InputStream, actualEncoding: string) | archiverName:存档名称 inputStream:输入流 actualEncoding:条目编码 | 从存档程序名称和输入流创建存档输入流。 |
snappyCompress(path, newfile) | path:文件路径 newfile:生成后的文件名称 | 压缩为sz文件。 |
snappyUncompress(path, newfolder, newfile, newfile1) | path:文件路径 newfolder: 文件名称 newfile:生成后的文件名称 newfile1:文件名称 | 解压sz文件。 |
DeflateFile(src: string, dest: string) | src:文件路径 dest:生成后的文件名称 | 压缩为deflate文件。 |
InflateFile(src: string, target: string) | src:解压后的文件路径和名称 target:解压后的路径 | 解压deflate文件。 |
兼容性
- DevEco Studio 版本:DevEco Studio 3.1 Beta1及以上版本。
- OpenHarmony SDK版本:API version 9 及以上版本。
开源协议
本项目基于 Apache License 2.0 ,请自由地享受和参与开源。
贡献代码
使用过程中发现任何问题都可以提 Issue 给我们,当然,我们也非常欢迎你给我们发 PR 。
文章转载自:https://gitee.com/openharmony-tpc/CommonsCompress#%E4%B8%8B%E8%BD%BD
