閱讀(1.2k) 書簽贊(0) 我要糾錯

壓縮解壓縮文件的能力

2024-01-23 13:06 更新

本模塊提供壓縮解壓縮文件的能力

說明

本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨標(biāo)記接口的起始版本。

導(dǎo)入模塊


import zlib from '@ohos.zlib';

zlib.zipFile(deprecated)

zipFile(inFile: string, outFile: string, options: Options): Promise<void>

壓縮接口（Promise形式）。

從api9開始不再維護(hù)，建議使用zlib.compressFile

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

參數(shù)：

參數(shù)名	類型	必填	說明
inFile	string	是	指定壓縮的文件夾路徑或者文件路徑，對應(yīng)的路徑參考FA模型，Stage模型。
outFile	string	是	指定壓縮結(jié)果的文件路徑（文件的擴展名zip）。
options	Options	是	壓縮的可選參數(shù)。

返回值：

類型	說明
Promise<void>	ERROR_CODE_OK：壓縮成功； ERROR_CODE_ERRNO：壓縮失敗。

類型

說明

Promise<void>

ERROR_CODE_OK：壓縮成功；

ERROR_CODE_ERRNO：壓縮失敗。

示例1：


//【壓縮文件 例子1】
import zlib from '@ohos.zlib';
let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let 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) => {
    console.log('zipFile result is ' + JSON.stringify(data));
}).catch((err) => {
    console.log('error is ' + JSON.stringify(err));
});

示例2：


// 【壓縮文件夾 例子2】
import zlib from '@ohos.zlib';
let inFile = '/xxx/xxx';
let outFile = '/xxx/xxx.zip';
let 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) => {
    console.log('zipFile result is ' + JSON.stringify(data));
}).catch((err)=>{
    console.log('error is ' + JSON.stringify(err));
});

zlib.unzipFile(deprecated)

unzipFile(inFile:string, outFile:string, options: Options): Promise<void>

解壓文件，解壓完成返回執(zhí)行結(jié)果（Promise形式）。

從api9開始不再看護(hù)，建議使用zlib.decompressFile

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

參數(shù)：

參數(shù)名	類型	必填	說明
inFile	string	是	指定待解壓的文件夾路徑或者文件路徑，對應(yīng)的路徑參考FA模型，stage模型。
outFile	string	是	指定的解壓文件路徑。
options	Options	是	解壓的可選參數(shù)。

返回值：

類型	說明
Promise<void>	ERROR_CODE_OK：解壓成功； ERROR_CODE_ERRNO：解壓失敗返回執(zhí)行結(jié)果。

類型

說明

Promise<void>

ERROR_CODE_OK：解壓成功；

ERROR_CODE_ERRNO：解壓失敗返回執(zhí)行結(jié)果。

示例：


// 【解壓縮 例子1】
import zlib from '@ohos.zlib';
let inFile = '/xx/xxx.zip';
let outFile = '/xxx';

let 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) => {
    console.log('unzipFile result is ' + JSON.stringify(data));
}).catch((err)=>{
    console.log('error is ' + JSON.stringify(err));
})

zlib.compressFile9+

compressFile(inFile: string, outFile: string, options: Options, callback: AsyncCallback<void>): void;

壓縮文件，壓縮的結(jié)果通過callback返回。成功時返回null，失敗時返回錯誤碼ID。

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

參數(shù)：

參數(shù)名	類型	必填	說明
inFile	string	是	指定壓縮的文件夾路徑或者文件路徑，對應(yīng)的路徑參考FA模型，stage模型。
outFile	string	是	指定壓縮結(jié)果的文件路徑。
options	Options	是	壓縮的配置參數(shù)。
AsyncCallback<void>	callback	否	壓縮時的回調(diào)函數(shù)。

相關(guān)錯誤碼

以下錯誤碼的詳細(xì)介紹請參見ohos.zlib錯誤碼。

錯誤碼ID	錯誤信息
900001	The Input source file is invalid.
900002	The Input destination file is invalid.

示例


// 【壓縮文件 例子1】
// 代碼中使用的路徑需為應(yīng)用的沙箱路徑，如/data/storage/el2/base/haps,也可以通過context獲取
import zlib from '@ohos.zlib';
let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let 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) => {
        if (errData !== null) {
            console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
        }
    })
} catch(errData) {
    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
}

compressFile(inFile: string, outFile: string, options: Options): Promise<void>;

壓縮文件，壓縮的結(jié)果通過promise返回，成功時返回null，失敗時返回錯誤碼。

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

參數(shù)：

參數(shù)名	類型	必填	說明
inFile	string	是	指定壓縮的文件夾路徑或者文件路徑，對應(yīng)的路徑參考FA模型，stage模型。
outFile	string	是	指定壓縮結(jié)果的文件路徑。
options	Options	是	壓縮的配置參數(shù)。

相關(guān)錯誤碼

以下錯誤碼的詳細(xì)介紹請參見ohos.zlib錯誤碼。

錯誤碼ID	錯誤信息
900001	The Input source file is invalid.
900002	The Input destination file is invalid.


// 【壓縮文件 例子2】
// 代碼中使用的路徑需為應(yīng)用的沙箱路徑，如/data/storage/el2/base/haps,也可以通過context獲取
import zlib from '@ohos.zlib';
let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let 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) => {
        console.info('compressFile success');
    }).catch((errData) => {
        console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
    })
} catch(errData) {
    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
}

