微信小程序API 数据缓存

每个微信小程序都可以有自己的本地缓存，可以通过wx.setstorage（wx.setstoragesync）、wx.getstorage（wx.getstoragesync）、wx.clearstorage（wx.clearstoragesync）可以对本地缓存进行设置、获取和清理。同一个微信用户，同一个小程序 storage 上限为 10mb。localstorage 以用户维度隔离，同一台设备上，a 用户无法读取到 b 用户的数据。

注意： localstorage是永久存储的，但是我们不建议将关键信息全部存在localstorage，以防用户换设备的情况。

wx.setstorage(object)

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

object参数说明：

参数	类型	必填	说明
key	string	是	本地缓存中的指定的 key
data	object/string	是	需要存储的内容
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.setstorage({
  key:"key"
  data:"value"
})

wx.setstoragesync(key,data)

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

参数说明：

参数	类型	必填	说明
key	string	是	本地缓存中的指定的key
data	object/string	是	需要存储的内容

示例代码

try {
   wx.setstoragesync("key","value")
} catch (e) {
}

wx.getstorage(object)

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

object参数说明：

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

success返回参数说明：

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

示例代码：

wx.getstorage({
  key:'key',
  success: function(res){
      console.log(res.data)
  } 
})

wx.getstoragesync(key)

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

参数说明：

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

示例代码：

try {
  var value = wx.getstoragesync('key')
  if (value) {
      // do something with return value
  }
} catch (e) {
  // do something when catch error
}

wx.getstorageinfo(object)

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

object参数说明：

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

success返回参数说明：

参数	类型	说明
keys	string array	当前storage中所有的key
currentsize	number	当前占用的空间大小, 单位kb
limitsize	number	限制的空间大小，单位kb

示例代码：

wx.getstorageinfo({
  success: function(res) {
    console.log(res.keys)
    console.log(res.currentsize)
    console.log(res.limitsize)
  }
})

wx.getstorageinfosync

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

示例代码：

try {
  var res = wx.getstorageinfosync()
  console.log(res.keys)
  console.log(res.currentsize)
  console.log(res.limitsize)
} catch (e) {
  // do something when catch error
}

wx.removestorage(object)

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

object参数说明：

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

示例代码：

wx.removestorage({
  key: 'key',
  success: function(res) {
    console.log(res.data)
  } 
})

wx.removestoragesync(key)

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

参数说明：

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

示例代码：

try {
  wx.removestoragesync('key')
} catch (e) {
  // do something when catch error
}

wx.clearstorage()

清理本地数据缓存。

示例代码：

wx.clearstorage()

wx.clearstoragesync()

同步清理本地数据缓存

示例代码：

try {
    wx.clearstoragesync()
} catch(e) {
  // do something when catch error
}

bug & tip

tip: 本地数据存储的大小限制为 10mb