【微信小程序】開發實戰 之 「數據緩存API」解析


每個小程序都可以有自己的本地緩存,可以通過 數據緩存的API 實現對本地緩存進行 設置、獲取和清理。本地緩存最大為10M。localStorage是永久存儲的,但我們不建議將關鍵信息都放在localStorage,以防用戶更換設備。

設置本地緩存

1、wx.setStorage(OBJECT)

該接口是異步接口,用於將數據存儲在本地緩存中指定的key中。會覆蓋掉該key對應的原來的內容。

該接口參數:

參數key,     string類型,         必填項,本地緩存中指定的key。

參數data,   object/string類型,必填項,需要存儲的內容。

參數success,fail,complete,均為Function類型,分別對應接口調用成功、失敗和結束時的回調函數。

示例代碼如下:

wx.setStorage({
    key:"key",
    data:"value"
})

2、wx.setStorageSync(KEY,DATA)

該接口是同步接口,用於將data存儲在本地緩存中指定的key中。會覆蓋掉該key對應的原來的內容。

該接口參數:

參數key,     string類型,         必填項,本地緩存中指定的key。

參數data,   object/string類型,必填項,需要存儲的內容。

示例代碼如下:

try{
    wx.setStorageSync('key', 'value')
}catch(e) {
}

獲取/刪除 本地緩存

1、wx.getStorage (OBJECT) 和 wx.removeStroage (OBJECT)

wx.getStorage (OBJECT) 用於從本地緩存中異步獲取指定key對應的內容。

wx.removeStroage (OBJECT) 用於從本地緩存中異步刪除指定key對應的內容。

該接口參數:

參數key,          string類型,          必填項,本地緩存中指定的key。

參數success,   Function類型,      必填項,接口調用成功時的回調函數,res = {data: key 對應的內容}

參數fail,        Function類型,      非必填,接口調用失敗時的回調函數

參數complete,  Function類型,      非必填,接口調用結束時的回調函數(調用成功或失敗都會執行)

示例代碼如下:

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


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

2、wx.getStorageSync (KEY) 和 wx.removeStroageSync (KEY)

wx.getStorage (KEY) 用於從本地緩存中同步獲取指定key對應的內容。

wx.removeStroage (KEY) 用於從本地緩存中同步刪除指定key對應的內容。

參數為key,必填項,是本地緩存中的指定的key。

var value = wx.getStorage('key')
if (value) {
    //Do something with return value 
}

try {
    wx.removeStorageSync('key')
} catch(e) {
    //Do something when catch error 
}

獲取當前storage的相關信息

1、wx.getStorageInfo (OBJECT)

該接口用於異步獲取當前storage的相關信息。

該接口參數:

參數success(必填)、fail、complete,分別對應接口調用成功、失敗和結束時的回調函數。其中success是必填項。

success返回參數說明如下:

keys,Sting 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)
    }
})

2、wx.getStorageInfoSync()

該接口用於同步獲取當前storage相關信息。

示例代碼如下

try {
    var res = wx.getStorageInfo() 
    console.log( res.keys )
    console.log( res.currentSize )
    console.log( res.limitSize )
} catch (e) { 
    // Do something when catch error
}

清理數據緩存

1、wx.clearStorage()

該接口用於清理本地數據緩存。

2、wx.clearStorageSync()

該接口則用於同步清理本地數據緩存。

示例代碼如下:

wx.clearStorage()

try {
    wx.clearStorageSync() 
} catch(e) {
}

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM