uni-app——本地数据缓存

数据缓存

1、设置本地存储内容

uni.setStorage(OBJECT)

将数据存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。

OBJECT 参数说明

参数名	类型	必填	说明
key	String	是	本地缓存中的指定的 key
data	Any	是	需要存储的内容，只支持原生类型、及能够通过 JSON.stringify 序列化的对象
success	Function	否	接口调用成功的回调函数
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

示例

uni.setStorage({
	key: 'userInfo',
	data: 'hello',
	success: function () {
		console.log('success');
	}
});

uni.setStorageSync(KEY,DATA)
将 data 存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。

参数说明

参数	类型	必填	说明
key	String	是	本地缓存中的指定的 key
data	Any	是	需要存储的内容，只支持原生类型、及能够通过 JSON.stringify 序列化的对象

	uni.setStorageSync('userInfo', 'hello');

2、获取本地存储的内容

uni.getStorage(OBJECT)

从本地缓存中异步获取指定 key 对应的内容。异步接口
OBJECT 参数说明

参数名	类型	必填	说明
key	String	是	本地缓存中的指定的 key
success	Function	是	接口调用的回调函数，res = {data: key对应的内容}
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

success 返回参数说明

参数	类型	说明
data	Any	key 对应的内容

示例

uni.getStorage({
	key: 'userInfo',
	success: function (res) {
		console.log(res.data);
	}
});

uni.getStorageSync(KEY)

从本地缓存中同步获取指定 key 对应的内容。

参数说明

参数	类型	必填	说明
key	String	是	本地缓存中的指定的 key

示例

const value = uni.getStorageSync('userInfo');
if (value) {
	console.log(value);
}

3、移出本地存储的内容

uni.removeStorage(OBJECT)

从本地缓存中异步移除指定 key。异步接口

OBJECT 参数说明

参数名	类型	必填	说明
key	String	是	本地缓存中的指定的 key
success	Function	是	接口调用的回调函数
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

示例

uni.removeStorage({
	key: 'userInfo',
	success: function (res) {
		console.log(res.data);
	}
})

uni.removeStorageSync(KEY)

从本地缓存中同步移除指定 key。同步接口

参数说明

参数名	类型	必填	说明
key	String	是	本地缓存中的指定的 key

示例

uni.removeStorageSync('userInfo')

4、清理本地数据缓存

uni.clearStorage()

清理本地数据缓存。

示例

uni.clearStorage();

uni.clearStorageSync()

同步清理本地数据缓存。

示例

uni.clearStorageSync();

5、获取本地缓存的所有键名

uni.getStorageInfo(OBJECT)

异步获取当前 storage 的相关信息。

OBJECT 参数说明

参数名	类型	必填	说明
success	Function	是	接口调用的回调函数，详见返回参数说明
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

success 返回参数说明

参数	类型	说明
keys	Array＜String＞	当前 storage 中所有的 key
currentSize	Number	当前占用的空间大小, 单位：kb
limitSize	Number	限制的空间大小, 单位：kb

示例

uni.getStorageInfo({
    success:function(r){
        console.log('>>>>>>r',r)
    }
})

uni.getStorageInfoSync()

同步获取当前 storage 的相关信息。

示例

const res = uni.getStorageInfoSync();
console.log(res.keys);
console.log(res.currentSize);
console.log(res.limitSize);