网站接入微信sdk最新指南(微信分享)

829 阅读3分钟

前阵子网站移动端需要接入微信分享功能,也就是接入微信公众号的sdk。在没接入微信分享之前,我们分享的链接是这样的:

接入成功后分享出去的链接就可以自定义标题,描述,封面了。如下:

准备工作

需要有一个开通的微信公众号,订阅号即可。同时拥有微信分享的权限。下面只讲解前端部分。

接入微信sdk

微信公众号官方开发文档

npm上有大佬做好了封装库,支持CommonJS,weixin-js-sdk

import wx from 'weixin-js-sdk';
const wechatShare = async (opus) => {
  // getWechatSign: 将当前页面链接传递给后台获取最新ticket
  const { code, data } = await getWechatSign(window.location.href);
  if (code === 0) {
    // 微信分享配置
    wx.config({
      debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
      appId: 'xxx', // 必填,公众号的唯一标识
      timestamp: data.timestamp, // 必填,生成签名的时间戳
      nonceStr: data.nonceStr, // 必填,生成签名的随机串
      signature: data.signature, // 必填,签名
      jsApiList: ["onMenuShareTimeline", "onMenuShareAppMessage"] // 必填,需要使用的JS接口列表
    });
    wx.ready(() => {
      wx.onMenuShareTimeline({
        title: opus.name, // 分享标题
        link: `${window.location.href.split('&')[0]}`,// 分享链接,该链接域名或路径必须与当前页面对应的公众号JS安全域名一致
        imgUrl: opus.opusCover,// 分享图标
        success: function() {
          // 用户点击了分享后执行的回调函数
        }
      });
      wx.onMenuShareAppMessage({
        title: opus.name, // 分享标题
        desc: `${opus.description}`, // 分享描述
        link: `${window.location.href.split('&')[0]}`, // 分享链接,该链接域名或路径必须与当前页面对应的公众号JS安全域名一致
        imgUrl: opus.opusCover, // 分享图标
        type: "link", // 分享类型,music、video或link,不填默认为link
        dataUrl: "", // 如果type是music或video,则要提供数据链接,默认为空
        success: function() {
          // 用户点击了分享后执行的回调函数
        }
      })
    })
  }
}

遇到的问题分析

微信分享其实坑很多,公众号配置以及开发过程都容易出问题。invalid signature的错误总是让人摸不着头脑。

公众号配置:一定要记得去公众号后台配置JS安全域名和IP白名单!这点很重要,不然一直是无效签名然后你也查不出问题!

开发过程问题:

invalid signature签名错误。建议按如下顺序检查:

  • 确认签名算法正确,可用mp.weixin.qq.com/debug/cgi-b… 页面工具进行校验。

  • 确认config中nonceStr(js中驼峰标准大写S), timestamp与用以签名中的对应noncestr, timestamp一致。

  • 确认url是页面完整的url(请在当前页面alert(location.href.split('#')[0])确认),包括'http(s)://'部分,以及'?'后面的GET参数部分,但不包括'#'hash后面的部分。

  • 确认 config 中的 appid 与用来获取 jsapi_ticket 的 appid 一致。本人在此踩过坑,后台的appid和前端配置不一致。

  • 确保一定缓存access_token和jsapi_ticket。

  • 确保你获取用来签名的url是动态获取的,动态页面可参见实例代码中php的实现方式。如果是html的静态页面在前端通过ajax将url传到后台签名,前端需要用js获取当前页面除去'#'hash部分的链接(可用location.href.split('#')[0]获取, 不需要encodeURIComponent,微信官方文档写着需要,亲测不需要),因为页面一旦分享,微信客户端会在你的链接末尾加入其它参数,如果不是动态获取当前链接,将导致分享后的页面签名失败。