宜信同城网交流论坛技术专版技术专区Storage模块管理应用本地数据存储区，用于应用数据的保存和读取 ...Storage模块管理应用本地数据存储区，用于应用数据的保存和读取。应用本地数据与localStorage、sessionSt ...

admin 发表于 2023-2-16 18:54:47

Storage模块管理应用本地数据存储区，用于应用数据的保存和读取 ...

<div id="article_content" class="article_content clearfix">
 <link rel="stylesheet" href="https://csdnimg.cn/release/blogv2/dist/mdeditor/css/editerView/kdoc_html_views-1a98987dfd.css">
 <link rel="stylesheet" href="https://csdnimg.cn/release/blogv2/dist/mdeditor/css/editerView/ck_htmledit_views-6e43165c0a.css">
 <div id="content_views" class="htmledit_views">
 Storage模块管理应用本地数据存储区，用于应用数据的保存和读取。应用本地数据与localStorage、sessionStorage的区别在于数据有效域不同，前者可在应用内跨域操作，数据存储期是持久化的，并且没有容量限制。通过plus.storage可获取应用本地数据管理对象。
<h2 style="margin-left:.8em;">方法：</h2>
<ul><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.clear">clear</a>: 清除存储数据</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.clearAsync">clearAsync</a>: 异步清除存储数据</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.getAllKeys">getAllKeys</a>: 获取所有键名</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.getAllKeysAsync">getAllKeysAsync</a>: 异步获取所有键名</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.getLength">getLength</a>: 获取存储数据的个数</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.getItem">getItem</a>: 获取存储的键值</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.getItemAsync">getItemAsync</a>: 异步获取存储的键值</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.key">key</a>: 获取键值对中指定索引值的key值</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.setItem">setItem</a>: 存储键值</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.setItemAsync">setItemAsync</a>: 异步存储键值</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.removeItem">removeItem</a>: 删除键值</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.removeItemAsync">removeItemAsync</a>: 异步删除键值</li></ul>
<h2 style="margin-left:.8em;">回调方法：</h2>
<ul><li><ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageSuccessCallback">StorageSuccessCallback</a>: 本地数据存储操作成功的回调函数</li><li><ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageErrorCallback">StorageErrorCallback</a>: 本地数据存储操作失败的回调函数</li></ul>
<h2 style="margin-left:.8em;">权限：</h2>
5+功能模块（permissions）
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
{
// ...
"permissions":{
// ...
"Storage": {
"description": "本地存储，访问应用本地存储数据"
}
}
}
</code></code></pre>
<h1 style="margin-left:0;">clear</h1>
清除存储数据
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.clear();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
清除存储的所有键名及键值。
<h2 style="margin-left:.8em;">参数：</h2>
无
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 清除所有存储数据
function clearStorage() {
plus.storage.clear();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">clearAsync</h1>
异步清除存储数据
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.clearAsync(successCB, errorCB);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
异步清除存储的所有键名及键值。注意：HBuilderX2.6.6+版本支持。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>successCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageSuccessCallback">StorageSuccessCallback</a> ) 可选 清除操作成功回调 回调参数不包含属性。 </li><li>errorCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageErrorCallback">StorageErrorCallback</a> ) 可选 清除操作失败回调 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 异步清除存储数据
function clearAsync() {
plus.storage.clearAsync(function(){
console.log("clearAsync success");
}, function(e){
console.log("clearAsync failed: "+JSON.stringify(e));
});
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">getAllKeys</h1>
获取所有键名
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var keys = plus.storage.getAllKeys();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
获取存储的所有键名，如果没有存储数据则返回空数组。注意：HBuilderX2.6.6+版本支持。
<h2 style="margin-left:.8em;">参数：</h2>
无
<h2 style="margin-left:.8em;">返回值：</h2>
Array[String] : 所有键名字符串数组。
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 获取所有键名
function getAllKeys() {
var keys = plus.storage.getAllKeys();
console.log('keys length: "+keys.length);
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">getAllKeysAsync</h1>
异步获取所有键名
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.getAllKeysAsync(successCB, errorCB);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
异步获取存储的所有键名，如果没有存储数据则返回空数组。注意：HBuilderX2.6.6+版本支持。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>successCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageSuccessCallback">StorageSuccessCallback</a> ) 可选 获取成功回调 回调参数包含以下属性：
<ul style="margin-left:2em;"><li>keys - 获取到所有键名的数组</li></ul> </li><li>errorCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageErrorCallback">StorageErrorCallback</a> ) 可选 获取失败回调 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 异步获取所有键名
function getAllKeysAsync() {
plus.storage.getAllKeysAsync(function(e){
var keys = e.keys;
console.log('keys length: "+keys.length);
}, function(e){
console.log("clearAsync failed: "+JSON.stringify(e));
});
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">getLength</h1>
获取存储数据的个数
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var foo = plus.storage.getLength();
</code></code></pre>
<h2 style="margin-left:.8em;">参数：</h2>
无
<h2 style="margin-left:.8em;">返回值：</h2>
Number : 键值对的个数
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 获取存储数据的个数
function storageCount() {
return plus.storage.getLength();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">getItem</h1>
获取存储的键值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var foo = plus.storage.getItem(key);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
通过键名获取对应存储的键值。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>key: ( String ) 必选 键名 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
String : 键名对应的键值，如果不存在则返回null。
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 获取存储的键值
function getStorage() {
return plus.storage.getItem("test");
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">getItemAsync</h1>
异步获取存储的键值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.getItemAsync(key, successCB, errorCB);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
通过键名异步获取对应存储的键值，获取成功通过successCB回调返回键值，失败则通过errorCB返回错误。注意：HBuilderX2.6.6+版本支持。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>key: ( String ) 必选 键名 </li><li>successCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageSuccessCallback">StorageSuccessCallback</a> ) 可选 获取键值成功回调 回调参数包含以下属性：
<ul style="margin-left:2em;"><li>data - 获取到键名对应的键值</li></ul> </li><li>errorCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageErrorCallback">StorageErrorCallback</a> ) 可选 获取键值失败回调 如果获取的键名不存在，则会触发失败回调。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 异步获取存储的键值
function getStorageAsync() {
plus.storage.getItemAsync("test", function(e){
var data = e.data;
console.log("getItemAsync success: "+data);
}, function(e){
console.log("getItemAsync failed: "+JSON.stringify(e));
});
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">key</h1>
获取键值对中指定索引值的key值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var foo = plus.storage.key(index);
</code></code></pre>
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>index: ( Number ) 必选 存储键值的索引 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
String : 指定索引值的key值，如果不存在则返回null。
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 获取键值对中指定索引值的key值
function enumValueByIndex() {
var keyNames=[];
var values=[];
var numKeys=plus.storage.getLength();
for(var i=0; i<numKeys; i++) {
keyNames[i] = plus.storage.key(i);
values[i] = plus.storage.getItem(keyNames[i]);
}
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">setItem</h1>
存储键值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.setItem(key, value);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
如果设置的键在数据存储中已经存在，则更新存储的键值。存储的键和值没有容量限制，但过多的数据量会导致效率降低，建议单个键值数据不要超过10Kb。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>key: ( String ) 必选 存储的键名 </li><li>value: ( String ) 必选 存储的键值 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 修改或添加键值(key-value)对数据到应用数据存储中
function setStorage() {
plus.storage.setItem("test","test with hbuilder!");
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">setItemAsync</h1>
异步存储键值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.setItemAsync(key, value, successCB, errorCB);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
如果设置的键在数据存储中已经存在，则更新存储的键值。存储的键和值没有容量限制，但过多的数据量会导致效率降低， 异步存储不阻塞js运行，但也不应该传入过大数据，建议单个键值数据不要超过100Kb。注意：HBuilderX2.6.6+版本支持。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>key: ( String ) 必选 存储的键名 </li><li>value: ( String ) 必选 存储的键值 </li><li>successCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageSuccessCallback">StorageSuccessCallback</a> ) 可选 存储键值成功回调 回调参数不包含属性。 </li><li>errorCB: ( <ahref="https://www.html5plus.org/doc/zh_cn/storage.html#plus.storage.StorageErrorCallback">StorageErrorCallback</a> ) 可选 存储键值失败回调 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 异步存储键值
function setStorageAsync() {
plus.storage.setItemAsync("test", "test with HBuilderX", function(){
console.log("setItemAsync success");
}, function(e){
console.log("setItemAsync failed: "+JSON.stringify(e));
});
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">removeItem</h1>
删除键值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.removeItem(key);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
通过键名删除对应存储的键名及键值。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>key: ( String ) 必选 键名 要删除的键名。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 删除键值
function removeStorage() {
plus.storage.removeItem("test");
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">removeItemAsync</h1>
异步删除键值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void plus.storage.removeItemAsync(key, successCB, errorCB);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
通过键名异步删除对应存储的键名及键值。注意：HBuilderX2.6.6+版本支持。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>key: ( String ) 必选 删除的键名 </li><li>successCB: ( <ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.StorageSuccessCallback">StorageSuccessCallback</a> ) 可选 删除操作成功回调 回调参数不包含属性。 </li><li>errorCB: ( <ahref="https://blog.csdn.net/qq_40575646/article/details/122838563#plus.storage.StorageErrorCallback">StorageErrorCallback</a> ) 可选 删除操作失败回调 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 异步删除键值
function removeItemAsync() {
plus.storage.removeItemAsync("test", function(){
console.log("removeItemAsync success");
}, function(e){
console.log("removeItemAsync failed: "+JSON.stringify(e));
});
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">StorageSuccessCallback</h1>
本地数据存储操作成功的回调函数
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void onSuccess( event ) {
// get event data
}
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
不同接口触发的成功回调参数event包含的属性存在差异，具体参考对应的接口描述说明。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>event: ( Object ) 可选 回调参数 回调参数包含的属性由调用接口决定，具体参考对应的接口描述说明。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h1 style="margin-left:0;">StorageErrorCallback</h1>
本地数据存储操作失败的回调函数
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
function void onError(Exception error) {
// Handle error
var code = error.code; // 错误编码
var message = error.message; // 错误描述信息
}
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
包括以下错误：
<ul><li>-1 - 内部错误</li><li>-2 - 存储已超上限无法正常存储</li><li>-3 - 没有找到相同key的存储记录</li></ul>

<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>error: ( Exception ) 必选 错误回调信息 可通过error.code（Number类型）获取错误编码； 可通过error.message（String类型）获取错误描述信息。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
 </div>
 </div>
 <div id="treeSkill"></div>

页: [1]

宜信同城网交流论坛's Archiver

Storage模块管理应用本地数据存储区，用于应用数据的保存和读取 ...