最佳实践丨用云开发获取、传输微信开放数据

2021-05-10 15:43:19 浏览数 (1)

概述

微信开放了一系列的前端接口用于获取微信的开放数据,考虑到开发者服务端也需要获取这些开放数据,微信提供了两种获取方式:

  • 传统方案:开发者后台校验与解密开放数据
  • 云开发:云调用直接获取开放数据

本文将着重介绍云开发的方式。

方案对比:传统方案 vs 云开发

整体来看,使用云开发获取微信开放数据方便省事,效率高。

代码示例

获取开放数据的接口,如果涉及到敏感数据(如 wx.getWeRunData(),接口的明文内容将不包含这些敏感数据,而是在返回的接口中包含对应敏感数据的 cloudID 字段,数据可以通过云函数获取。完整流程如下:

第一步:获取 cloudID

使用 2.7.0 或以上版本的基础库,如果小程序已开通云开发,在开放数据接口的返回值中可以通过 cloudID 字段获取(与encryptedData同级),cloudID 有效期五分钟。

以获取用户微信运动步数为例:

详细文档:https://developers.weixin.qq.com/miniprogram/dev/api/open-api/werun/wx.getWeRunData.html

代码语言:javascript复制
wx.getWeRunData({
  success(res) {
    const cloudID = res.cloudID;
    // ...
  }
});

第二步:调用云函数

调用云函数时,对传入的 data 参数,如果有顶层字段的值为通过 wx.cloud.CloudID 构造的 cloudID,则调用云函数时,这些字段的值会被替换为 cloudID 对应的开放数据,一次调用最多可替换 5 个 cloudID。

示例:

在小程序获取到 cloudID 之后发起调用:

代码语言:javascript复制
wx.getWeRunData({
  success(res) {
    const id = res.cloudID;
    wx.cloud.callFunction({
      name: "myFunction",
      data: {
        weRunData: wx.cloud.CloudID(id), // 这个 CloudID 值到云函数端会被替换,
        obj: {
          shareInfo: wx.cloud.CloudID("yyy") // 非顶层 CloudID,不会被替换
        }
      }
    });
  }
});

在云函数收到的 event 示例:

代码语言:javascript复制
// event
{
  // weRunData 的值已被替换为开放数据
  "weRunData": {
    "cloudID": "xxx",
    "data": {
      "stepInfoList": [
        {
          "step": 5000,
          "timestamp": 1554814312
        }
      ],
      "watermark": {
        "appid": "wx1111111111",
        "timestamp": 1554815786
      }
    }
  },
  "obj": {
    // 非顶层字段维持原样
    "shareInfo": "yyy"
  }
}

如果 cloudID 非法或过期,则在 event 中获取得到的将是一个有包含错误码、错误信息和原始 cloudID 的对象。过期 cloudID 换取结果示例:

代码语言:javascript复制
// event
{
  "weRunData": {
    "cloudID": "xxx",
    "errCode": -601006,
    "errMsg": "cloudID expired."
  }
  // ...
}

相关文档:

服务端获取微信开放数据:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html

小程序开放接口文档:https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html

服务端获取开放数据:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html

产品介绍

云开发(Tencent CloudBase,TCB)是腾讯云提供的云原生一体化开发环境和工具平台,为开发者提供高可用、自动弹性扩缩的后端云服务,包含计算、存储、托管等serverless化能力,可用于云端一体化开发多种端应用(小程序,公众号,Web 应用,Flutter 客户端等),帮助开发者统一构建和管理后端服务和云资源,避免了应用开发过程中繁琐的服务器搭建及运维,开发者可以专注于业务逻辑的实现,开发门槛更低,效率更高。

开通云开发:https://console.cloud.tencent.com/tcb?tdl_anchor=techsite

产品文档:https://cloud.tencent.com/product/tcb?from=12763

技术文档:https://cloudbase.net?from=10004

技术交流群、最新资讯关注微信公众号【腾讯云云开发】

0 人点赞