设置 AP 数据

setAPDataStorage 接口用于保存一个字符串到客户端统一存储，字符串长度不得超过 200×1024。

说明：
  • 底层存储服务组件在 iOS 和 Android 中实现不一致。Android 统一存储组件不支持 type=user 属性，为了与前端接口一致，当设置 type=user 时，Android 底层会设置为 key=key + “_” +MD5(userId + userId + userId) 并进行存储。业务用客户端取的时候也要对 key 做相应处理。
  • 在 10.1.60 及以下版本的基线中，客户端需要做适配工作才能使接口能够获得 userId，否则存储接口将无法按 userId 区分存储，参见下方 实现 H5LoginProvider 接口。
  • 在 10.1.68 及以上版本的基线中，userId 默认使用 MPLogger.setUserId 中的值，若实现 H5LoginProvider，则取用 H5LoginProvider。

实现 H5LoginProvider 接口

Android

实现 H5LoginProvider 接口，并将实例类设置到 H5ProviderManager 中。

代码示例

  1. package com.mpaas.nebula.provider;
  3. import android.os.Bundle;
  5. import com.alipay.mobile.common.logging.api.LoggerFactory;
  6. import com.alipay.mobile.nebula.provider.H5LoginProvider;
  8. public class H5LoginProviderImpl implements H5LoginProvider {
  9.     // 其他代码省略
  11.     @Override
  12.     public String getUserId() {
  13.         // 此方法返回 userId 即可
  14.         return LoggerFactory.getLogContext().getUserId();
  15.     }
  17.     // 其他代码省略
  18. }

设置 H5LoginProvider

  1. H5Utils.setProvider(H5LoginProvider.class.getName(), new H5LoginProviderImpl());

setAPDataStorage 接口的使用方法

  1. AlipayJSBridge.call('setAPDataStorage', {
  2.   type: "common",
  3.   business: "customBusinessKey",
  4.   key: "customKey",
  5.   value: "customValue"
  6. }, function(result) {
  7.   alert(JSON.stringify(result));
  8. });

代码示例

  1. <button id="J_saveDataBtn" class="btn">保存数据</button>
  2. <button id="J_getDataBtn" class="btn">查看数据</button>
  3. <button id="J_removeDataBtn" class="btn">删除数据</button>
  5. <script>
  6. function ready(callback) {
  7.   // 如果 jsbridge 已经注入则直接调用
  8.   if (window.AlipayJSBridge) {
  9.     callback && callback();
  10.   } else {
  11.     // 如果没有注入则监听注入的事件
  12.     document.addEventListener('AlipayJSBridgeReady', callback, false);
  13.   }
  14. }
  15. ready(function() {
  16.   document.querySelector('#J_saveDataBtn').addEventListener('click', function(e) {
  17.     AlipayJSBridge.call('setAPDataStorage', {
  18.       type: "common",
  19.       business: "customBusinessKey",
  20.       key: "customKey",
  21.       value: "customValue"
  22.     }, function(result) {
  23.       alert(JSON.stringify(result));
  24.     });
  25.   }, false);
  27.   document.querySelector('#J_getDataBtn').addEventListener('click', function(e) {
  28.     AlipayJSBridge.call('getAPDataStorage', {
  29.       type: "common",
  30.       business: "customBusinessKey",
  31.       key: "customKey"
  32.     }, function(result) {
  33.       alert(JSON.stringify(result));
  34.     });
  35.   }, false);
  37.   document.querySelector('#J_removeDataBtn').addEventListener('click', function(e) {
  38.     AlipayJSBridge.call('removeAPDataStorage', {
  39.       type: "common",
  40.       business: "customBusinessKey",
  41.       key: "customKey"
  42.     }, function(result) {
  43.       alert(JSON.stringify(result));
  44.     });
  45.   }, false);
  46. }, false);
  47. </script>

API

  1. AlipayJSBridge.call('setAPDataStorage', {
  2.   type, business, key, value
  3. });

入参

名称 类型 描述 必选 默认值
type String (user/common) 用户维度存储还是公共存储 N “common”
business String 自定义的业务标识，可与相应的客户端存取代码约定，默认值为：NebulaBiz。
（在 Android 中，该业务标识与创建 APSharedPreferences 时所传入的 GROUP_ID 对应）		 N “”
key String 自定义数据的 key Y “”
value String 需要存储的值，仅支持字符串类型。JSON 数据需要先字符串化 Y “”

出参

回调函数带入的参数 result: {success}。

名称 类型 描述
success bool 是否保存成功

错误码描述

错误码 描述
11 字符串长度超限