WARNING

💡 模块名:GameHelper.LocalStorage

描述

本地缓存依赖渠道自身相关的数据保存接口，有硬性的容量，或者条目数量上限，例如一万条，10M 以内，单条不能超过 1M 等等。

这里对全渠道的本地缓存接口做了二次包装，方便调用。

WARNING

💡 注意:

• 缓存的值，如果玩家清除了缓存，或者删除了游戏就会丢失。请勿在本地缓存存储需持久化的信息，避免信息丢失。
• 组件会优先使用渠道支持的缓存接口，如不支持则会调用默认的localStorage进行缓存操作。

保留字段

注意，部分 SDK 模块使用到了本地缓存的功能，占用了一些字段，故游戏内注意不要使用如下的保留字段：

保留字	使用模块
sh	审核模块
recordEnterTime	审核模块
isAreaLimit	审核模块
startDays	审核模块
CCLoginOpenId	登录模块
CacheTouristId	登录模块
firstDate	公共全局变量
lastDate	公共全局变量
startDays	公共全局变量
firstVer	公共全局变量
currentVer	公共全局变量
bootCount	公共全局变量
abTest	AB 系统
localAdsCfgCache	广告配置
sceneCache	广告配置

方法

获取缓存 key 对应的数据。

参数

参数	类型	默认值	是否必填	说明
key	string	/	是	缓存的 key

返回值

类型	说明
string	缓存的值

示例

//假设还未保存任何数据
let cache = GameHelper.LocalStorage.getStorage("cache1");
console.log(cache); // ''

//执行保存方法保存数据
GameHelper.LocalStorage.setStorage("cache1", "hello localStorage");
//再次获取数据
cache = GameHelper.LocalStorage.getStorage("cache1");
console.log(cache); // hello localStorage

---

以键值对的形式缓存数据。

参数

参数	类型	默认值	是否必填	说明
key	string	/	是	缓存的 key
value	string	/	是	缓存的数据

返回值

无

示例

GameHelper.LocalStorage.setStorage("cache1", "hello localStorage");

---

删除指定 key 的缓存数据

参数

参数	类型	默认值	是否必填	说明
key	string	/	是	缓存的 key

返回值

无

示例

//假设已经保存字段cache1的数据为hello localStorage
console.log(GameHelper.LocalStorage.getStorage("cache1")); // hello localStorage

//删除保存字段为cache1的数据
GameHelper.LocalStorage.removeStorage("cache1");
//再次获取数据则获取空字符串
console.log(GameHelper.LocalStorage.getStorage("cache1")); // ""