Storages
storages 模块提供了保存简单数据、用户配置等的支持。保存的数据除非应用被卸载或者被主动删除,否则会一直保留。
storages 支持number
, boolean
, string
等数据类型以及把Object
, Array
用JSON.stringify
序列化存取。
storages 保存的数据在脚本之间是共享的,任何脚本只要知道 storage 名称便可以获取到相应的数据,因此它不能用于敏感数据的储存。 storages 无法像 Web 开发中 LocalStorage 一样提供根据域名独立的存储,因为脚本的路径随时可能改变。
storages.create(name)
name
<String> 本地存储名称
创建一个本地存储并返回一个Storage
对象。不同名称的本地存储的数据是隔开的,而相同名称的本地存储的数据是共享的。
例如在一个脚本中,创建名称为 ABC 的存储并存入 a=123:
var storage = storages.create('ABC');
storage.put('a', 123);
而在另一个脚本中是可以获取到 ABC 以及 a 的值的:
var storage = storages.create('ABC');
log('a = ' + storage.get('a'));
因此,本地存储的名称比较重要,尽量使用含有域名、作者邮箱等唯一信息的名称来避免冲突,例如:
var storage = storages.create('12345678@qq.com:ABC');
storages.remove(name)
name
<String> 本地存储名称
删除一个本地存储以及他的全部数据。如果该存储不存在,返回 false;否则返回 true。
Storages
Storage.get(key[, defaultValue])
key
<String> 键值defaultValue
<any> 可选,默认值
从本地存储中取出键值为 key 的数据并返回。
如果该存储中不包含该数据,这时若指定了默认值参数则返回默认值,否则返回 undefined。
返回的数据可能是任意数据类型,这取决于使用Storage.put
保存该键值的数据时的数据类型。
Storage.put(key, value)
key
<String> 键值value
<any> 值
把值 value 保存到本地存储中。value 可以是 undefined 以外的任意数据类型。如果 value 为 undefined 则抛出 TypeError。
存储的过程实际上是使用 JSON.stringify 把 value 转换为字符串再保存,因此 value 必须是可 JSON 化的才能被接受。
Storage.remove(key)
key
<String> 键值
移除键值为 key 的数据。不返回任何值。
Storage.contains(key)
key
<String> 键值
返回该本地存储是否包含键值为 key 的数据。是则返回 true,否则返回 false。
Storage.clear()
移除该本地存储的所有数据。不返回任何值。