微信JS-SDK是微信公众平台 面向网页开发者提供的基于微信内的网页开发工具包。
通过使用微信JS-SDK,网页开发者可借助微信高效地使用拍照、选图、语音、位置等手机系统的能力,同时可以直接使用微信分享、扫一扫、卡券、支付等微信特有的能力,为微信用户提供更优质的网页体验。
这里就来和大家一起分享下,通过JS-SDK实现分享功能。(分享接口的实现参照 JS-SDK使用步骤)
JS-SDK使用步骤
步骤一:绑定域名
先登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。
备注:登录后可在“开发者中心”查看对应的接口权限。
步骤二:引入JS文件
在需要调用JS接口的页面引入如下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.4.0.js
如需进一步提升服务稳定性,当上述资源不可访问时,可改访问:http://res2.wx.qq.com/open/js/jweixin-1.4.0.js (支持https)。
备注:支持使用 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: '',// 必填,签名 jsApiList: [] // 必填,需要使用的JS接口列表});
签名算法就不放出来了,大家可以在公众号的开放文档中的 微信网页开放——JS-SDK说明文档-附录1中查看;这里我们用到的js分享接口有2个('onMenuShareTimeline', 'onMenuShareAppMessage')所有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对象)来调用,参数是一个对象,除了每个接口本身需要传的参数之外,还有以下通用参数: 1、success:接口调用成功时执行的回调函数。 2、fail:接口调用失败时执行的回调函数。 3、complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。 4、cancel:用户点击取消时的回调函数,仅部分有用户取消操作的api才会用到。 5、trigger: 监听Menu中的按钮点击时触发的方法,该方法仅支持Menu中的相关接口。 【备注:】不要尝试在trigger中使用ajax异步请求修改本次分享的内容,因为客户端分享操作是一个同步操作,这时候使用ajax的回包会还没有返回。 以上几个函数都带有一个参数,类型为对象,其中除了每个接口本身返回的数据之外,还有一个通用属性errMsg,其值格式如下: 调用成功时:"xxx:ok" ,其中xxx为调用的接口名 用户取消时:"xxx:cancel",其中xxx为调用的接口名 调用失败时:其值为具体错误信息
下面来看具体实现代码:
视图页面代码:
<!DOCTYPE html> <html> <head> <title>公众号JS-SDK分享</title> <meta charset="utf-8"> <mate name="viewpoint" content="inital-scale=1.0;width=device-width"> <script type="text/javascript" src="http://res.wx.qq.com/open/js/jweixin-1.4.0.js"></script> </head> <body> <p>{$title}</p> <p>{$description}</p> <p>{$url}</p> <p><img src="{$thumb}"></p> <script type="text/javascript"> wx.config({ debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。 appId: '{$appid}', // 必填,公众号的唯一标识 timestamp: {$time}, // 必填,生成签名的时间戳 nonceStr: '{$nonceStr}', // 必填,生成签名的随机串 signature: '{$signature}',// 必填,签名 jsApiList: [ 'onMenuShareTimeline', 'onMenuShareAppMessage', ] // 必填,需要使用的JS接口列表 }); wx.ready(function(){ wx.onMenuShareTimeline({ title: '{$title}', // 分享标题 link: '{$url}', // 分享链接,该链接域名或路径必须与当前页面对应的公众号JS安全域名一致 imgUrl: '{$thumb}', // 分享图标 success: function () { // 用户点击了分享后执行的回调函数 alert("分享成功"); }, cancel: function () { // 用户取消分享后执行的回调函数 alert("分享被取消,请重新分享"); } }) wx.onMenuShareAppMessage({ title: '{$title}', // 分享标题 desc: '{$description}', // 分享描述 link: '{$url}', // 分享链接,该链接域名或路径必须与当前页面对应的公众号JS安全域名一致 imgUrl: '{$thumb}', // 分享图标 type: '', // 分享类型,music、video或link,不填默认为link dataUrl: '', // 如果type是music或video,则要提供数据链接,默认为空 success: function () { // 用户点击了分享后执行的回调函数 alert("分享成功"); }, cancel: function () { // 用户取消分享后执行的回调函数 alert("分享被取消,请重新分享"); } }); }); wx.error(function(res){ }); </script> </body> </html>
控制器相关代码:(控制器中只放了主要相关代码,access_token、url请求等可以查看前面的文章)(因为要做模板渲染,所以这里控制器基础了基础控制器tp5的 Controller ,)
use think\Controller;//继承基础控制器需要引入的命名空间 use think\Session; //使用session需要引入的命名空间 //分方法享主 public function share() { $data = \db('news')->order('id desc')->paginate(1)->toArray(); $content = $data['data'][0]; $timestamp = time(); $ticket = $this->_getJsApiTicket(); $nonceStr = $this->_getRandCode(); $url = '###'; //控制器 share 方法的网站访问url //sitnature 签名生成规则:参与签名的字段包括: //noncestr(随机字符串), //有效的jsapi_ticket, //timestamp(时间戳), //url(当前网页的URL) //详细算法说明可以查看JS-SDK说明文档-附录1 $signature = "jsapi_ticket={$ticket}&noncestr={$nonceStr}×tamp={$timestamp}&url={$url}"; $signature = sha1($signature); echo "controller:nonceStr-{$nonceStr} <br>"; echo "controller:timestamp-{$timestamp} <br>"; $this->assign([ 'title' => $content['title'], 'description' => $content['description'], 'url' => $content['url'], 'thumb' => $content['thumb'], 'inputtime' => $content['inputtime'], 'time' => $timestamp, 'appid' =>$this->appid, 'nonceStr' => $nonceStr, 'signature' => $signature, 'ticket' => $ticket, ]); return $this->fetch(); } //js_api_ticket获取 //js_api_ticket 有时效性,所以这里存放到了session中 private function _getTicket() { if (Session::get('ticket') && Session::get('ticket_expire_time')>time() ) { return Session::get('ticket'); }else{ $accessToken = $this->_getAccessToken(); $url = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token={$accessToken}&type=jsapi"; $res = $this->_httpCurl($url); $ticket = $res['ticket']; Session::set('ticket',$ticket); Session::set('ticket_expire_time',time()+7200); return $ticket; } } // 获取 nonceStr 随机字符串 16位 private function _getRandCode($length = 16) { $arr = array_merge(range(0, 9), range('a', 'z'), range('A', 'Z')); $arrLen = count($arr); $str = ''; for ($i=0; $i<$length; $i++) { $str .= $arr[mt_rand(0, ($arrLen-1))]; } return $str; }
实际效果:
(第一张是打开实现了分享接口的页面时的情景,config:ok 说明接口实现成功,第二张是从右上角选择分享按钮后的提示,如果在实际线上项目中不希望出现这些提示,可以把wx.config 中的 debug 的值改成false)在分享成功后会执行 success 回调函数,如果有用户分享成功后的业务逻辑处理,都可以在success 里面完成。
【tips】
虽然开放文档里面说 'onMenuShareTimeline', 'onMenuShareAppMessage', 即将被废弃,新的自定分享接口是 'updateAppMessageShareData', 'updateTimelineShareData',但就目前从效果和体验上来说,后两个接口不如前两个,也许是因为前两个接口还没完全被废弃的原因吧。