harmony 鸿蒙新增关键资产(ArkTS)

2025-06-16
浏览 (2)

新增关键资产(ArkTS)

接口介绍

可通过API文档查看新增关键资产的异步接口add(attributes: AssetMap)、同步接口addSync(attributes: AssetMap)的详细介绍。

在新增关键资产时，关键资产属性的内容（AssetMap）参数如下表所示：

注意：

下表中名称包含“DATA_LABEL”的关键资产属性，用于存储业务自定义信息，其内容不会被加密，请勿存放个人数据。

属性名称（Tag）	属性内容（Value）	是否必选	说明
SECRET	类型为Uint8Array，长度为1-1024字节。	必选	关键资产明文。
ALIAS	类型为Uint8Array，长度为1-256字节。	必选	关键资产别名，每条关键资产的唯一索引。
ACCESSIBILITY	类型为number，取值范围详见Accessibility。	可选	基于锁屏状态的访问控制，默认值为DEVICE_FIRST_UNLOCKED，即首次解锁后可访问。
REQUIRE_PASSWORD_SET	类型为boolean。	可选	是否仅在设置了锁屏密码的情况下，可访问关键资产。为true时，表示仅在用户设置了锁屏密码的情况下，关键资产才允许被访问；为false时，表示无论用户是否设置锁屏密码，关键资产均允许被访问。默认值为false。
AUTH_TYPE	类型为number，取值范围详见AuthType。	可选	访问关键资产所需的用户认证类型，默认值为NONE，即访问关键资产前无需用户认证。
SYNC_TYPE	类型为number，取值范围详见SyncType。	可选	关键资产支持的同步类型，默认值为NEVER，即不允许同步该关键资产。
IS_PERSISTENT	类型为boolean。	可选	在应用卸载时是否需要保留关键资产。为true时表示应用卸载后，应用存储的关键资产将被保留；为false时表示应用卸载后，应用存储的关键资产将被删除。默认值为false。注意：设置此属性时，需申请权限ohos.permission.STORE_PERSISTENT_DATA。
DATA_LABEL_CRITICAL_1	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且有完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_CRITICAL_2	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且有完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_CRITICAL_3	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且有完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_CRITICAL_4	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且有完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_NORMAL_1	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且无完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_NORMAL_2	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且无完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_NORMAL_3	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且无完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_NORMAL_4	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属信息，内容由业务自定义且无完整性保护。说明： API12前长度为1-512字节。
DATA_LABEL_NORMAL_LOCAL_1¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
DATA_LABEL_NORMAL_LOCAL_2¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
DATA_LABEL_NORMAL_LOCAL_3¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
DATA_LABEL_NORMAL_LOCAL_4¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
CONFLICT_RESOLUTION	类型为number，取值范围详见ConflictResolution。	可选	新增关键资产时的冲突（如：别名相同）处理策略，默认值为THROW_ERROR，即抛出异常，由业务进行后续处理。
REQUIRE_ATTR_ENCRYPTED¹⁴⁺	类型为boolean。	可选	是否加密业务自定义附属信息。为true时表示业务自定义附属信息加密存储，为false时表示业务自定义附属信息不加密存储。默认值为false。
GROUP_ID¹⁸⁺	类型为Uint8Array，长度为7-127字节。	可选	待新增的关键资产所属群组，默认新增不属于任何群组的关键资产。
WRAP_TYPE¹⁸⁺	类型为number，取值范围详见WrapType。	可选	关键资产支持的加密导入导出类型，默认值为NEVER，即不允许加密导入导出关键资产。

约束和限制

基于别名的访问

关键资产以密文的形式存储在ASSET数据库中，以业务身份 + 别名作为唯一索引。故业务需要保证每条关键资产的别名唯一。

业务自定义数据存储

ASSET为业务预留了12个关键资产自定义属性，名称以”DATA_LABEL”开头。对于超过12个自定义属性的情况，业务可以将多段数据按照一定的格式（如JSON）拼接到同一个ASSET属性中。

ASSET对部分属性会进行完整性保护，这部分属性名称以”DATA_LABEL_CRITICAL”开头，写入后不支持更新。

代码示例

说明：

本模块提供了异步和同步两套接口，以下为异步接口的使用示例，同步接口详见API文档。

在指定群组中新增一条关键资产的使用示例详见新增群组关键资产。

新增一条密码是demo_pwd，别名是demo_alias，附属信息是demo_label的关键资产，该关键资产在用户首次解锁设备后可被访问。

import { asset } from '@kit.AssetStoreKit';
import { util } from '@kit.ArkTS';
import { BusinessError } from '@kit.BasicServicesKit';

function stringToArray(str: string): Uint8Array {
  let textEncoder = new util.TextEncoder();
  return textEncoder.encodeInto(str);
}

let attr: asset.AssetMap = new Map();
attr.set(asset.Tag.SECRET, stringToArray('demo_pwd'));
attr.set(asset.Tag.ALIAS, stringToArray('demo_alias'));
attr.set(asset.Tag.ACCESSIBILITY, asset.Accessibility.DEVICE_FIRST_UNLOCKED);
attr.set(asset.Tag.DATA_LABEL_NORMAL_1, stringToArray('demo_label'));
try {
  asset.add(attr).then(() => {
    console.info(`Asset added successfully.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to add Asset. Code is ${err.code}, message is ${err.message}`);
  })
} catch (error) {
  let err = error as BusinessError;
  console.error(`Failed to add Asset. Code is ${err.code}, message is ${err.message}`);
}