每個微信小程序都有自己的本地快取空間,透過 wx.setStorage(及同步版 wx.setStorageSync)、wx.getStorage(wx.getStorageSync)、wx.clearStorage(wx.clearStorageSync)就能進行設定、讀取與清除。本地快取上限為 10MB。
注意:localStorage 是永久儲存的,但不建議把關鍵資訊全部塞進去,以免使用者換裝置後資料遺失或不同步。
把資料存入本地快取中指定的 key,會覆蓋該 key 原本的內容。這是非同步介面。
參數說明:
wx.setStorage({ key:"key", data:"value" })
同上,但為同步介面。
參數說明:
try { wx.setStorageSync('key', 'value') } catch (e) { }
從本地快取非同步取得指定 key 的內容。
參數說明:
wx.getStorage({ key: 'key', success: function(res) { console.log(res.data) } })
從本地快取同步取得指定 key 的內容。
參數說明:
try { var value = wx.getStorageSync('key') if (value) { // 使用回傳值 } } catch (e) { // 發生錯誤時的處理 }
非同步取得目前 storage 的相關資訊。
參數說明:
success 回傳參數說明:
wx.getStorageInfo({ success: function(res) { console.log(res.keys) // 所有 key console.log(res.currentSize) // 目前占用容量(KB) console.log(res.limitSize) // 容量上限(KB) } })
同步取得目前 storage 的相關資訊。
try { var res = wx.getStorageInfoSync() console.log(res.keys) console.log(res.currentSize) console.log(res.limitSize) } catch (e) { // 發生錯誤時的處理 }
從本地快取非同步移除指定 key。
參數說明:
wx.removeStorage({ key: 'key', success: function(res) { console.log(res.data) } })
從本地快取同步移除指定 key。
參數說明:
try { wx.removeStorageSync('key') } catch (e) { // 發生錯誤時的處理 }
前者非同步、後者同步,都是清空整個本地快取。
wx.clearStorage()
try { wx.clearStorageSync() } catch(e) { // 發生錯誤時的處理 }
選用建議:同步與非同步版本的差別在於是否阻塞。小程序啟動路徑(onLoad、onLaunch)上讀取少量設定用 Sync 版本沒問題,程式碼乾淨;但在列表捲動、動畫等對幀率敏感的路徑,應避免同步讀寫,改用非同步版本。
另外兩點:wx.clearStorage 會清掉所有 key,包含其他模組存的資料,範圍太大。實務上更常做的是逐一 wx.removeStorage 你想清的 key,或用命名前綴(例如 'user:token')來分組管理。
最後,本地快取是「裝置 + 小程序」層級的,使用者換手機或清除微信資料後就沒了。真正需要長期保存的資料請放在伺服器,本地只當快取用,並設計好 API 失敗時的降级行為。