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