1# 查询关键资产(C/C++) 2 3## 接口介绍 4 5接口文档链接： 6 7[int32_t OH_Asset_Query(const Asset_Attr *query, uint32_t queryCnt, Asset_ResultSet *resultSet)](../../reference/apis-asset-store-kit/_asset_api.md#oh_asset_query) 8 9参数列表： 10 11| 属性名称（Asset_Tag） | 属性内容（Asset_Value） | 是否必选 | 说明 | 12| ------------------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | 13| ASSET_TAG_ALIAS | 类型为uint8[]，长度为1-256字节 | 可选 | 关键资产别名，每条关键资产的唯一索引; | 14| ASSET_TAG_ACCESSIBILITY | 类型为uint32_t，取值范围详见[Asset_Accessibility](../../reference/apis-asset-store-kit/_asset_type.md#asset_accessibility) | 可选 | 基于锁屏状态的访问控制 | 15| ASSET_TAG_REQUIRE_PASSWORD_SET | 类型为bool | 可选 | 是否仅在设置了锁屏密码的情况下，可访问关键资产 | 16| ASSET_TAG_AUTH_TYPE | 类型为uint32_t，取值范围详见[Asset_AuthType](../../reference/apis-asset-store-kit/_asset_type.md#asset_authtype) | 可选 | 访问关键资产所需的用户认证类型 | 17| ASSET_TAG_SYNC_TYPE | 类型为uint32_t，取值范围详见[Asset_SyncType](../../reference/apis-asset-store-kit/_asset_type.md#asset_synctype) | 可选 | 关键资产支持的同步类型 | 18| ASSET_TAG_IS_PERSISTENT | 类型为bool | 可选 | 在应用卸载时是否需要保留关键资产 | 19| ASSET_TAG_DATA_LABEL_CRITICAL_1 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 20| ASSET_TAG_DATA_LABEL_CRITICAL_2 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 21| ASSET_TAG_DATA_LABEL_CRITICAL_3 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 22| ASSET_TAG_DATA_LABEL_CRITICAL_4 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 23| ASSET_TAG_DATA_LABEL_NORMAL_1 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 24| ASSET_TAG_DATA_LABEL_NORMAL_2 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 25| ASSET_TAG_DATA_LABEL_NORMAL_3 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 26| ASSET_TAG_DATA_LABEL_NORMAL_4 | 类型为uint8[]，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 27| ASSET_TAG_RETURN_TYPE | 类型为uint32_t，取值范围详见[Asset_ReturnType](../../reference/apis-asset-store-kit/_asset_type.md#asset_returntype) | 可选 | 关键资产查询返回的结果类型 | 28| ASSET_TAG_RETURN_LIMIT | 类型为uint32_t | 可选 | 关键资产查询返回的结果数量 | 29| ASSET_TAG_RETURN_OFFSET | 类型为uint32_t，取值范围：1-65536 | 可选 | 关键资产查询返回的结果偏移量<br>**说明：** 用于分批查询场景，指定从第几个开始返回 | 30| ASSET_TAG_RETURN_ORDERED_BY | 类型为uint32_t，取值范围：ASSET_TAG_DATA_LABEL_xxx | 可选 | 关键资产查询返回的结果排序依据，仅支持按照附属信息排序<br>**说明：** 默认按照关键资产新增的顺序返回。 | 31 32## 代码示例 33 34### 查询单条关键资产明文 35 36查询别名是demo_alias的关键资产明文。 37 381. 在CMake脚本中链接相关动态库 39 ```txt 40 target_link_libraries(entry PUBLIC libasset_ndk.z.so) 41 ``` 42 432. 参考如下示例代码，进行业务功能开发 44 ```c 45 #include <string.h> 46 47 #include "asset/asset_api.h" 48 49 void QueryAsset() { 50 static const char *ALIAS = "demo_alias"; 51 Asset_Blob alias = { (uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS }; 52 Asset_Attr attr[] = { 53 { .tag = ASSET_TAG_ALIAS, .value.blob = alias }, // 指定了关键资产别名，最多查询到一条满足条件的关键资产 54 { .tag = ASSET_TAG_RETURN_TYPE, .value.u32 = ASSET_RETURN_ALL }, // 此处表示需要返回关键资产的所有信息，即属性+明文 55 }; 56 57 Asset_ResultSet resultSet = {0}; 58 int32_t ret = OH_Asset_Query(attr, sizeof(attr) / sizeof(attr[0]), &resultSet); 59 if (ret == ASSET_SUCCESS) { 60 // Parse the resultSet. 61 for (uint32_t i = 0; i < resultSet.count; i++) { 62 // Parse the secret: the data is secret->blob.data, the size is secret->blob.size. 63 Asset_Attr *secret = OH_Asset_ParseAttr(resultSet.results + i, ASSET_TAG_SECRET); 64 } 65 } 66 OH_Asset_FreeResultSet(&resultSet); 67 } 68``` 69 70### 查询单条关键资产属性 71 72查询别名是demo_alias的关键资产属性。 73 741. 在CMake脚本中链接相关动态库 75 ```txt 76 target_link_libraries(entry PUBLIC libasset_ndk.z.so) 77 ``` 78 792. 参考如下示例代码，进行业务功能开发 80 ```c 81 #include <string.h> 82 83 #include "asset/asset_api.h" 84 85 void QueryAttributes() { 86 static const char *ALIAS = "demo_alias"; 87 Asset_Blob alias = { (uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS }; 88 Asset_Attr attr[] = { 89 { .tag = ASSET_TAG_ALIAS, .value.blob = alias }, // 指定了关键资产别名，最多查询到一条满足条件的关键资产 90 { .tag = ASSET_TAG_RETURN_TYPE, .value.u32 = ASSET_RETURN_ATTRIBUTES }, // 此处表示仅返回关键资产属性，不包含关键资产明文 91 }; 92 93 Asset_ResultSet resultSet = {0}; 94 int32_t ret = OH_Asset_Query(attr, sizeof(attr) / sizeof(attr[0]), &resultSet); 95 if (ret == ASSET_SUCCESS) { 96 // Parse the result. 97 for (uint32_t i = 0; i < resultSet.count; i++) { 98 // Parse the data label: the data is label->blob.data, the size is label->blob.size. 99 Asset_Attr *label = OH_Asset_ParseAttr(resultSet.results + i, ASSET_TAG_DATA_LABEL_NORMAL_1); 100 } 101 } 102 OH_Asset_FreeResultSet(&resultSet); 103 } 104 ``` 105 106### 批量查询关键资产属性 107 108批量查询附属信息是demo_label的关键资产属性，从第5条满足条件的结果开始返回，一共返回10条，且返回结果以DATA_LABEL_NORMAL_1属性内容排序。 109 1101. 在CMake脚本中链接相关动态库 111 ```txt 112 target_link_libraries(entry PUBLIC libasset_ndk.z.so) 113 ``` 114 1152. 参考如下示例代码，进行业务功能开发 116 ```c 117 #include <string.h> 118 119 #include "asset/asset_api.h" 120 121 void BatchQuery() { 122 static const char *LABEL = "demo_label"; 123 Asset_Blob label = { (uint32_t)(strlen(LABEL)), (uint8_t *)LABEL }; 124 125 Asset_Attr attr[] = { 126 { .tag = ASSET_TAG_RETURN_TYPE, .value.u32 = ASSET_RETURN_ATTRIBUTES }, 127 { .tag = ASSET_TAG_DATA_LABEL_NORMAL_1, .value.blob = label }, 128 { .tag = ASSET_TAG_RETURN_OFFSET, .value.u32 = 5 }, 129 { .tag = ASSET_TAG_RETURN_LIMIT, .value.u32 = 10 }, 130 { .tag = ASSET_TAG_RETURN_ORDERED_BY, .value.u32 = ASSET_TAG_DATA_LABEL_NORMAL_1 }, 131 }; 132 133 Asset_ResultSet resultSet = { 0 }; 134 int32_t ret = OH_Asset_Query(attr, sizeof(attr) / sizeof(attr[0]), &resultSet); 135 if (ret == ASSET_SUCCESS) { 136 // Parse the result. 137 for (uint32_t i = 0; i < resultSet.count; i++) { 138 // Parse the data alias: the data is alias->blob.data, the size is alias->blob.size.. 139 Asset_Attr *alias = OH_Asset_ParseAttr(resultSet.results + i, ASSET_TAG_ALIAS); 140 } 141 } 142 OH_Asset_FreeResultSet(&resultSet); 143 } 144 ``` 145 146## 约束和限制 147 148* 批量查询关键资产 149 150批量查询出的关键资产需要通过IPC通道传输给业务，受IPC缓冲区大小限制，建议对查询超过40条关键资产时，进行分批查询，且每次查询数量不超过40条。 151