微信公众号开发之微信JSSDK
概述
微信JS-SDK是微信公众平台面向网页开发者提供的基于微信内的网页开发工具包。
通过使用微信JS-SDK，网页开发者可借助微信高效地使用拍照、选图、语音、位置等手机系统的能力，同时可以直接使用微信分享、扫一扫、卡券、支付等微信特有的能力， 为微信用户提供更优质的网页体验。
此文档面向网页开发者介绍微信JS-SDK如何使用及相关注意事项。
JSSDK使用步骤
步骤一：绑定域名
先登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。
备注：登录后可在“开发者中心”查看对应的接口权限。
步骤二：引入JS文件
在需要调用JS接口的页面引入如下JS文件，（支持https）：http://res.wx.qq.com/open/js/jweixin-1.0.0.js
备注：支持使用 AMD/CMD 标准模块加载方法加载
步骤三：通过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
});
步骤四：通过ready接口处理成功验证
wx.ready(function(){
// config信息验证后会执行ready方法，所有接口调用都必须在config接口获得结果之后，config是一个客户端的异步操作，所以如果需要在页面加载时就调用相关接口，则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口，则可以直接调用，不需要放在ready函数中。
});
步骤五：通过error接口处理失败验证
wx.error(function(res){
// config信息验证失败会执行error函数，如签名过期导致验证失败，具体错误信息可以打开config的debug模式查看，也可以在返回的res参数中查看，对于SPA可以在这里更新签名。
});
接口调用说明
所有接口通过wx对象(也可使用jWeixin对象)来调用，参数是一个对象，除了每个接口本身需要传的参数之外，还有以下通用参数：
- success：接口调用成功时执行的回调函数。
- fail：接口调用失败时执行的回调函数。
- complete：接口调用完成时执行的回调函数，无论成功或失败都会执行。
- cancel：用户点击取消时的回调函数，仅部分有用户取消操作的api才会用到。
- trigger: 监听Menu中的按钮点击时触发的方法，该方法仅支持Menu中的相关接口。
备注：不要尝试在trigger中使用ajax异步请求修改本次分享的内容，因为客户端分享操作是一个同步操作，这时候使用ajax的回包会还没有返回。
以上几个函数都带有一个参数，类型为对象，其中除了每个接口本身返回的数据之外，还有一个通用属性errMsg，其值格式如下：
- 调用成功时："xxx:ok" ，其中xxx为调用的接口名
- 用户取消时："xxx:cancel"，其中xxx为调用的接口名
- 调用失败时：其值为具体错误信息
1 /// <summary>
2 /// 微信参数准备
3 /// </summary>
4 private void WxSdkPramas(bool isShare)
5 {
6 var jsSdk = new JSSDKHelper();
7 //获取时间戳
8 var timestamp = JSSDKHelper.GetTimestamp();
9 //获取随机码
10 var nonceStr = JSSDKHelper.GetNoncestr();
11 var appId = WeiXinAppId;
12 var appSecret = WeiXinAppSecret;
13 //获取票证
14 var jsTicket = JsApiTicketContainer.TryGetTicket(appId, appSecret);
15 //获取签名
16 var signature = jsSdk.GetSignature(jsTicket, nonceStr, timestamp, Request.Url.AbsoluteUri);
17
18 ViewData["AppId"] = appId;
ViewData["Timestamp"] = timestamp;
21 ViewData["NonceStr"] = nonceStr;
22 ViewData["Signature"] = signature;
23 }
下面是js相关代码：
1 <head>
2 <meta name="viewport" content="width=device-width" />
3 <title>公众号JSSDK演示</title>
4 <script src="~/Scripts/jquery-1.7.1.min.js"></script>
5 <script src="http://res.wx.qq.com/open/js/jweixin-1.0.0.js"></script>
6 <script>
7 wx.config({
8 debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来，若要查看传入的参数，可以在pc端打开，参数信息会通过log打出，仅在pc端时才会打印。
9 appId: '@ViewData["AppId"]', // 必填，公众号的唯一标识
10 timestamp: '@ViewData["Timestamp"]', // 必填，生成签名的时间戳
11 nonceStr: '@ViewData["NonceStr"]', // 必填，生成签名的随机串
12 signature: '@ViewData["Signature"]',// 必填，签名
13 jsApiList: [
14 "checkJsApi",
15 'onMenuShareTimeline',
16 'onMenuShareAppMessage',
17 'onMenuShareQQ',
18 'onMenuShareWeibo',
19 'hideMenuItems',
20 'showMenuItems',
21 'hideAllNonBaseMenuItem',
22 'showAllNonBaseMenuItem',
23 'translateVoice',
24 'startRecord',
25 'stopRecord',
26 'onRecordEnd',
27 'playVoice',
28 'pauseVoice',
29 'stopVoice',
30 'uploadVoice',
31 'downloadVoice',
32 'chooseImage',
33 'previewImage',
34 'uploadImage',
35 'downloadImage',
36 'getNetworkType',
37 'openLocation',
38 'getLocation',
39 'hideOptionMenu',
40 'showOptionMenu',
41 'closeWindow',
42 'scanQRCode',
43 'chooseWXPay',
44 'openProductSpecificView',
45 'addCard',
46 'chooseCard',
47 'openCard'
48 ] // 必填，需要使用的JS接口列表，所有JS接口列表见附录2。详见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html
49 });
50
51 wx.error(function (res) {
52 console.log(res);
53 alert('验证失败');
54 });
55
56 wx.ready(function () {
57 var url = 'http://weixin.senparc.com';
58 var link = url + '@(Request.Url.PathAndQuery)';
59 var imgUrl = url + '/images/v2/ewm_01.png';
60
61 //转发到朋友圈
62 wx.onMenuShareTimeline({
63 title: 'JSSDK朋友圈转发测试',
64 link: link,
65 imgUrl: imgUrl,
66 success: function () {
67 alert('转发成功！');
68 },
69 cancel: function () {
70 alert('转发失败！');
71 }
72 });
73 //转发给朋友
74 wx.onMenuShareAppMessage({
75 title: 'JSSDK朋友圈转发测试',
76 desc: '转发给朋友',
77 link: link,
78 imgUrl: imgUrl,
79 type: 'link',
80 dataUrl: '',
81 success: function () {
82 alert('转发成功！');
83 },
84 cancel: function () {
85 alert('转发失败！');
86 }
87 });
88 });
89 </script>
90
91 </head>
上面用到的Helper:
1 public class JSSDKHelper
2 {
3 public JSSDKHelper()
4 {
5 Parameters = new Hashtable();
6 }
7
8 protected Hashtable Parameters;
9
10 /// <summary>
11 /// 设置参数值
12 /// </summary>
13 /// <param name="parameter"></param>
14 /// <param name="parameterValue"></param>
15 private void SetParameter(string parameter, string parameterValue)
16 {
17 if (!string.IsNullOrEmpty(parameter))
18 {
19 if (Parameters.Contains(parameter))
20 {
21 Parameters.Remove(parameter);
22 }
23
24 Parameters.Add(parameter, parameterValue);
25 }
26 }
27
28 private void ClearParameter()
29 {
30 Parameters.Clear();
31 }
32
33 /// <summary>
34 /// 获取随机字符串
35 /// </summary>
36 /// <returns></returns>
37 public static string GetNoncestr()
38 {
39 Random random = new Random();
40 return MD5Util.GetMD5(random.Next(1000).ToString(), "GBK");
41 }
42
43 /// <summary>
44 /// 获取时间戳
45 /// </summary>
46 /// <returns></returns>
47 public static string GetTimestamp()
48 {
49 TimeSpan ts = DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0);
50 return Convert.ToInt64(ts.TotalSeconds).ToString();
51 }
52
53 /// <summary>
54 /// sha1加密
55 /// </summary>
56 /// <returns></returns>
57 private string CreateSha1()
58 {
59 StringBuilder sb = new StringBuilder();
60 ArrayList akeys = new ArrayList(Parameters.Keys);
61 akeys.Sort();
62
63 foreach (string k in akeys)
64 {
65 string v = (string)Parameters[k];
66
67 if (sb.Length == 0)
68 {
69 sb.Append(k + "=" + v);
70 }
71 else
72 {
73 sb.Append("&" + k + "=" + v);
74 }
75 }
76 return SHA1UtilHelper.GetSha1(sb.ToString()).ToString().ToLower();
77 }
78
79 /// <summary>
80 /// 生成cardSign的加密方法
81 /// </summary>
82 /// <returns></returns>
83 private string CreateCardSha1()
84 {
85 StringBuilder sb = new StringBuilder();
86 ArrayList akeys = new ArrayList(Parameters.Keys);
87 akeys.Sort();
88
89 foreach (string k in akeys)
90 {
91 string v = (string)Parameters[k];
92
93 sb.Append(v);
94 }
95 return SHA1UtilHelper.GetSha1(sb.ToString()).ToString().ToLower();
96 }
97
98 /// <summary>
99 /// 获取JS-SDK权限验证的签名Signature
100 /// </summary>
101 /// <param name="ticket"></param>
102 /// <param name="noncestr"></param>
103 /// <param name="timestamp"></param>
104 /// <param name="url"></param>
105 /// <returns></returns>
106 public string GetSignature(string ticket, string noncestr, string timestamp, string url)
107 {
108 //清空Parameters
109 ClearParameter();
110
111 SetParameter("jsapi_ticket", ticket);
112 SetParameter("noncestr", noncestr);
113 SetParameter("timestamp", timestamp);
114 SetParameter("url", url);
115
116 return CreateSha1();
117 }
118
119 /// <summary>
120 /// 获取位置签名AddrSign
121 /// </summary>
122 /// <param name="appId"></param>
123 /// <param name="appSecret"></param>
124 /// <param name="noncestr"></param>
125 /// <param name="timestamp"></param>
126 /// <param name="url"></param>
127 /// <returns></returns>
128 public string GetAddrSign(string appId, string appSecret, string noncestr, string timestamp, string url)
129 {
130 //清空Parameters
131 ClearParameter();
132
133 var accessToken = AccessTokenContainer.TryGetToken(appId, appSecret);
134 SetParameter("appId", appId);
135 SetParameter("noncestr", noncestr);
136 SetParameter("timestamp", timestamp);
137 SetParameter("url", url);
138 SetParameter("accesstoken", accessToken);
139
140 return CreateSha1();
141 }
142
143 /// <summary>
144 /// 获取卡券签名CardSign
145 /// </summary>
146 /// <param name="appId"></param>
147 /// <param name="appSecret"></param>
148 /// <param name="locationId"></param>
149 /// <param name="noncestr"></param>
150 /// <param name="timestamp"></param>
151 /// <param name="cardId"></param>
152 /// <param name="cardType"></param>
153 /// <returns></returns>
154 public string GetCardSign(string appId, string appSecret, string locationId, string noncestr, string timestamp, string cardId, string cardType)
155 {
156 //清空Parameters
157 ClearParameter();
158
159 SetParameter("appId", appId);
160 SetParameter("appsecret", appSecret);
161 SetParameter("location_id", locationId);
162 SetParameter("nonce_str", noncestr);
163 SetParameter("times_tamp", timestamp);
164 SetParameter("card_id", cardId);
165 SetParameter("card_type", cardType);
166
167 return CreateCardSha1();
168 }
169 }
浙公网安备 33010602011771号