微信公众号wxjssdk接入指南

微信公众号wxjssdk接入

最近在做公众号项目，需要用到微信JS-SDK获取用户经纬度，所以记录一下接入流程

微信JS-SDK是微信公众平台 面向网页开发者提供的基于微信内的网页开发工具包。
通过使用微信JS-SDK，网页开发者可借助微信高效地使用拍照、选图、语音、位置等手机系统的能力，同时可以直接使用微信分享、扫一扫、卡券、支付等微信特有的能力，为微信用户提供更优质的网页体验

微信JS-SDK详情说明请移步微信官方文档：https://mp.weixin.qq.com/wikit=resource/res_main&id=mp1421141115

JSSDK使用步骤

步骤一：绑定域名

先登录微信公众平台进入“公众号设置”（官网地址：https://mp.weixin.qq.com/）的“功能设置”里填写“JS接口安全域名”。
备注：登录后可在“开发者中心”查看对应的接口权限。

步骤二：引入JS文件

在需要调用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 标准模块加载方法加载

我在项目中是直接通过npm下包，没引入

npm install weixin-js-sdk

装好之后引入

/* 使用ES6模块引入 */
import wx from 'weixin-js-sdk';

为wx.config实现权限签名算法

jsapi_ticket

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

签名算法

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

项目中单独弄了个配置文件，懒得敲字我直接贴代码了，这里面包含了签名算法还有config配置，想了解config配置的往下看看

/ wxjsdk 接入
// 获取jsapi_ticket的接口 
//正常是直接请求https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi，但是我这有跨域，就叫后端写了个接口帮我请求
import { getTicket } from "@/api/common";
import wx from 'weixin-js-sdk';
// 加密插件
import CryptoJS from 'crypto-js'
// 配置文件
import config from "@/config";
//是否是微信浏览器
const isWechat = () => {
	var ua = window.navigator.userAgent.toLowerCase()
	if (ua.match(/micromessenger/i) == 'micromessenger') {
		return true;
	} else {
		return false;
	}
}
// 生成随机字符
function randomString(len) {
	len = len || 32;
	var $chars = 'ABCDEFGHJKMNPQRSTWXYZabcdefhijkmnprstwxyz2345678';    /****默认去掉了容易混淆的字符oOLl,9gq,Vv,Uu,I1****/
	var maxPos = $chars.length;
	var pwd = '';
	for (let i = 0; i < len; i++) {
		pwd += $chars.charAt(Math.floor(Math.random() * maxPos));
	}
	return pwd;
}

//需要使用的JS接口列表
let jsApiList = [
	'checkJsApi',
	'getLocation',
	'openLocation',
	'wx-open-launch-app',
	'wx-open-launch-weapp'
]

export default {
	isWechat,
	//配置信息
	initJssdk: () => {
		return new Promise((resolve, reject) => {
			//获取界面url
			let url = window.location.href.split('#')[0]
			getTicket().then(res => {
				let { ticket } = res.result
				let timestamp = Math.round(new Date().getTime() / 1000).toString() // 时间戳
				let nonceStr = randomString()  // 随机字符
				let signature = CryptoJS.SHA1(`jsapi_ticket=${ticket}&noncestr=${nonceStr}&timestamp=${timestamp}&url=${url}`).toString()
				wx.config({
					debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来
					appId: config.appId, // 必填，公众号的唯一标识
					timestamp, // 必填，生成签名的时间戳
					nonceStr, // 必填，生成签名的随机串
					signature,// 必填，签名
					jsApiList, // 必填，需要使用的JS接口列表
					openTagList:['wx-open-launch-weapp']
				});
				resolve()
			}).catch(err=>{
				reject(err)
			})
		})
	},
	// 检查权限,  这里是使用回调,  _option里面有success和fail参数, 当checkJsApi调用成功是 调用_option.success, 反之_option.fail
	checkJsApi: function (_option = {}) {
		jweixin.checkJsApi({
			jsApiList,
			success: res => {
				console.log(JSON.stringify(res))
			},
			fail: res => {
				console.log(JSON.stringify(res))
			},
		})
	},
	ready:wx.ready,
	// 获取位置信息
	getLocation: wx.getLocation,
	openLocation: wx.openLocation,
	// aa:function(){
	// 	console.log(wx.openLocation)
	// }
}

ps: 可以在微信签名工具上校验自己的签名正不正确

在页面调用就行，我这全局配置了，单页面使用的话把配置文件引入

  async onShow() {
        await this.$wechat.initJssdk();
        this.$wechat.ready(() => {
            this.getLocation();
        });
    },

步骤三：通过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接口列表
});

步骤四：通过ready接口处理成功验证

wx.ready(function(){
  // config信息验证后会执行ready方法，所有接口调用都必须在config接口获得结果之后，config是一个客户端的异步操作，所以如果需要在页面加载时就调用相关接口，则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口，则可以直接调用，不需要放在ready函数中。
});

步骤五：通过error接口处理失败验证

wx.error(function(res){
  // config信息验证失败会执行error函数，如签名过期导致验证失败，具体错误信息可以打开config的debug模式查看，也可以在返回的res参数中查看，对于SPA可以在这里更新签名。
});

接口调用说明

所有接口通过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为调用的接口名

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