支付寶小程序API 緩存

緩存 API 概覽

開啟本地緩存數(shù)據(jù)，進(jìn)行存儲(chǔ)、獲取和刪除等控制。

單個(gè)小程序的緩存總上限為 10MB。

同步方法會(huì)阻塞當(dāng)前任務(wù)，直到同步方法處理返回。異步方法不會(huì)阻塞當(dāng)前任務(wù)。

操作	同步	異步	描述
存儲(chǔ)	my.setStorageSync	my.setStorage	數(shù)據(jù)存儲(chǔ)在本地緩存中指定的 key 中的接口，會(huì)覆蓋掉原來該 key 對(duì)應(yīng)的數(shù)據(jù)。
讀取	my.getStorageSync	my.getStorage	獲取緩存數(shù)據(jù)的接口。
清除	my.clearStorageSync	my.clearStorage	清除本地?cái)?shù)據(jù)緩存的接口。
刪除	my.removeStorageSync	my.removeStorage	刪除緩存數(shù)據(jù)的接口。
獲取相關(guān)信息	my.getStorageInfoSync	my.getStorageInfo	獲取當(dāng)前 storage 的相關(guān)信息的接口。

my.clearStorage

簡介

my.clearStorage 是清除本地?cái)?shù)據(jù)緩存的異步接口。

清空內(nèi)嵌 webview 的存儲(chǔ)時(shí)不會(huì)同時(shí)清空當(dāng)前小程序本身的存儲(chǔ)數(shù)據(jù)。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
my.clearStorage();

my.clearStorageSync

簡介

my.clearStorageSync 是清除本地?cái)?shù)據(jù)緩存的同步接口。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
my.clearStorageSync()

my.getStorage

簡介

my.getStorage 是獲取緩存數(shù)據(jù)的異步接口。

支持內(nèi)嵌 webview 內(nèi)緩與小程序緩存隔離，獲取內(nèi)嵌 webview 指定 key 的緩存不會(huì)同時(shí)返回小程序相同 key下的緩存數(shù)據(jù)。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶(不是先刪除再安裝)，不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

//.js
my.getStorage({
  key: 'currentCity',
  success: function(res) {
    my.alert({content: '獲取成功：' + res.data.cityName});
  },
  fail: function(res){
    my.alert({content: res.errorMessage});
  }
});

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
key	String	是	緩存數(shù)據(jù)的 key。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

success 回調(diào)函數(shù)

屬性	類型	描述
data	Object/String	key 對(duì)應(yīng)的內(nèi)容。

my.getStorageInfo

簡介

my.getStorageInfo 是獲取當(dāng)前 storage 的相關(guān)信息的異步接口。

在內(nèi)嵌 webview 內(nèi)獲取當(dāng)前 storage 的相關(guān)信息，但不會(huì)獲取到當(dāng)前小程序 storage 的相關(guān)信息。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
my.getStorageInfo({
  success: function(res) {
    console.log(res.keys)
    console.log(res.currentSize)
    console.log(res.limitSize)
  }
})

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

success 回調(diào)函數(shù)

屬性	類型	描述
keys	String Array	當(dāng)前 storage 中所有的 key。
currentSize	Number	當(dāng)前占用的空間大小, 單位為 KB。
limitSize	Number	限制的空間大小，單位為 KB。

my.getStorageInfoSync

簡介

my.getStorageInfoSync 是獲取當(dāng)前 storage 相關(guān)信息的同步接口。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
var res = my.getStorageInfoSync()
console.log(res.keys)
console.log(res.currentSize)
console.log(res.limitSize)

返回值

屬性	類型	描述
keys	String/Array	當(dāng)前 storage 中所有的 key。
currentSize	Number	當(dāng)前占用的空間大小, 單位為 KB。
limitSize	Number	限制的空間大小，單位為 KB。

my.getStorageSync

簡介

my.getStorageSync 是獲取緩存數(shù)據(jù)的同步接口。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
let res = my.getStorageSync({ key: 'currentCity' });
 my.alert({
    content: JSON.stringify(res.data),
 });

入?yún)?/h4>

String 類型，屬性如下：

屬性	類型	必填	描述
key	String	是	緩存數(shù)據(jù)的 key

返回值

屬性	類型	描述
data	Object/String	key 對(duì)應(yīng)的內(nèi)容

my.removeStorage

簡介

my.removeStorage 是刪除緩存數(shù)據(jù)的異步接口。

移除內(nèi)嵌 webview 的存儲(chǔ)數(shù)據(jù)時(shí)不會(huì)移除當(dāng)前小程序的存儲(chǔ)數(shù)據(jù)。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
my.removeStorage({
  key: 'currentCity',
  success: function(){
    my.alert({content: '刪除成功'});
  }
});

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
key	String	是	緩存數(shù)據(jù)的 key。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

my.removeStorageSync

簡介

my.removeStorageSync 是刪除緩存數(shù)據(jù)的同步接口。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效。
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
my.removeStorageSync({
  key: 'currentCity',
});

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
key	String	是	緩存數(shù)據(jù)的 key。

my.setStorage

簡介

my.setStorage 是將數(shù)據(jù)存儲(chǔ)在本地緩存中指定的 key 中的異步接口，會(huì)覆蓋掉原來該 key 對(duì)應(yīng)的數(shù)據(jù)。

支持內(nèi)嵌 webview 的存儲(chǔ)與小程序存儲(chǔ)隔離，內(nèi)嵌 webview 中指定 key 存儲(chǔ)數(shù)據(jù)不會(huì)覆蓋小程序自身相同 key 對(duì)應(yīng)的數(shù)據(jù)。

使用限制

• 單個(gè) key 允許存儲(chǔ)的最大數(shù)據(jù)大小為 200KB，所有數(shù)據(jù)存儲(chǔ)上限為 10MB。
• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回。
• 覆蓋安裝支付寶（不是先刪除再安裝）、支付寶設(shè)置中心清除緩存、關(guān)閉小程序，這三種操作均不會(huì)導(dǎo)致小程序緩存失效。
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離。
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
my.setStorage({
  key: 'currentCity',
  data: {
    cityName: '杭州',
    adCode: '330100',
    spell: ' hangzhou',
  },
  success: function() {
    my.alert({content: '寫入成功'});
  }
});

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
key	String	是	緩存數(shù)據(jù)的 key。
data	Object/String	是	要緩存的數(shù)據(jù)。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

my.setStorageSync

簡介

my.setStorageSync 是將數(shù)據(jù)存儲(chǔ)在本地緩存中指定的 key 中的同步接口。

使用限制

• 緩存數(shù)據(jù)本地加密存儲(chǔ)，通過 API 讀取時(shí)會(huì)自動(dòng)解密返回；
• 覆蓋安裝支付寶（不是先刪除再安裝），不會(huì)導(dǎo)致小程序緩存失效；
• 支付寶設(shè)置中心清除緩存不會(huì)導(dǎo)致小程序緩存失效；
• 小程序緩存默認(rèn)具有支付寶賬號(hào)和小程序 ID 兩級(jí)隔離；
• iOS 客戶端支持 iTunes 備份。

掃碼體驗(yàn)

示例代碼

// .js
my.setStorageSync({
  key: 'currentCity',
  data: {
    cityName: '杭州',
    adCode: '330100',
    spell: ' hangzhou',
  }
});

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
key	String	是	緩存數(shù)據(jù)的 key。
data	Object/String	是	要緩存的數(shù)據(jù)。