1# 查询关键资产(ArkTS) 2 3<!--Kit: Asset Store Kit--> 4<!--Subsystem: Security--> 5<!--Owner: @JeremyXu--> 6<!--Designer: @skye_you--> 7<!--Tester: @nacyli--> 8<!--Adviser: @zengyawen--> 9 10## 接口介绍 11 12可通过API文档查询新增关键资产的异步接口[query(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetquery)、同步接口[querySync(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetquerysync12)的详细介绍。 13 14在查询关键资产时，关键资产属性的内容（AssetMap）参数如下表所示： 15>**注意：** 16> 17>下表中“ALIAS”和名称包含“DATA_LABEL”的关键资产属性，用于存储业务自定义信息，其内容不会被加密，请勿存放敏感个人数据。 18 19| 属性名称（Tag） | 属性内容（Value） | 是否必选 | 说明 | 20| --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | 21| ALIAS | 类型为Uint8Array，长度为1-256字节。 | 可选 | 关键资产别名，每条关键资产的唯一索引。 | 22| ACCESSIBILITY | 类型为number，取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility)。 | 可选 | 基于锁屏状态的访问控制。 | 23| REQUIRE_PASSWORD_SET | 类型为boolean。 | 可选 | 是否仅在设置了锁屏密码的情况下，可访问关键资产。为true时表示查询仅用户设置了锁屏密码才允许访问的关键资产；为false时表示查询无论用户是否设置锁屏密码，均可访问的关键资产。 | 24| AUTH_TYPE | 类型为number，取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype)。 | 可选 | 访问关键资产所需的用户认证类型。 | 25| SYNC_TYPE | 类型为number，取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype)。 | 可选 | 关键资产支持的同步类型。 | 26| IS_PERSISTENT | 类型为boolean。 | 可选 | 在应用卸载时是否需要保留关键资产。为true时表示查询应用卸载后会被保留的关键资产；为false时表示查询应用卸载后会被删除的关键资产。 | 27| DATA_LABEL_CRITICAL_1 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br>**说明：** API12前长度为1-512字节。 | 28| DATA_LABEL_CRITICAL_2 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 29| DATA_LABEL_CRITICAL_3 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 30| DATA_LABEL_CRITICAL_4 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 31| DATA_LABEL_NORMAL_1 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 32| DATA_LABEL_NORMAL_2 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 33| DATA_LABEL_NORMAL_3 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 34| DATA_LABEL_NORMAL_4 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 35| DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 36| DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 37| DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 38| DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 39| RETURN_TYPE | 类型为number，取值范围详见[ReturnType](../../reference/apis-asset-store-kit/js-apis-asset.md#returntype)。 | 可选 | 关键资产查询返回的结果类型。 | 40| RETURN_LIMIT | 类型为number。 | 可选 | 关键资产查询返回的结果数量。 | 41| RETURN_OFFSET | 类型为number，取值范围：1-65536。 | 可选 | 关键资产查询返回的结果偏移量。<br>**说明：** 用于分批查询场景时，指定从第几个结果开始返回。 | 42| RETURN_ORDERED_BY | 类型为number，取值范围：asset.Tag.DATA_LABEL_xxx。 | 可选 | 关键资产查询返回的结果排序依据，仅支持按照附属信息排序。<br>**说明：** 默认按照关键资产新增的顺序返回。 | 43| REQUIRE_ATTR_ENCRYPTED<sup>14+</sup> | 类型为boolean。 | 可选 | 是否查询业务自定义附属信息被加密的数据。为true时表示查询业务自定义附属信息加密存储的数据，为false时表示查询业务自定义附属信息不加密存储的数据。默认值为false。| 44| GROUP_ID<sup>18+</sup> | 类型为Uint8Array，长度为7-127字节。 | 可选 | 待查询的关键资产所属群组，默认查询不属于任何群组的关键资产。| 45 46## 约束和限制 47 48批量查询的关键资产需要通过IPC通道传输给业务。由于IPC缓冲区大小的限制，建议当查询超过40条关键资产时，进行分批查询，每次查询数量不超过40条。 49 50## 代码示例 51 52> **说明：** 53> 54> 本模块提供了异步和同步两套接口，以下为异步接口的使用示例，同步接口详见[API文档](../../reference/apis-asset-store-kit/js-apis-asset.md)。 55> 56> 在指定群组中查询一条关键资产明文的使用示例详见[查询单条群组关键资产明文](asset-js-group-access-control.md#查询单条群组关键资产明文)，在指定群组中查询一条关键资产属性的使用示例详见[查询单条群组关键资产属性](asset-js-group-access-control.md#查询单条群组关键资产属性)。 57 58### 查询单条关键资产明文 59 60查询别名是demo_alias的关键资产明文。 61 62```typescript 63import { asset } from '@kit.AssetStoreKit'; 64import { util } from '@kit.ArkTS'; 65import { BusinessError } from '@kit.BasicServicesKit'; 66 67function stringToArray(str: string): Uint8Array { 68 let textEncoder = new util.TextEncoder(); 69 return textEncoder.encodeInto(str); 70} 71 72function arrayToString(arr: Uint8Array): string { 73 let textDecoder = util.TextDecoder.create("utf-8", { ignoreBOM: true }); 74 let str = textDecoder.decodeToString(arr, { stream: false }) 75 return str; 76} 77 78let query: asset.AssetMap = new Map(); 79query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); // 指定了关键资产别名，最多查询到一条满足条件的关键资产。 80query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ALL); // 此处表示需要返回关键资产的所有信息，即属性+明文。 81try { 82 asset.query(query).then((res: Array<asset.AssetMap>) => { 83 for (let i = 0; i < res.length; i++) { 84 // 解析secret。 85 let secret: Uint8Array = res[i].get(asset.Tag.SECRET) as Uint8Array; 86 // 将Uint8Array转为string类型。 87 let secretStr: string = arrayToString(secret); 88 } 89 }).catch((err: BusinessError) => { 90 console.error(`Failed to query Asset. Code is ${err.code}, message is ${err.message}`); 91 }); 92} catch (err) { 93 console.error(`Failed to query Asset. Code is ${err?.code}, message is ${err?.message}`); 94} 95``` 96 97### 查询单条关键资产属性 98 99查询别名是demo_alias的关键资产属性。 100 101```typescript 102import { asset } from '@kit.AssetStoreKit'; 103import { util } from '@kit.ArkTS'; 104import { BusinessError } from '@kit.BasicServicesKit'; 105 106function stringToArray(str: string): Uint8Array { 107 let textEncoder = new util.TextEncoder(); 108 return textEncoder.encodeInto(str); 109} 110 111let query: asset.AssetMap = new Map(); 112query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); // 指定了关键资产别名，最多查询到一条满足条件的关键资产。 113query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ATTRIBUTES); // 此处表示仅返回关键资产属性，不包含关键资产明文。 114try { 115 asset.query(query).then((res: Array<asset.AssetMap>) => { 116 for (let i = 0; i < res.length; i++) { 117 // 解析属性。 118 let accessibility: number = res[i].get(asset.Tag.ACCESSIBILITY) as number; 119 console.info(`Succeeded in getting accessibility, which is: ${accessibility}.`); 120 } 121 }).catch((err: BusinessError) => { 122 console.error(`Failed to query Asset. Code is ${err.code}, message is ${err.message}`); 123 }); 124} catch (err) { 125 console.error(`Failed to query Asset. Code is ${err?.code}, message is ${err?.message}`); 126} 127``` 128 129### 批量查询关键资产属性 130 131批量查询标签1为demo_label的关键资产属性，从第5条符合条件的结果开始返回，共返回10条，结果按DATA_LABEL_NORMAL_1属性内容排序。 132 133```typescript 134import { asset } from '@kit.AssetStoreKit'; 135import { util } from '@kit.ArkTS'; 136import { BusinessError } from '@kit.BasicServicesKit'; 137 138function stringToArray(str: string): Uint8Array { 139 let textEncoder = new util.TextEncoder(); 140 return textEncoder.encodeInto(str); 141} 142 143let query: asset.AssetMap = new Map(); 144query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ATTRIBUTES); // 此处表示仅返回关键资产属性，不包含关键资产明文。 145query.set(asset.Tag.DATA_LABEL_NORMAL_1, stringToArray('demo_label')); 146query.set(asset.Tag.RETURN_LIMIT, 10); // 此处表示查询10条满足条件的关键资产。 147query.set(asset.Tag.RETURN_ORDERED_BY, asset.Tag.DATA_LABEL_NORMAL_1); // 此处查询结果以DATA_LABEL_NORMAL_1属性内容排序。 148try { 149 asset.query(query).then((res: Array<asset.AssetMap>) => { 150 for (let i = 0; i < res.length; i++) { 151 // 解析属性。 152 let accessibility: number = res[i].get(asset.Tag.ACCESSIBILITY) as number; 153 console.info(`Succeeded in getting accessibility, which is: ${accessibility}.`); 154 } 155 }).catch((err: BusinessError) => { 156 console.error(`Failed to query Asset. Code is ${err.code}, message is ${err.message}`); 157 }); 158} catch (err) { 159 console.error(`Failed to query Asset. Code is ${err?.code}, message is ${err?.message}`); 160} 161``` 162