数据存储
说明:
- 从API Version 6开始,该模块不再维护,可以使用模块[
@ohos.data.storage
]。在API Version 9后,推荐使用新模块[@ohos.data.preferences
]。- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import storage from '@system.storage';
storage.get
get(Object): void
通过索引读取缓存中存储的值。
系统能力: SystemCapability.DistributedDataManager.Preferences.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 内容索引。 |
default | string | 否 | key不存在则返回的默认值。 |
success | Function | 否 | 接口调用成功的回调函数,data为返回key对应的value。 |
fail | Function | 否 | 接口调用失败的回调函数,data为错误信息,code为错误码。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
示例:
export default { storageGet() { storage.get({ key: 'storage_key', success: function(data) { console.log('call storage.get success: ' + data); }, fail: function(data, code) { console.log('call storage.get fail, code: ' + code + ', data: ' + data); }, complete: function() { console.log('call complete'); },}); }
}
storage.set
set(Object): void
修改缓存中索引对应的值。
系统能力: SystemCapability.DistributedDataManager.Preferences.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 要修改的存储值的索引。 |
value | string | 是 | 新值。长度需小于128字节。 |
success | Function | 否 | 接口调用成功的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数,data为错误信息,code为错误码。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
示例:
export default { storageSet() { storage.set({ key: 'storage_key', value: 'storage value', success: function() { console.log('call storage.set success.'); }, fail: function(data, code) { console.log('call storage.set fail, code: ' + code + ', data: ' + data); }, }); }
}
storage.clear
clear(Object): void
清空缓存中存储的键值对。
系统能力: SystemCapability.DistributedDataManager.Preferences.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数,data为错误信息,code为错误码。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
示例:
export default { storageClear() { storage.clear({ success: function() { console.log('call storage.clear success.'); }, fail: function(data, code) { console.log('call storage.clear fail, code: ' + code + ', data: ' + data); }, }); }
}
storage.delete
delete(Object): void
删除缓存中索引对应的键值对。
系统能力: SystemCapability.DistributedDataManager.Preferences.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 内容索引。 |
success | Function | 否 | 接口调用成功的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数,data为错误信息,code为错误码。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
示例:
export default { storageDelete() { storage.delete({ key: 'Storage1', success: function() { console.log('call storage.delete success.'); }, fail: function(data, code) { console.log('call storage.delete fail, code: ' + code + ', data: ' + data); }, }); }
}