本模块提供压缩解压缩文件的能力。
说明:
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import zlib from '@ohos.zlib';
zlib.zipFile(deprecated)
zipFile(inFile: string, outFile: string, options: Options): Promise<void>
压缩接口,压缩完成后返回执行结果,使用Promise异步返回。
说明:
从API version 7 开始支持,从API 9 开始废弃。建议使用zlib.compressFile。
系统能力: SystemCapability.BundleManager.Zlib
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
inFile | string | 是 | 指定压缩的文件夹路径或者文件路径,路径必须为沙箱路径,沙箱路径可以通过context获取,可参考FA模型,Stage模型。 |
outFile | string | 是 | 指定压缩结果的文件路径(文件的扩展名zip)。 |
options | Options | 是 | 压缩的可选参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise对象,无返回值。 |
示例:
// 代码中使用的路径需为应用的沙箱路径,如/data/storage/el2/base/haps,也可以通过context获取。
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let options: zlib.Options = {
level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
zlib.zipFile(inFile, outFile, options).then((data: void) => {
console.info('zipFile result is ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
console.error('error is ' + JSON.stringify(err));
});
zlib.unzipFile(deprecated)
unzipFile(inFile:string, outFile:string, options: Options): Promise<void>
解压文件,解压完成后返回执行结果,使用Promise异步返回。
说明:
从API version 7 开始支持,从API 9 开始废弃。建议使用zlib.decompressFile。
系统能力: SystemCapability.BundleManager.Zlib
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
inFile | string | 是 | 指定的待解压缩文件的文件路径,路径必须为沙箱路径,沙箱路径可以通过context获取,可参考FA模型,Stage模型。 |
outFile | string | 是 | 指定的解压文件路径。 |
options | Options | 是 | 解压的可选参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise对象,无返回值。 |
示例:
// 代码中使用的路径需为应用的沙箱路径,如/data/storage/el2/base/haps,也可以通过context获取。
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xx/xxx.zip';
let outFile = '/xxx';
let options: zlib.Options = {
level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
zlib.unzipFile(inFile, outFile, options).then((data: void) => {
console.info('unzipFile result is ' + JSON.stringify(data));
}).catch((err: BusinessError)=>{
console.error('error is ' + JSON.stringify(err));
})
zlib.compressFile9+
compressFile(inFile: string, outFile: string, options: Options, callback: AsyncCallback<void>): void
压缩文件,压缩的结果,使用callback异步回调返回。成功返回null,失败返回错误码。
系统能力: SystemCapability.BundleManager.Zlib
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
inFile | string | 是 | 指定压缩的文件夹路径或者文件路径,路径必须为沙箱路径,沙箱路径可以通过context获取,可参考FA模型,Stage模型。 |
outFile | string | 是 | 指定的压缩结果的文件路径。 |
options | Options | 是 | 压缩的配置参数。 |
callback | AsyncCallback<void> | 是 | 异步获取压缩结果之后的回调。成功返回null,失败返回错误码。 |
错误码:
以下错误码的详细介绍请参见ohos.zlib错误码。
错误码ID | 错误信息 |
---|---|
900001 | The input source file is invalid. |
900002 | The input destination file is invalid. |
示例:
// 代码中使用的路径需为应用的沙箱路径,如/data/storage/el2/base/haps,也可以通过context获取。
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let options: zlib.Options = {
level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
try {
zlib.compressFile(inFile, outFile, options, (errData: BusinessError) => {
if (errData !== null) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
})
} catch(errData) {
let code = (errData as BusinessError).code;
let message = (errData as BusinessError).message;
console.error(`errData is errCode:${code} message:${message}`);
}
zlib.compressFile9+
compressFile(inFile: string, outFile: string, options: Options): Promise<void>
压缩文件,压缩的结果,使用Promise异步返回。成功时返回null,失败时返回错误码。
系统能力: SystemCapability.BundleManager.Zlib
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
inFile | string | 是 | 指定压缩的文件夹路径或者文件路径,路径必须为沙箱路径,沙箱路径可以通过context获取,可参考FA模型,Stage模型。 |
outFile | string | 是 | 指定的压缩结果的文件路径。 |
options | Options | 是 | 压缩的配置参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise对象,无返回值。 |
错误码:
以下错误码的详细介绍请参见ohos.zlib错误码。
错误码ID | 错误信息 |
---|---|
900001 | The input source file is invalid. |
900002 | The input destination file is invalid. |
示例:
// 代码中使用的路径需为应用的沙箱路径,如/data/storage/el2/base/haps,也可以通过context获取。
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let options: zlib.Options = {
level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
try {
zlib.compressFile(inFile, outFile, options).then((data: void) => {
console.info('compressFile success. data: ' + JSON.stringify(data));
}).catch((errData: BusinessError) => {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
})
} catch(errData) {
let code = (errData as BusinessError).code;
let message = (errData as BusinessError).message;
console.error(`errData is errCode:${code} message:${message}`);
}
zlib.decompressFile9+
decompressFile(inFile: string, outFile: string, options: Options, callback: AsyncCallback<void>): void
解压文件,解压的结果,使用callback异步回调返回。成功时返回null,失败时返回错误码。
系统能力: SystemCapability.BundleManager.Zlib
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
inFile | string | 是 | 指定的待解压缩文件的文件路径,文件后缀需要以.zip结尾。文件路径必须为沙箱路径,沙箱路径可以通过context获取,可参考FA模型,Stage模型。 |
outFile | string | 是 | 指定的解压后的文件夹路径,文件夹目录路径需要在系统中存在,不存在则会解压失败。路径必须为沙箱路径,沙箱路径可以通过context获取,具体方法可参考application/context(Stage模型)或 app/context(FA模型)。如果待解压的文件或文件夹在解压后的路径下已经存在,则会直接覆盖同名文件或同名文件夹中的同名文件。 |
options | Options | 是 | 解压的配置参数。 |
callback | AsyncCallback<void> | 是 | 异步获取解压结果之后的回调。成功返回null,失败返回错误码。 |
错误码:
以下错误码的详细介绍请参见ohos.zlib错误码。
错误码ID | 错误信息 |
---|---|
900001 | The input source file is invalid. |
900002 | The input destination file is invalid. |
900003 | The input source file is not ZIP format or damaged. |
示例:
// 代码中使用的路径需为应用的沙箱路径,如/data/storage/el2/base/haps,也可以通过context获取。
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xx/xxx.zip';
let outFileDir = '/xxx';
let options: zlib.Options = {
level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION
};
try {
zlib.decompressFile(inFile, outFileDir, options, (errData: BusinessError) => {
if (errData !== null) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
})
} catch(errData) {
let code = (errData as BusinessError).code;
let message = (errData as BusinessError).message;
console.error(`errData is errCode:${code} message:${message}`);
}
zlib.decompressFile9+
decompressFile(inFile: string, outFile: string, options?: Options): Promise<void>
解压文件,解压的结果,使用Promise异步返回,成功时返回null,失败时返回错误码。
系统能力: SystemCapability.BundleManager.Zlib
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
inFile | string | 是 | 指定的待解压缩文件的文件路径,文件后缀需要以.zip结尾。文件路径必须为沙箱路径,沙箱路径可以通过context获取,可参考FA模型,Stage模型。 |
outFile | string | 是 | 指定的解压后的文件夹路径,文件夹目录路径需要在系统中存在,不存在则会解压失败。路径必须为沙箱路径,沙箱路径可以通过context获取,具体方法可参考application/context(Stage模型)或 app/context(FA模型)。如果待解压的文件或文件夹在解压后的路径下已经存在,则会直接覆盖同名文件或同名文件夹中的同名文件。 |
options | Options | 否 | 解压时的配置参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise对象,无返回值。 |
错误码:
以下错误码的详细介绍请参见ohos.zlib错误码。
错误码ID | 错误信息 |
---|---|
900001 | The input source file is invalid. |
900002 | The input destination file is invalid. |
900003 | The input source file is not ZIP format or damaged. |
示例:
// 代码中使用的路径需为应用的沙箱路径,如/data/storage/el2/base/haps,也可以通过context获取。
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xx/xxx.zip';
let outFileDir = '/xxx';
let options: zlib.Options = {
level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION
};
try {
zlib.decompressFile(inFile, outFileDir, options).then((data: void) => {
console.info('decompressFile success. data: ' + JSON.stringify(data));
}).catch((errData: BusinessError) => {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
})
} catch(errData) {
let code = (errData as BusinessError).code;
let message = (errData as BusinessError).message;
console.error(`errData is errCode:${code} message:${message}`);
}
zlib.decompressFile10+
decompressFile(inFile: string, outFile: string, callback: AsyncCallback<void>): void
解压文件,解压的结果,使用callback异步回调返回。成功时返回null,失败时返回错误码。
系统能力: SystemCapability.BundleManager.Zlib
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
inFile | string | 是 | 指定的待解压缩文件的文件路径,文件后缀需要以.zip结尾。文件路径必须为沙箱路径,沙箱路径可以通过context获取,可参考FA模型,Stage模型。 |
outFile | string | 是 | 指定的解压后的文件夹路径,文件夹目录路径需要在系统中存在,不存在则会解压失败。路径必须为沙箱路径,沙箱路径可以通过context获取,具体方法可参考application/context(Stage模型)或 app/context(FA模型)。如果待解压的文件或文件夹在解压后的路径下已经存在,则会直接覆盖同名文件或同名文件夹中的同名文件。 |
callback | AsyncCallback<void> | 是 | 异步获取解压结果之后的回调。成功返回null,失败返回错误码。 |
错误码:
以下错误码的详细介绍请参见ohos.zlib错误码。
错误码ID | 错误信息 |
---|---|
900001 | The input source file is invalid. |
900002 | The input destination file is invalid. |
900003 | The input source file is not ZIP format or damaged. |
示例:
// 代码中使用的路径需为应用的沙箱路径,如/data/storage/el2/base/haps,也可以通过context获取。
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xx/xxx.zip';
let outFileDir = '/xxx';
try {
zlib.decompressFile(inFile, outFileDir, (errData: BusinessError) => {
if (errData !== null) {
console.error(`decompressFile failed. code is ${errData.code}, message is ${errData.message}`);
}
})
} catch(errData) {
let code = (errData as BusinessError).code;
let message = (errData as BusinessError).message;
console.error(`decompressFile failed. code is ${code}, message is ${message}`);
}
Options
系统能力: SystemCapability.BundleManager.Zlib
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
level | CompressLevel | 是 | 否 | 参考zip.CompressLevel枚举定义。 |
memLevel | MemLevel | 是 | 否 | 参考zip.MemLevel枚举定义。 |
strategy | CompressStrategy | 是 | 否 | 参考zip.CompressStrategy枚举定义。 |
zip.CompressLevel
系统能力: SystemCapability.BundleManager.Zlib
名称 | 值 | 说明 |
---|---|---|
COMPRESS_LEVEL_NO_COMPRESSION | 0 | 压缩率为0压缩等级。 |
COMPRESS_LEVEL_BEST_SPEED | 1 | 最佳速度压缩等级。 |
COMPRESS_LEVEL_BEST_COMPRESSION | 9 | 最佳压缩等级。 |
COMPRESS_LEVEL_DEFAULT_COMPRESSION | -1 | 默认压缩等级。 |
zip.MemLevel
系统能力: SystemCapability.BundleManager.Zlib
名称 | 值 | 说明 |
---|---|---|
MEM_LEVEL_MIN | 1 | zip 接口在压缩过程中最小使用内存。 |
MEM_LEVEL_MAX | 9 | zip 接口在压缩过程中最大使用内存。 |
MEM_LEVEL_DEFAULT | 8 | zip 接口在压缩过程中默认使用内存。 |
zip.CompressStrategy
系统能力: SystemCapability.BundleManager.Zlib
名称 | 值 | 说明 |
---|---|---|
COMPRESS_STRATEGY_DEFAULT_STRATEGY | 0 | 常规数据策略。 |
COMPRESS_STRATEGY_FILTERED | 1 | 过滤器产生的数据压缩策略。 |
COMPRESS_STRATEGY_HUFFMAN_ONLY | 2 | 霍夫曼编码格式压缩策略。 |
COMPRESS_STRATEGY_RLE | 3 | 游标编码压缩策略。 |
COMPRESS_STRATEGY_FIXED | 4 | 固定的压缩策略。 |
zip.ErrorCode
系统能力: SystemCapability.BundleManager.Zlib
名称 | 值 | 说明 |
---|---|---|
ERROR_CODE_OK | 0 | 函数调用成功。 |
ERROR_CODE_ERRNO | -1 | 函数调用失败。 |
最后
有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道需要重点掌握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。所以有一份实用的鸿蒙(HarmonyOS NEXT)资料用来跟着学习是非常有必要的。
这份鸿蒙(HarmonyOS NEXT)资料包含了鸿蒙开发必掌握的核心知识要点,内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等)鸿蒙(HarmonyOS NEXT)技术知识点。
希望这一份鸿蒙学习资料能够给大家带来帮助,有需要的小伙伴自行领取,限时开源,先到先得~无套路领取!!
获取这份完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料
鸿蒙(HarmonyOS NEXT)最新学习路线
-
HarmonOS基础技能
- HarmonOS就业必备技能
- HarmonOS多媒体技术
- 鸿蒙NaPi组件进阶
- HarmonOS高级技能
- 初识HarmonOS内核
- 实战就业级设备开发
有了路线图,怎么能没有学习资料呢,小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙(OpenHarmony )学习手册(共计1236页)与鸿蒙(OpenHarmony )开发入门教学视频,内容包含:ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。
获取以上完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料
《鸿蒙 (OpenHarmony)开发入门教学视频》
《鸿蒙生态应用开发V2.0白皮书》
《鸿蒙 (OpenHarmony)开发基础到实战手册》
OpenHarmony北向、南向开发环境搭建
《鸿蒙开发基础》
- ArkTS语言
- 安装DevEco Studio
- 运用你的第一个ArkTS应用
- ArkUI声明式UI开发
- .……
《鸿蒙开发进阶》
- Stage模型入门
- 网络管理
- 数据管理
- 电话服务
- 分布式应用开发
- 通知与窗口管理
- 多媒体技术
- 安全技能
- 任务管理
- WebGL
- 国际化开发
- 应用测试
- DFX面向未来设计
- 鸿蒙系统移植和裁剪定制
- ……
《鸿蒙进阶实战》
- ArkTS实践
- UIAbility应用
- 网络案例
- ……
获取以上完整鸿蒙HarmonyOS学习资料,请点击→纯血版全套鸿蒙HarmonyOS学习资料
总结
总的来说,华为鸿蒙不再兼容安卓,对中年程序员来说是一个挑战,也是一个机会。只有积极应对变化,不断学习和提升自己,他们才能在这个变革的时代中立于不败之地。