1# 数据存储 2 3> **说明：** 4> 5> - 从API Version 6开始，该模块不再维护，可以使用模块[`@ohos.data.storage`](js-apis-data-storage.md)。 6> 7> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8 9## 导入模块 10 11```js 12import storage from '@system.storage'; 13``` 14 15## storage.get 16 17get(options: GetStorageOptions): void 18 19通过索引读取缓存中存储的值。 20 21**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 22 23**参数：** 24 25| 参数名 | 类型 | 必填 | 说明 | 26| ------- | -------------------- | ---- | ---------- | 27| options | [GetStorageOptions](#getstorageoptions) | 是 | 接口配置信息。 | 28 29**示例：** 30 31```js 32export default { 33 storageGet() { 34 storage.get({ 35 key: 'storage_key', 36 success: function(data) { 37 console.log('call storage.get success: ' + data); 38 }, 39 fail: function(data, code) { 40 console.log('call storage.get fail, code: ' + code + ', data: ' + data); 41 }, 42 complete: function() { 43 console.log('call complete'); 44 }, 45 }); 46 } 47} 48``` 49 50## storage.set 51 52set(options: SetStorageOptions): void 53 54修改缓存中索引对应的值。 55 56**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 57 58**参数：** 59 60| 参数名 | 类型 | 必填 | 说明 | 61| ------- | ------------------- | ---- | ---------- | 62| options | [SetStorageOptions](#setstorageoptions) | 是 | 接口配置信息。 | 63 64**示例：** 65 66```js 67export default { 68 storageSet() { 69 storage.set({ 70 key: 'storage_key', 71 value: 'storage value', 72 success: function() { 73 console.log('call storage.set success.'); 74 }, 75 fail: function(data, code) { 76 console.log('call storage.set fail, code: ' + code + ', data: ' + data); 77 }, 78 }); 79 } 80} 81``` 82 83## storage.clear 84 85clear(options?: ClearStorageOptions): void 86 87清空缓存中存储的键值对。 88 89**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 90 91**参数：** 92 93| 参数名 | 类型 | 必填 | 说明 | 94| ------- | ------------------------------------------- | ---- | -------------- | 95| options | [ClearStorageOptions](#clearstorageoptions) | 否 | 接口配置信息。 | 96 97**示例：** 98 99```js 100export default { 101 storageClear() { 102 storage.clear({ 103 success: function() { 104 console.log('call storage.clear success.'); 105 }, 106 fail: function(data, code) { 107 console.log('call storage.clear fail, code: ' + code + ', data: ' + data); 108 }, 109 }); 110 } 111} 112``` 113 114## storage.delete 115 116delete(options: DeleteStorageOptions): void 117 118删除缓存中索引对应的键值对。 119 120**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 121 122**参数：** 123 124| 参数名 | 类型 | 必填 | 说明 | 125| ------- | --------------------------------------------- | ---- | -------------- | 126| options | [DeleteStorageOptions](#deletestorageoptions) | 是 | 接口配置信息。 | 127 128**示例：** 129 130```js 131export default { 132 storageDelete() { 133 storage.delete({ 134 key: 'Storage1', 135 success: function() { 136 console.log('call storage.delete success.'); 137 }, 138 fail: function(data, code) { 139 console.log('call storage.delete fail, code: ' + code + ', data: ' + data); 140 }, 141 }); 142 } 143} 144``` 145 146## GetStorageOptions 147 148**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 149 150| 名称 | 类型 | 必填 | 说明 | 151| -------- | ---------------- | ---- | ------------------- | 152| key | string | 是 | 内容索引。 | 153| default | string | 否 | key不存在则返回的默认值。 | 154| success | (data: any) => void | 否 | 接口调用成功的回调函数，data为返回key对应的value。 | 155| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数，data为错误信息，code为错误码。 | 156| complete | () => void | 否 | 接口调用结束的回调函数。 | 157 158 159## SetStorageOptions 160 161**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 162 163| 名称 | 类型 | 必填 | 说明 | 164| -------- | ------------------- | ---- | -------------------- | 165| key | string | 是 | 要修改的存储值的索引。 | 166| value | string | 是 | 新值。长度需小于128字节。 | 167| success | () => void | 否 | 接口调用成功的回调函数。 | 168| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数，data为错误信息，code为错误码。 | 169| complete | () => void | 否 | 接口调用结束的回调函数。 | 170 171 172## ClearStorageOptions 173 174**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 175 176| 名称 | 类型 | 必填 | 说明 | 177| -------- | --------------------- | ---- | -------------------- | 178| success | () => void | 否 | 接口调用成功的回调函数。 | 179| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数，data为错误信息，code为错误码。 | 180| complete | () => void | 否 | 接口调用结束的回调函数。 | 181 182 183## DeleteStorageOptions 184 185**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core 186 187| 名称 | 类型 | 必填 | 说明 | 188| -------- | -------------------- | ---- | ------------------ | 189| key | string | 是 | 内容索引。 | 190| success | () => void | 否 | 接口调用成功的回调函数。 | 191| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数，data为错误信息，code为错误码。 | 192| complete | () => void | 否 | 接口调用结束的回调函数。 |