zlib.decompressFile9+

decompressFile(inFile: string, outFile: string, options: Options, callback: AsyncCallback<void>): void;

解壓文件，解壓的結(jié)果通過callback返回，成功時返回null，失敗時返回錯誤碼。

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

參數(shù)：

參數(shù)名	類型	必填	說明
inFile	string	是	指定的待解壓縮文件的文件路徑，對應(yīng)的路徑參考FA模型，stage模型。
outFile	string	是	指定的解壓后的目錄路徑。
options	Options	是	解壓的配置參數(shù)。
AsyncCallback<void>	callback	否	解壓是的回調(diào)函數(shù)。

相關(guān)錯誤碼

以下錯誤碼的詳細(xì)介紹請參見ohos.zlib錯誤碼。

錯誤碼ID	錯誤信息
900001	The Input source file is invalid.
900002	The Input destination file is invalid.

示例


// 【解壓縮 例子1】
// 代碼中使用的路徑需為應(yīng)用的沙箱路徑，如/data/storage/el2/base/haps,也可以通過context獲取
import zlib from '@ohos.zlib';
let inFile = '/xx/xxx.zip';
let outFile = '/xxx';
let options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
  memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
  strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};

try {
    zlib.decompressFile(inFile, outFile, options, (errData) => {
        if (errData !== null) {
            console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
        }
    })
} catch(errData) {
    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
}

decompressFile(inFile: string, outFile: string, options: Options): Promise<void>;

解壓文件，解壓的結(jié)果通過promise返回，成功時返回null，失敗時返回錯誤碼。

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

參數(shù)：

參數(shù)名	類型	必填	說明
inFile	string	是	指定的待解壓縮文件的文件路徑，對應(yīng)的路徑參考FA模型，stage模型。
outFile	string	是	指定的解壓后的目錄路徑。
options	Options	是	解壓時的配置參數(shù)。

相關(guān)錯誤碼

以下錯誤碼的詳細(xì)介紹請參見ohos.zlib錯誤碼。

錯誤碼ID	錯誤信息
900001	The Input source file is invalid.
900002	The Input destination file is invalid.


// 【解壓縮 例子2】
// 代碼中使用的路徑需為應(yīng)用的沙箱路徑，如/data/storage/el2/base/haps,也可以通過context獲取
import zlib from '@ohos.zlib';
let inFile = '/xx/xxx.zip';
let outFile = '/xxx';
let options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
  memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
  strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};

try {
    zlib.decompressFile(inFile, outFile, options).then((data) => {
        console.info('decompressFile success');
    }).catch((errData) => {
        console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
    })
} catch(errData) {
    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
}

Options

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

名稱	類型	可讀	可寫	說明
level	CompressLevel	是	否	參考zip.CompressLevel枚舉定義。
memLevel	MemLevel	是	否	參考zip.MemLevel枚舉定義。
strategy	CompressStrategy	是	否	參考zip.CompressStrategy枚舉定義。

zip.CompressLevel

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

名稱	值	說明
COMPRESS_LEVEL_NO_COMPRESSION	0	壓縮率為0壓縮等級。
COMPRESS_LEVEL_BEST_SPEED	1	最佳速度壓縮等級。
COMPRESS_LEVEL_BEST_COMPRESSION	9	最佳壓縮等級。
COMPRESS_LEVEL_DEFAULT_COMPRESSION	-1	默認(rèn)壓縮等級。

zip.MemLevel

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

名稱	值	說明
MEM_LEVEL_MIN	1	zip 接口在壓縮過程中最小使用內(nèi)存。
MEM_LEVEL_MAX	9	zip 接口在壓縮過程中最大使用內(nèi)存。
MEM_LEVEL_DEFAULT	8	zip 接口在壓縮過程中默認(rèn)使用內(nèi)存。

zip.CompressStrategy

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

名稱	值	說明
COMPRESS_STRATEGY_DEFAULT_STRATEGY	0	常規(guī)數(shù)據(jù)策略。
COMPRESS_STRATEGY_FILTERED	1	過濾器產(chǎn)生的數(shù)據(jù)壓縮策略。
COMPRESS_STRATEGY_HUFFMAN_ONLY	2	霍夫曼編碼格式壓縮策略。
COMPRESS_STRATEGY_RLE	3	游標(biāo)編碼壓縮策略。
COMPRESS_STRATEGY_FIXED	4	固定的壓縮策略。

zip.ErrorCode

系統(tǒng)能力： SystemCapability.BundleManager.Zlib

名稱	值	說明
ERROR_CODE_OK	0	函數(shù)調(diào)用成功。
ERROR_CODE_ERRNO	-1	函數(shù)調(diào)用失敗。

以上內(nèi)容是否對您有幫助：

← 查詢默認(rèn)應(yīng)用的能力

Ability信息的定義 →

寫筆記

我要補充

壓縮解壓縮文件的能力

導(dǎo)入模塊

zlib.zipFile(deprecated)

zlib.unzipFile(deprecated)

zlib.compressFile9+

zlib.decompressFile9+

Options

zip.CompressLevel

zip.MemLevel

zip.CompressStrategy

zip.ErrorCode

推薦文章

推薦教程

推薦課程