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