数据存储

接口声明

在manifest.json文件的 features属性中增加如下配置。

{"name": "system.storage"}

导入模块

在调用接口页面的<script>部分增加如下配置。

import storage from '@system.storage'

或

var storage = require("@system.storage")

使用限制

接口定义

[h2]storage.get(OBJECT)

描述

读取应用数据库存储的内容。

OBJECT参数说明

示例代码

storage.get({
  key: 'A1',
  success:function(data){console.log("handling success");},
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]storage.set(OBJECT)

描述

修改应用数据库存储的内容。

OBJECT参数

示例代码

storage.set({
  key: 'A1',
  value: 'V1',
  success:function(data){console.log("handling success");},
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]storage.clear(OBJECT)

描述

清空应用数据库存储的内容。

OBJECT参数

示例代码

storage.clear({
  success:function(data){console.log("handling success");},
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]storage.delete(OBJECT)

描述

删除应用数据库存储的内容。

OBJECT参数

示例代码

storage.delete({
  key: 'A1',
  success:function(data){console.log("handling success");},
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]storage.key(OBJECT)（1050+）

描述

返回存储中某个index的键名。

OBJECT参数

示例代码

storage.key({
    index: parseIndex,
    success: function (ret) {
        console.info('storage.key(): ', JSON.stringify(ret))
        prompt.showToast({message: 'key: ' + ret,})
    },
    fail: function (erromsg, errocode) {
        prompt.showToast({ message: 'get fail --- ' + errocode + ':' + erromsg });
        console.info('get fail --- ' + errocode + ':' + erromsg)
    },
    complete: function () {
        console.info('get complete  ')
    }
})

属性(1050+)

Demo

<template>
  <div class="container">
    <div class="item-container">
      <div class="item-content">
        <div class="item-content-detail">
          <text class="txt">key:</text>
          <input class="input" placeholder="Please input key"  value="{{storageKey}}" onchange="keyFn" />
        </div>

        <div class="item-content-detail">
          <text class="txt">value:</text>
          <input class="input" placeholder="Please input value"
            value="{{storageValue}}" onchange="valueFn" />
        </div>
        <div class="item-content-detail">
          <text class="txt">index:</text>
          <input class="input" placeholder="Please input index" value="{{index}}" onchange="indexFn" />
        </div>
      </div>
      <input type="button" class="btn" onclick="setStorage" value="Set storage" />
      <input type="button" class="btn" onclick="getStorage"  value="Get storage" />
      <input type="button" class="btn" onclick="getKey" value="Get keyname an index" />
      <input type="button" class="btn" onclick="getLength" value="Get length in the storage" />
      <input type="button" class="btn" onclick="clearStorage" value="Clear storage" />
      <input type="button" class="btn" onclick="deleteStorage"  value="Delete storage" />
    </div>
  </div>
</template>

<style>
  .container{
    flex: 1;
    flex-direction: column;
  }
  .item-container {
    margin-bottom: 50px;
    margin-right: 60px;
    margin-left: 60px;
    flex-direction: column;
  }

  .item-content {
    flex-direction: column;
    background-color: #ffffff;
    padding-left: 30px;
    padding-right: 30px;
    padding-top: 15px;
    padding-bottom: 15px;
    margin-bottom: 100px;
  }

  .item-content-detail {
    align-items: center;
  }

  .input {
    flex: 1;
    font-size: 30px;
    padding-left: 20px;
  }

  .txt {
    width: 100px;
    padding-top: 15px;
    padding-bottom: 15px;
    text-align: right;
  }
  .btn {
  height: 80px;
  text-align: center;
  border-radius: 5px;
  margin-right: 60px;
  margin-left: 60px;
  margin-bottom: 50px;
  color: #ffffff;
  font-size: 30px;
  background-color: #0faeff;
}
</style>

<script>
  import storage from '@system.storage'
  import prompt from '@system.prompt'

  export default {
    data: {
      componentName: 'storage',
      componentData: {},
      storageKey: '',
      storageValue: '',
      storageShow: '',
      inputKey: '',
      inputValue: '',
      index: 0,
    },
    onInit: function () {
      this.$page.setTitleBar({ text: 'storage' })
    },
    keyFn: function (e) {
      this.storageKey = e.text
    },
    valueFn: function (e) {
      this.storageValue = e.text
    },
    indexFn: function (e) {
      this.index = e.text
    },
    setStorage: function () {
      var that = this
      if (this.storageKey && this.storageValue) {
        storage.set({
          key: this.storageKey,
          value: this.storageValue,
          success: function (ret) {
            prompt.showToast({
              message: '{key:' + that.storageKey + ',value:' + that.storageValue + '}',
            })
          },
          fail: function (erromsg, errocode) {
            prompt.showToast({ message: 'set fail --- ' + errocode + ':' + erromsg })
            console.info('set fail --- ' + errocode + ':' + erromsg)
          },
          complete: function () {
           // prompt.showToast({ message: 'set complete' })
            console.info('set complete  ')
          }
        })
      } else {
        prompt.showToast({
          message: "Please input key and value"
        })
      }
    },
    getStorage: function () {
      var that = this
      storage.get({
        key: this.storageKey,
        default: 'default value',
        success: function (ret) {
          console.info('storage.get(): ', JSON.stringify(ret))
          that.storageShow = ret
          prompt.showToast({
            message: 'value: ' + ret,
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'get fail --- ' + errocode + ':' + erromsg })
          console.info('get fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          console.info('get complete  ')
        }
      })
    },
    getKey: function () {
      var that = this
      const parseIndex = that.index

      storage.key({
        index: parseIndex,
        success: function (ret) {
          console.info('storage.key(): ', JSON.stringify(ret))
          prompt.showToast({ message: 'key: ' + ret, })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'get fail --- ' + errocode + ':' + erromsg })
          console.info('get fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          console.info('get complete  ')
        }
      })
    },
    getLength: function () {
      const length = storage.length
      console.log('storage.length = ' + length)
      prompt.showToast({ message: 'storage.length : ' + length })
    },
    deleteStorage: function () {
      var that = this
      storage.delete({
        key: this.storageKey,
        success: function () {
          that.storageKey = '' // Delete the value in the variable
          that.storageValue = ''// Delete the value in the variable
          that.inputKey = ''// Delete the value displayed by input
          that.inputValue = '' // Delete the value displayed by input
          prompt.showToast({
            message: 'success',
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'get fail --- ' + errocode + ':' + erromsg })
          console.info('get fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          console.info('get complete  ')
        }
      })
    },
    clearStorage: function () {
      var that = this
      storage.clear({
        success: function () {
          that.storageKey = '' // Delete the value in the variable
          that.storageValue = ''// Delete the value in the variable
          that.inputKey = ''// Delete the value displayed by input
          that.inputValue = '' // Delete the value displayed by input
          prompt.showToast({
            message: 'success',
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'clear fail --- ' + errocode + ':' + erromsg })
          console.info('clear fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          prompt.showToast({ message: 'clear complete' })
          console.info('clear complete  ')
        }
      })
    }
  }
</script>

效果图如下：

版本更新说明

相关链接

[h2]FAQ

• 数据存储storage接口与文件存储file接口的存储机制一样吗？
• 同一个快应用，运行本地rpk包和运行应用市场上的快应用使用数据存储接口存储的数据是否不一样？
• 调用storage.delete接口，返回“code: 200 : the key is invalid”“performGetItem: this key is invalid, can not find this key in storage”，如何处理？
• storage接口有同步的执行方法吗？
• 快应用可以使用MySQL之类的数据库吗？