微信jssdkapi文档

1. 如何在React中调用微信的jsSDK

1. 微信JSSDK使用步骤简介

我们既然是在做基于微信的开发，当然就离不开微信的开发文档了。开始之前希望大家能先去看下《微信JS-SDK说明文档》。那么我们怎么样才能用上微信的JSSDK呢？以下基本步骤就是基于该文档的。

需要注意的是，如果本人下面的描述你看的有点云里雾里的话，我建议你：

• 回头看下本系列《小白学react》的历史基础文章，特别是《小白学react之altjs的Action和Store》以及《小白学react之打通React Component任督二脉》，或/和：

• 直接跳过我的描述，在文章后面下载最新的源码，先阅读源码，碰到问题再反过来看文章的描述。

步骤一：绑定域名

先登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。
备注：登录后可在“开发者中心”查看对应的接口权限。

这里绑定的时候需要注意不要带前面的http协议头。写法跟上一篇《小白学react之网页获取微信用户信息》中的网页回调域名设置的写法是一样的。

步骤二：引入JS文件

在需要调用JS接口的页面引入如下JS文件，（支持https）：

请注意，如果你的页面启用了https，务必引入 ：
，否则将无法在iOS9.0以上系统中成功使用JSSDK

因为我们的index.html是通过ejs模版生成的，所以我们只需要在我们的index.ejs中的body部分末尾加入相应的微信jssdk库的引用就好了。

• <% for (var chunk in htmlWebpackPlugin.files.chunks) { %> <script src="<%= htmlWebpackPlugin.files.chunks[chunk].entry %>"></script>


• <script src="jweixin-1.0.0.js"></script>


• <% } %>



步骤三：通过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: '',// 必填，签名，见附录1


• jsApiList: [] // 必填，需要使用的JS接口列表，所有JS接口列表见附录2});



这一步的关键是如何生成正确的签名。这里微信jssdk文档中有给出不同语言版本的签名算法示例大家可以参考。往下我们也会就github上的一个签名算法的封装进行学习。

在我们的实战过程中，签名会在服务器端发生。

react客户端会像之前的获取微信用户信息一样，通过一个restfulApi调用服务器端的api，然后由服务器来生成对应的签名，然后将签名信息返回给客户端。

客户端获取到上面wx.config示例代码中的签名相关信息后，就会调用一个Alt的Action，来触发将获取回来的信息保存到一个跟该Action绑定的jssdk状态管理的Store里面。然后就可以调用wx.config来配置我们需要用到的JS接口列表了。

注意这里的wx这个对象是通过上一步的JS文件引入进来的。我们在react的客户端代码中可以直接通过window.wx对其进行引用：

• window.wx.config({


• ...


• });



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

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



随后，react客户端负责jssdk状态管理的store会调用wx.ready来监听config配置是否成功，如果成功的话，就会将该store的一个ready状态设置成true。

这样的话，通过AltContainer绑定了该store的相应的Component组件就能知道响应的jssdk的api是否已经准备就绪，可以进行调用了。

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

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



同理，如果如果配置失败的话，那么就在wx.error这个监听接口中将ready状态设置成false。

2. 生成签名

如前面所述，我们需要用到jssdk的页面必须要要注入调用到的api的配置信息。

