在微信里调用扫码功能,文档很简单,但是发现了一些坑
先给一些资料
微信文档:https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html
签名验证:https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=jsapisign
JS-SDK使用权限签名算法
jsapi_ticket
生成签名之前必须先了解一下jsapi_ticket,jsapi_ticket是公众号用于调用微信JS接口的临时票据。正常情况下,jsapi_ticket的有效期为7200秒,通过access_token来获取。由于获取jsapi_ticket的api调用次数非常有限,频繁刷新jsapi_ticket会导致api调用受限,影响自身业务,开发者必须在自己的服务全局缓存jsapi_ticket 。
参考以下文档获取access_token(有效期7200秒,开发者必须在自己的服务全局缓存access_token):https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html
用第一步拿到的access_token 采用http GET方式请求获得jsapi_ticket(有效期7200秒,开发者必须在自己的服务全局缓存jsapi_ticket):https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi
成功返回如下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×tamp=1414587457&url=http://mp.weixin.qq.com?params=value
步骤2. 对string1进行sha1签名,得到signature:
0f9de62fce790f9a083d5c99e95740ceb90c27ed
注意事项
签名用的noncestr和timestamp必须与wx.config中的nonceStr和timestamp相同。
签名用的url必须是调用JS接口页面的完整URL。
出于安全考虑,开发者必须在服务器端实现签名的逻辑。
如出现invalid signature 等错误详见附录5常见错误及解决办法。
调用Api:wx.config出现invalid signature
上面微信的加密规则,这里最大的一个坑就是url,很多网友的url都是通过window.location.href.split('#')[0]获取的,然后就用来加密了,很可能出现签名无效的情况
- url可能有特殊字符或者什么的,使用encodeURIComponent,后台去解析
- 传给后台加密的url,跟你发布H5在微信点进去的链接要是一样的,这是最重要的一条,就假如你公众号的链接是http://xx.xxx.com/H5,那你加密的url也应该是是http://xx.xxx.com/H5
下面是我写的一个js文件,导入就可以使用了
let urlEn = encodeURIComponent(window.location.href.split('#')[0])
this.$httpUtil.httpRequest.request({
url: this.$httpUtil.httpUrl.getWXConfig,
data: {
url: urlEn
}
}).then(res => {
getApp().globalData.dLog('getWXConfig=====', res.data)
wxScan.wxJSAPIInit(res.data)
})
// wxScan.js
let wxScan = {}
wxScan.wxJSAPIInit = function(wxData) {
return new Promise((success, fail) => {
const wx = require('./jweixin-module.js')
wx.config({
debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
appId: wxData.app_id, // 必填,企业号的唯一标识,此处填写企业号corpid
timestamp: wxData.timestamp, // 必填,生成签名的时间戳
nonceStr: wxData.nonce_str, // 必填,生成签名的随机串
signature: wxData.signature, // 必填,签名
jsApiList: [
'scanQRCode',
]
})
wx.ready(function() {
wx.checkJsApi({
jsApiList: ['scanQRCode'], // 需要检测的JS接口列表,所有JS接口列表见附录2,
success: function(res) {
// 以键值对的形式返回,可用的api值true,不可用为false
// 如:{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}
}
});
});
wx.error(function(res){
});
});
};
wxScan.wxJSAPIScan = function(wxData) {
return new Promise((success, fail) => {
const wx = require('./jweixin-module.js')
wx.ready(function() {
wx.scanQRCode({
needResult: 1, // 默认为0,扫描结果由微信处理,1则直接返回扫描结果,
scanType: ["qrCode", "barCode"], // 可以指定扫二维码还是一维码,默认二者都有
success: function(res) {
console.log('res=========>', res);
var result = res.resultStr; // 当needResult 为 1 时,扫码返回的结果
// this.parsePrintKey(result, index)
success(result)
}
});
});
});
}
export default wxScan