微信公众号H5调用wx.scanQRCode实现扫一扫功能

1,612 阅读10分钟

参考微信开发者平台JSSDK使用步骤

步骤一:绑定域名

先登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。

****备注:登录后可在“开发者中心”查看对应的接口权限。JS接口安全域名需使用https域名(例如:https://www.baidu.com/))

步骤二:引入微信sdk

两种方法:

1.在需要调用JS接口的页面引入如下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.6.0.js

如需进一步提升服务稳定性,当上述资源不可访问时,可改访问:http://res2.wx.qq.com/open/js/jweixin-1.6.0.js ****(支持https)。

备注:支持使用 AMD/CMD 标准模块加载方法加载

2.但是这里我使用的vue开发的H5页面 所以我使用的npm引入

npm install weixin-js-sdk

import wx from 'weixin-js-sdk' // 微信JS - Sdk

步骤三:通过config接口注入权限验证配置

所有需要使用JS-SDK的页面必须先注入配置信息,否则将无法调用(同一个url仅需调用一次,对于变化url的SPA的web app可在每次url变化时进行调用,目前Android微信客户端不支持pushState的H5新特性,所以使用pushState来实现web app的页面会导致签名失败,此问题会在Android6.2中修复)。

wx.config({
  debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
  appId: '', // 必填,公众号的唯一标识
  timestamp: , // 必填,生成签名的时间戳
  nonceStr: '', // 必填,生成签名的随机串
  signature: '',// 必填,签名
  jsApiList: [] // 必填,需要使用的JS接口列表
});

PS:自己封装了一个,名为 wxSdk.js 的文件,方便后续使用其他API(如下所示)

import { getWeXinApiSign } from '@/api/commonApi' // 引入已封装的请求接口  
import wx from 'weixin-js-sdk' // 微信JS - Sdk  
const WeixinJsSDK = {  
  init: function (param) {  
    // 外部引用初始化签名方法  
    if (!param) return  
    if (param.APIs) this.APIs = param.APIs  
    if (param.callback) this.callback = param.callback  
    WeixinJsSDK.sign()  
  },  
  sign: function () {  
    // 请求后端接口获取签名参数  
    let pageUrl = location.href.split('#')[0]  
    getWeXinApiSign({ url: pageUrl })  
      .then(({ data }) => {  
        if (data.code == 0) {  
          WeixinJsSDK.initAPIs(data.data)  
        }  
      })  
      .catch((err) => {  
        console.log(err)  
      })  
  },  
  initAPIs: function (param) {  
    // 获取签名参数成功,config验证权限  
    wx.config({  
      debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。  
      appId: param.appId, // 必填,公众号的唯一标识  
      timestamp: param.timestamp, // 必填,生成签名的时间戳  
      nonceStr: param.nonceStr, // 必填,生成签名的随机串  
      signature: param.signature, // 必填,签名  
      jsApiList: this.APIs, // 必填,需要使用的JS接口列表  
    })

  
  
    wx.ready(function () {  
      // config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。  
      wx.checkJsApi({  
        // 判断当前客户端版本是否支持指定JS接口  
        jsApiList: ['scanQRCode'], // 需要检测的JS接口列表,所有JS接口列表见附录2,  
        success: function () {  
          if (typeof WeixinJsSDK.callback == 'function') {  
            WeixinJsSDK.callback()  
          }  
          // 以键值对的形式返回,可用的api值true,不可用为false  
          // 如:{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}  
        },  
      })  
    })  
    wx.error(function () {  
      // config信息验证失败会执行error函数,如签名过期导致验证失败具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名。  
    })  
  },  
}  
export default WeixinJsSDK

**
**

config需要的参数来源(后端生成,前端只需调用后端写好的接口获取):

appId:参考下图

timestamp,nonceStr,signature(生成签名时产生的):

① 获取 Access token

access_token是公众号的全局唯一接口调用凭据,公众号调用各接口时都需使用access_token。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。access_token的有效期目前为2个小时,需定时刷新,重复获取将导致上次获取的access_token失效。

公众平台的API调用所需的access_token的使用及生成方式说明:

1、建议公众号开发者使用中控服务器统一获取和刷新access_token,其他业务逻辑服务器所使用的access_token均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致access_token覆盖而影响业务;

2、目前access_token的有效期通过返回的expires_in来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新access_token。在刷新过程中,中控服务器可对外继续输出的老access_token,此时公众平台后台会保证在5分钟内,新老access_token都可用,这保证了第三方业务的平滑过渡;

3、access_token的有效时间可能会在未来有调整,所以中控服务器不仅需要内部定时主动刷新,还需要提供被动刷新access_token的接口,这样便于业务服务器在API调用获知access_token已超时的情况下,可以触发access_token的刷新流程。

接口调用请求说明

https请求方式: GET api.weixin.qq.com/cgi-bin/tok…

参数说明

参数是否必须说明
grant_type获取access_token填写client_credential
appid第三方用户唯一凭证
secret第三方用户唯一凭证密钥,即appsecret

返回说明

正常情况下,微信会返回下述JSON数据包给公众号:

{"access_token":"ACCESS_TOKEN","expires_in":7200}

参数说明

参数说明
access_token获取到的凭证
expires_in凭证有效时间,单位:秒

错误时微信会返回错误码等信息,JSON数据包示例如下(该示例为AppID无效错误):

{"errcode":40013,"errmsg":"invalid appid"}

返回码说明

返回码说明
-1系统繁忙,此时请开发者稍候再试
0请求成功
40001AppSecret错误或者AppSecret不属于这个公众号,请开发者确认AppSecret的正确性
40002请确保grant_type字段值为client_credential
40164调用接口的IP地址不在白名单中,请在接口IP白名单中进行设置。
40243AppSecret已被冻结,请登录MP解冻后再次调用。
89503此IP调用需要管理员确认,请联系管理员
89501此IP正在等待管理员确认,请联系管理员
8950624小时内该IP被管理员拒绝调用两次,24小时内不可再使用该IP调用
895071小时内该IP被管理员拒绝调用一次,1小时内不可再使用该IP调用

② 获取jsapi_ticket****

生成签名之前必须先了解一下jsapi_ticket,jsapi_ticket是公众号用于调用微信JS接口的临时票据。正常情况下,jsapi_ticket的有效期为7200秒,通过access_token来获取。由于获取jsapi_ticket的api调用次数非常有限,频繁刷新jsapi_ticket会导致api调用受限,影响自身业务,开发者必须在自己的服务全局缓存jsapi_ticket 。

  1. 参考以下文档获取access_token(有效期7200秒,开发者必须在自己的服务全局缓存access_token):developers.weixin.qq.com/doc/offiacc…

  2. 用第一步拿到的access_token 采用http GET方式请求获得jsapi_ticket(有效期7200秒,开发者必须在自己的服务全局缓存jsapi_ticket):api.weixin.qq.com/cgi-bin/tic…

成功返回如下JSON:

{
  "errcode":0,
  "errmsg":"ok",
  "ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
  "expires_in":7200
}

获得jsapi_ticket之后,就可以生成JS-SDK权限验证的签名了。

③ 获取签名 - 签名算法

签名生成规则如下:参与签名的字段包括noncestr(随机字符串), 有效的jsapi_ticket, timestamp(时间戳), url(当前网页的URL,不包含#及其后面部分) 。对所有待签名参数按照字段名的ASCII 码从小到大排序(字典序)后,使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串string1。这里需要注意的是所有参数名均为小写字符。对string1作sha1加密,字段名和字段值都采用原始值,不进行URL 转义。

即signature=sha1(string1)。 示例:

noncestr=Wm3WZYTPz0wzccnW
jsapi_ticket=sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg
timestamp=1414587457
url=http://mp.weixin.qq.com?params=value

步骤1. 对所有待签名参数按照字段名的ASCII 码从小到大排序(字典序)后,使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串string1:

jsapi_ticket=sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg&noncestr=Wm3WZYTPz0wzccnW&timestamp=1414587457&url=http://mp.weixin.qq.com?params=value

步骤2. 对string1进行sha1签名,得到signature:

0f9de62fce790f9a083d5c99e95740ceb90c27ed

注意事项

  1. 签名用的noncestr和timestamp必须与wx.config中的nonceStr和timestamp相同。
  2. 签名用的url必须是调用JS接口页面的完整URL。
  3. 出于安全考虑,开发者必须在服务器端实现签名的逻辑

****签名算法见文末的附录1,所有JS接口列表见文末的附录2

步骤四:页面调起微信扫一扫接口


import wx from 'weixin-js-sdk' // 微信JS - Sdk  
import WXJsSDK from '@/utils/wxSdk'

  


created() {  
  WXJsSDK.init({  
    APIs: ['scanQRCode'],  
  })  
},

  


 onScan() {  
    const that = this  
    wx.scanQRCode({  
      needResult: 1, // 默认为0,扫描结果由微信处理,1则直接返回扫描结果,  
      scanType: ['qrCode', 'barCode'], // 可以指定扫二维码还是一维码,默认二者都有  
      success: function (res) {  
        // 当needResult 为 1 时,扫码返回的结果  
        let result = res.resultStr  
        if (result) {  
          //匹配是否有逗号  
          if (result.indexOf(',') == -1) {  
            that.listQuery.expressNumber = result  
          } else {  
            that.listQuery.expressNumber = result.split(',')[1]  
          }  
          console.log(result)  
        }  
      },  
      fail: function (res) {  
        console.log('扫描失败!' + res.errMsg)  
      },  
    })  
  },

查看调试信息可以使用 微信开发者工具,调用api成功后返回的参数如下:

接口调用说明

所有接口通过wx对象(也可使用jWeixin对象)来调用,参数是一个对象,除了每个接口本身需要传的参数之外,还有以下通用参数:

  1. success:接口调用成功时执行的回调函数。
  2. fail:接口调用失败时执行的回调函数。
  3. complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。
  4. cancel:用户点击取消时的回调函数,仅部分有用户取消操作的api才会用到。
  5. trigger: 监听Menu中的按钮点击时触发的方法,该方法仅支持Menu中的相关接口。

备注:不要尝试在trigger中使用ajax异步请求修改本次分享的内容,因为客户端分享操作是一个同步操作,这时候使用ajax的回包会还没有返回。

以上几个函数都带有一个参数,类型为对象,其中除了每个接口本身返回的数据之外,还有一个通用属性errMsg,其值格式如下:

调用成功时:"xxx:ok" ,其中xxx为调用的接口名

用户取消时:"xxx:cancel",其中xxx为调用的接口名

调用失败时:其值为具体错误信息