Weex内置模块——storage模块

Posted 2021-04-29 让知识成为资产

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Weex内置模块——storage模块相关的知识，希望对你有一定的参考价值。

weex内置了一些功能模块，可以通过require(‘@weex-module/xxx’);

或weex.requireModule(‘xxx’); 调用模块，从而使用模块中封装好的API。

storage模块

storage是一个在前端比较常用的模块，可以对本地数据进行存储、修改、删除，并且该数据是永久保存的，除非手动清除或者代码清除。
但是，storage模块有一个限制就是浏览器端(H5)只能存储小于5M的数据，因为在浏览器端的实现是采用html5 LocalStorage API。而android 和 ios 这块是没什么限制的。
Storage常用在一些被用户经常查询，但是又不频繁更新的数据，比如登录记住用户名密码、搜索历史、用户的订单列表等。
搜索历史一般情况都是作为本地数据存储的，因此使用storage比较合适。而用户订单列表是需要本地存储和服务器端检索配合的场景。
当一个用户下单后，会经常查阅个人的订单列表。但是，订单的列表数据不是频繁更新的，往往只有在收到货品时，才更新“已签收”，其余平时的状态是“已发货”。因此，可以使用storage存储订单列表，可以减少服务器的压力，例如减少SQL查询或者缓存的压力。当用户查看订单详情的时候，再更新数据状态。

storage 提供了一系列的 API供我们调用。我们只需要引入该模块，然后调用对应的 API 即可。

setItem(key, value, callback)

该方法可以通过键值对的形式将数据存储到本地。同时可以通过该方法，更新已有的数据。

参数
key {string}：要存储的键，不允许是””或null
value {string}：要存储的值，不允许是””或null
callback {function(e)}：执行操作成功后的回调

e.result：表示设置是否成功，如果成功返回”success”
e.data：undefined表示设置成功，invalid_param表示key/value为””或者null

可以通过e对象两个属性(e.result和e.data)的返回值判断数据是否插入成功。

getItem(key, callback)

传入键名返回对应的键值

参数
key {string}：要获取的值的名称，不允许是””或null
callback {function(e)}：执行操作成功后的回调

e.result：表示设置是否成功，如果成功返回”success”
e.data：获取对应的键值字符串，如果没有找到则返回undefined

removeItem(key, callback)

传入一个键名将会删除本地存储中对应的键值

参数
key {string}：要删除的值的名称，不允许是””或null
callback {function(e)}：执行操作成功后的回调

e.result：表示删除是否成功，如果成功返回”success”
e.data：undefined表示删除成功

length(callback)

返回本地存储的数据中所有存储项数量的整数

参数
key {string}：要获取的值的名称，不允许是””或null
callback {function(e)}：执行操作成功后的回调

e.result：表示设置是否成功，如果成功返回”success”
e.data：当前已存储项的数量

getAllKeys(callback)

返回一个包含全部已存储项键名的数组

参数
callback {function(e)}：执行操作成功后的回调

e.result：表示设置是否成功，如果成功返回”success”
e.data：所有键名组成的数组