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