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