文件哈希处理

2024-01-23 16:31 更新

该模块提供文件哈希处理能力,对文件内容进行哈希处理。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

  1. import Hash from '@ohos.file.hash';

使用说明

使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:

Stage模型

  1. import UIAbility from '@ohos.app.ability.UIAbility';
  2. export default class EntryAbility extends UIAbility {
  3. onWindowStageCreate(windowStage) {
  4. let context = this.context;
  5. let pathDir = context.filesDir;
  6. }
  7. }

FA模型

  1. import featureAbility from '@ohos.ability.featureAbility';
  2. let context = featureAbility.getContext();
  3. context.getFilesDir().then((data) => {
  4. let pathDir = data;
  5. })

FA模型context的具体获取方法参见FA模型

Hash.hash

hash(path: string, algorithm: string): Promise<string>

计算文件的哈希值,使用Promise异步回调。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

待计算哈希值文件的应用沙箱路径。

algorithm

string

哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。

返回值:

类型

说明

Promise<string>

Promise对象。返回文件的哈希值。表示为十六进制数字串,所有字母均大写。

错误码:

以下错误码的详细介绍请参见基础文件IO错误码

错误码ID

错误信息

13900020

Invalid argument

13900042

Unknown error

示例:

  1. let filePath = pathDir + "/test.txt";
  2. Hash.hash(filePath, "sha256").then((str) => {
  3. console.info("calculate file hash succeed:" + str);
  4. }).catch((err) => {
  5. console.error("calculate file hash failed with error message: " + err.message + ", error code: " + err.code);
  6. });

Hash.hash

hash(path: string, algorithm: string, callback: AsyncCallback<string>): void

计算文件的哈希值,使用callback异步回调。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

待计算哈希值文件的应用沙箱路径。

algorithm

string

哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。

callback

AsyncCallback<string>

异步计算文件哈希操作之后的回调函数(其中给定文件哈希值表示为十六进制数字串,所有字母均大写)。

错误码:

以下错误码的详细介绍请参见基础文件IO错误码

错误码ID

错误信息

13900020

Invalid argument

13900042

Unknown error

示例:

  1. let filePath = pathDir + "/test.txt";
  2. Hash.hash(filePath, "sha256", (err, str) => {
  3. if (err) {
  4. console.error("calculate file hash failed with error message: " + err.message + ", error code: " + err.code);
  5. } else {
  6. console.info("calculate file hash succeed:" + str);
  7. }
  8. });
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号