• wx.config({


• debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来，若要查看传入的参数，可以在pc端打开，参数信息会通过log打出，仅在pc端时才会打印。


• appId: '', // 必填，公众号的唯一标识


• timestamp: , // 必填，生成签名的时间戳


• nonceStr: '', // 必填，生成签名的随机串


• signature: '',// 必填，签名，见附录1


• jsApiList: [] // 必填，需要使用的JS接口列表



而注入JS接口到页面时，我们可以看到，还需要使用到其他一些信息。其中appId我们可以从公众号管理后台获得。signature是跟所访问页面的url关联的一个签名，它有专门的一套算法来生成。另外两个参数nonceStr和signature都是在签名的过程中生成的。

这里通过wx.config传进去这些参数，主要是为了让微信去判断我们生成的签名和微信通过这些信息生成的签名是否一致，如果不一致的话，那么注入到该页面的jsApiListj就失败。

那么我们在服务器这边的签名算法是如何的呢？根据微信开发文档我们需要提供以下4个参数，然后通过sha1算发来生成对应的签名：

• noncestr：一个随机字符串，我们随便填写

• jsapi_ticket：jsapi_ticket是公众号用于调用微信JS接口的临时票据

• timestamp: 签名时间戳。注意这个时间戳需要和上面传入wx.config的时间戳一致

• url: 调用JS接口页面的完整URL。我们可以从react客户端通过location.href获得，并传给服务器端

那么这里主要需要解决的就是如何获得jsapi_ticket这个临时票据了。

根据文档的描述，我们可以通过以下这个接口获得：

cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi

从中可以看到，我们调用这个接口首先要获得一个access_token。这里微信也有相应的api来处理。

cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET

这里需要用到我们的微信公众号的appId和secret，这些我们都是已知的，所以好办。

那么，也就是说，我们其实只需要提供我们的微信公众号的appId和secret，就能获取到access_token，从而就会获得我们需要的jsapi_ticket。

这里我们参考下github上一个示例(wechat-sdk-demo )的签名的实现。其传入的参数有两个，其中:

• url: react客户端传进来的需要注入jsapi的页面url

• callback: 一个回调函数，接受一个json格式的参数。主要是用来将生成的签名信息等回传给上层调用函数。

• const config = { grant_type: 'client_credential', appid: 'xxxx', secret: "xxxxx", noncestr:'Wm3WZYTPz0wzccnW', accessTokenUrlin.qq.com/cgi-bin/token', ticketUrl:'com/cgi-bin/ticket/getticket',


• }



• exports.sign = function (url,callback) { var noncestr = config.noncestr,


• timestamp = Math.floor(Date.now()/1000), //精确到秒


• ...


• request(config.accessTokenUrl + '?grant_type=' + config.grant_type + '&appid=' + config.appid + '&secret=' + config.secret ,function(error, response, body){ if (!error && response.statusCode == 200) { var tokenMap = JSON.parse(body);


• request(config.ticketUrl + '?access_token=' + tokenMap.access_token + '&type=jsapi', function(error, resp, json){ if (!error && response.statusCode == 200) { var ticketMap = JSON.parse(json);


• cache.put('ticket',ticketMap.ticket,config.cache_ration); //加入缓存


• callback({ noncestr:noncestr, timestamp:timestamp, url:url, jsapi_ticket:ticketMap.ticket, signature:sha1('jsapi_ticket=' + ticketMap.ticket + '&noncestr=' + noncestr + '&timestamp=' + timestamp + '&url=' + url)


• });


• }


• })


• }


• })


• }


• }



这里的流程和我们刚才描述的并无二致。首先是通过appId和secret获得调用获取jsapi_ticket的access_token，然后通过该access_token获得我们签名需要用到的jsapi_ticket。noncestr我们是提前随便填写好的。timestamp的算法也比较简单。

最后就是通过sha1这个库提供的方法，将jsapi_ticket，noncestr，timestamp和页面url进行sha1签名，然后将以上这些信息通过callback返回给上层调用函数。

那么我们往下看下我们的上层调用函数。其实就是我们的express路由:

• app.get("/api/signature", function(req,res) { const url = req.query.url.split('#')[0];



• signature.sign(url,function(signatureMap){


• signatureMap.appId = wechat_cfg.appid;


• res.send(signatureMap);


• });



• })



根据微信开发文档需求，我们首先需要将传进来的url的锚点后面的数据给去掉，保留前面的有效部分。

然后就是调用上面的sign方法来生成签名。上面的签名方法最后传进来的json数据就是这里的signatureMap。我们最终会将这些数据发送回react客户端。

同时，通过上面的wx.config的示例，我们知道还需要用到微信公众号的appId。所以这里一并将其放到signatureMap中进行返回。

那么到此为止，react客户端调用服务端的"/api/signature"返回的数据示例如下:

• {


• noncestr: 'Wm3WZYTPz0wzccnW',


• timestamp: 1476873698,


• url: 'com/?code=&state=',


• jsapi_ticket: 'sM4AOVdWfPE4DxkXGEs8VBqyVbs-TKGYp4d_ZSQa0Q5WvvMUPNQ6XGpyEcgKOD_xID_GrMCaalSmIF9JbrGaOg',


• signature: ''


• }



3. 客户端获取签名信息

3.1 获取签名信息并注入jssdk

和之前的获取微信用户信息一样，我们这里会建立一个新的Source文件WechatSdkSource.js来调用远程服务器的"/api/signature"接口:

• var WechatSdkSource = {


• fetchSignatureMap() { return {


• remote(state,url) { return co(function *() { let signatureMap = null; const getSignatureMapUrl = `/api/signature`; try { let result = yield request.get(getSignatureMapUrl).query({url:url});


• signatureMap = result.body;


• } catch (e) {


• signatureMap = null;


• } //console.log("userInfo:", userInfo);


• return signatureMap;


• });


• },



• local() { // Never check locally, always fetch remotely.


• return null;


• }, success: WechatSdkActions.updateSignatureMap, error: WechatSdkActions.getSignatureMapFailed, loading: WechatSdkActions.getSignatureMap,


• }


• }


• };



这里传进来的url由下面将要谈及的上层函数所生成。整个流程就没有什么好说的了，说白了就是通过相应的库发送一个带有url的query参数的请求到服务器端来请求签名信息，相信有跟着这个系列文章的朋友都是很清楚的了。

最终请求成功返回的时候就会调用WechatSdkActions的updateSignatureMap这个Action。

• var alt = require('../alt');mole.exports = alt.generateActions( 'updateSignatureMap', 'getSignatureMap', 'getSignatureMapFailed',


• );



而这个action就会触发所监听的WechatSdkStore的onUpdateSignatureMap这个回调。

• class WechatSdkStore { constructor() { this.signatureMap = []; this.errorMessage = null; this.ready = false; this.bindActions(WechatSdkActions); this.exportAsync(WechatSdkSource);

2. 【求帮助】 微信JSSDK 分享接口，调用没反应

你在wx.config时，打开调试模式，自己测试测试，在调试模式下，都会alert信息出来，看版看alert出来的是什么信息。

3. 微信公众号开发之如何使用JSSDK

微信开发交流群：148540125
欢迎留言、转发、打赏

系列文章参考地址 极速开发微信公众号
项目源码参考地址 点我点我--欢迎Start

服务号、订阅号可以通过登录 微信公众平台 查看 开发>接口权限

使用JSSDK主要包括
1、判断当前客户端版本是否支持指定JS接口、
2、分享接口（微信认证）
3、图像接口
4、音频接口
5、智能接口（识别语音并返回结果）
6、设备信息（获取网络状态）
7、地理位置
8、界面操作
9、微信扫一扫
10、微信小店（服务号必须通过微信认证）
11、微信卡券 （微信认证）
12、微信支付（服务号必须通过微信认证）

官方参考文档

步骤一：绑定域名

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

步骤二：引入JS文件
在需要调用JS接口的页面引入如下JS文件，（支持https）： http://res.wx.qq.com/open/js/jweixin-1.0.0.js
如需使用摇一摇周边功能，请引入 http://res.wx.qq.com/open/js/jweixin-1.1.0.js
备注：支持使用 AMD/CMD 标准模块加载方法加载

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

签名算法生成规则

请 官方参考文档

下面具体来讲讲 开源项目 weixin_guide 中的封装。

使用的时候只要在Controller方法上添加一个拦截器 JSSDKInterceptor 来实现签名验证再将 wx.config 需要的参数设置对应的属性在页面上进行获取。

拦截器实现如下：

在Controller中使用

JSP页面上面使用

测试结果

在AppConfig 中添加路由 me.add("/jssdk", JSSDKController.class,"/view"); 手机中访问 http://域名[/项目名称]/jssdk ,如果设置了 debug= true 成功了就会弹出

如果出现 {"errorMsg":"config:invalid url domian"} 请检查 步骤一：绑定域名 与你访问的域名是否在安全域名列表当中

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

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

步骤六：接口调用

拦截器具体实现 参考地址 点这里
js 接口调用参考地址 点这里

以上就是JSSDK使用的介绍。
欢迎留言、转发、打赏项目

源码参考地址 点我点我--欢迎Start

4. 怎么使用微信JSSDK的自定义分享功能

一，首先在公众号管理后台“公众号设置”的“功能设置”里填写JS接口安全域名，域名需要通过ICP备案，没有备案域名可以用SAE、BAE等平台。此外，自定义分享功能需要通过微信认证才能使用，没有认证的可以跟关系好的朋友借用权限，在他的JS接口安全域名设置这里填上你的域名和共享同一个开发者ID。

二，在需要调用JS接口的页面引入微信JSSDK的JS文件：http://res.wx.qq.com/open/js/jweixin-1.0.0.js，这个文件在需要分享的页面是必须要引用的，单独特别重申一下，其他方面请阅读官方文档http://mp.weixin.qq.com/wiki/7/.html

引用方法：在网页title标题下面加上：<script src="http://res.wx.qq.com/open/js/jweixin-1.0.0.js"></script>

三，下载官方示例代码：

http://www.huceo.com/zb_users/upload/2015/07/201507081436362390123294.zip

解压之后在例如PHP文件夹中看到以下文件：

5. 微信朋友圈JSSDK分享自定义图片文字

1、在微信公众号添加安全域名（制作的H5页面的主域名）；

测试阶段，本人是通过修改hosts文件，将对应域名解析为127.0.0.1 ； 然后将电脑和手机连接至同个局域网下。修改手机代理为电脑在局域网内的IP地址；这样手机就能正常进行测试；

2、引入jssdk   script    src='http://res.wx.qq.com/open/js/jweixin-1.0.0.js'

3、配置jssdk，成功后方可使用相关功能，方式如下

wx.config({

debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来，若要查看传入的参数，可以在pc端打开，参数信息会通过log打出，仅在pc端时才会打印。

appId: 'XX', // 必填，公众号的唯一标识

timestamp: XX, // 必填，生成签名的时间戳

nonceStr: xx, // 必填，生成签名的随机串

signature: xx, // 必填，签名，见附录1  

jsApiList: ['onMenuShareTimeline','onMenuShareAppMessage'] // 必填，需要使用的JS接口列表，所有JS接口列表见附录2

});

第一次接触时看到网上的文章在此对signature没有过多的说明，这里我自己大概说一下，此参数是通过获取公众号的id及secret获取 access _token,然后通过 access _token获取jsapi_ticket，然后通过时间戳，随机串，当前页面url，通过sha1加密生成；（这里做下说明，此步骤由后台处理后返回给前端即可）；

刚接触的时候领导认为纯前端可实现，这。。。确实可以实现，这里就不做过多说明了；至于要后端处理的原因大致为两点1、公众号id和secret在前端实现不安全  2、 access _token和jsapi_ticket每日有请求次数的限制，过期时间两小时，所以需要后台在服务器缓存，每两小时获取一次；

4、wx.config配置正确即可通过wx.ready来调用相应功能

wx.ready(function() {

wx.onMenuShareTimeline({   //分享朋友圈

title: 'X', // 分享标题

link: window.location.href, // 分享链接

imgUrl: url, // 分享图标

success: function() {

// 用户确认分享后执行的回调函数

console.log('分享成功了哟哟哟')

},

cancel: function() {

// 用户取消分享后执行的回调函数

}

});

wx.onMenuShareAppMessage({  // 好友分享

title: '', // 分享标题

desc: '', // 分享描述

link: window.location.href, // 分享链接

imgUrl: '', // 分享图标

success: function () {

// 用户确认分享后执行的回调函数

},

cancel: function () {

// 用户取消分享后执行的回调函数

}

});

});

总结：其实对于前端要处理的很少，只要从后台获取signature签名，调用方法即可实现；具体可看官方文档；首次接触的小伙伴不要被吓到，就是如此简单；

6. 在vuejs中引入微信JS SDK的最佳方式是怎么样的

关键在于你调用wx.onMenuShareAppMessage的时机，如果是非SPA的vue.js应用，wx.config放到ready钩子里执行，然后将wx.onMenuShareAppMessage包在wx.ready方法内，以保证其在微信JSSDK获取到此接口权限时再注册事件。在此之前可以通过一些过渡效果延缓页面加载。
var example1 = new Vue({ el: '#example-1', data: {

}, ready: function() { this.$http.get({ url: 'api/wx/tokenSignature', data: { url: mui.os.ios === true? window.url : (location.protocol + '//' + location.host + '/wx' + url)
}, success: function(json) {
wx.config({ debug: false, appId: json.appId, timestamp: parseInt(json.timestamp), nonceStr: json.nonce, signature: json.signature, jsApiList: [ 'onMenuShareAppMessage'
]
});
wx.ready(function () {
wx.onMenuShareAppMessage({ success: function () {
// 用户确认分享后执行的回调函数
}, cancel: function () {
// 用户取消分享后执行的回调函数
}
});
});
}
})
}
})

如果你用到了vue-router，那么JSSDK时好时坏的的情况在Android下是肯定会发生的，wx.config也需要在适当的钩子函数里执行，重点在于vue-router切换view时url的变化。