以下把微信內建瀏覽器的常用能力封裝成一個 WeixinApi 物件,方便各頁面直接取用。功能包含:
1. 分享到微信朋友圈
2. 分享給微信好友
3. 分享到騰訊微博
4. 隱藏/顯示右上角選單入口
5. 隱藏/顯示底部瀏覽器工具列
6. 取得目前網路狀態
7. 調起微信客戶端的圖片預覽元件
8. 關閉公眾平台網頁
/**! * 微信內置瀏覽器的 Javascript API * * 1、分享到微信朋友圈 * 2、分享給微信好友 * 3、分享到騰訊微博 * 4、隱藏/顯示右上角的菜單入口 * 5、隱藏/顯示底部浏覽器工具欄 * 6、獲取當前的網絡狀態 * 7、調起微信客戶端的圖片播放組件 * 8、關閉公眾平台Web頁面 * * @author zhaoxianlie */ var WeixinApi = (function () { "use strict"; /** * 分享到微信朋友圈 * @param {Object} data 待分享的信息 * @param {Object} callbacks 相關回調方法 */ function weixinShareTimeline(data, callbacks) { callbacks = callbacks || {}; var shareTimeline = function (theData) { WeixinJSBridge.invoke('shareTimeline', { "appid": theData.appId ? theData.appId : '', "img_url": theData.imgUrl, "link": theData.link, "desc": theData.title, "title": theData.desc, // 注意這裡要分享出去的內容是 desc "img_width": "120", "img_height": "120" }, function (resp) { switch (resp.err_msg) { case 'share_timeline:cancel': callbacks.cancel && callbacks.cancel(resp); break; case 'share_timeline:fail': callbacks.fail && callbacks.fail(resp); break; case 'share_timeline:confirm': case 'share_timeline:ok': callbacks.confirm && callbacks.confirm(resp); break; } callbacks.all && callbacks.all(resp); }); }; WeixinJSBridge.on('menu:share:timeline', function (argv) { if (callbacks.async && callbacks.ready) { window["_wx_loadedCb_"] = callbacks.dataLoaded || new Function(); if (window["_wx_loadedCb_"].toString().indexOf("_wx_loadedCb_") > 0) { window["_wx_loadedCb_"] = new Function(); } callbacks.dataLoaded = function (newData) { window["_wx_loadedCb_"](newData); shareTimeline(newData); }; callbacks.ready && callbacks.ready(argv); } else { callbacks.ready && callbacks.ready(argv); shareTimeline(data); } }); } /** * 發送給微信上的好友 */ function weixinSendAppMessage(data, callbacks) { callbacks = callbacks || {}; var sendAppMessage = function (theData) { WeixinJSBridge.invoke('sendAppMessage', { "appid": theData.appId ? theData.appId : '', "img_url": theData.imgUrl, "link": theData.link, "desc": theData.desc, "title": theData.title, "img_width": "120", "img_height": "120" }, function (resp) { switch (resp.err_msg) { case 'send_app_msg:cancel': callbacks.cancel && callbacks.cancel(resp); break; case 'send_app_msg:fail': callbacks.fail && callbacks.fail(resp); break; case 'send_app_msg:confirm': case 'send_app_msg:ok': callbacks.confirm && callbacks.confirm(resp); break; } callbacks.all && callbacks.all(resp); }); }; WeixinJSBridge.on('menu:share:appmessage', function (argv) { if (callbacks.async && callbacks.ready) { window["_wx_loadedCb_"] = callbacks.dataLoaded || new Function(); if (window["_wx_loadedCb_"].toString().indexOf("_wx_loadedCb_") > 0) { window["_wx_loadedCb_"] = new Function(); } callbacks.dataLoaded = function (newData) { window["_wx_loadedCb_"](newData); sendAppMessage(newData); }; callbacks.ready && callbacks.ready(argv); } else { callbacks.ready && callbacks.ready(argv); sendAppMessage(data); } }); } /** * 分享到騰訊微博 */ function weixinShareWeibo(data, callbacks) { callbacks = callbacks || {}; var shareWeibo = function (theData) { WeixinJSBridge.invoke('shareWeibo', { "content": theData.desc, "url": theData.link }, function (resp) { switch (resp.err_msg) { case 'share_weibo:cancel': callbacks.cancel && callbacks.cancel(resp); break; case 'share_weibo:fail': callbacks.fail && callbacks.fail(resp); break; case 'share_weibo:confirm': case 'share_weibo:ok': callbacks.confirm && callbacks.confirm(resp); break; } callbacks.all && callbacks.all(resp); }); }; WeixinJSBridge.on('menu:share:weibo', function (argv) { if (callbacks.async && callbacks.ready) { window["_wx_loadedCb_"] = callbacks.dataLoaded || new Function(); if (window["_wx_loadedCb_"].toString().indexOf("_wx_loadedCb_") > 0) { window["_wx_loadedCb_"] = new Function(); } callbacks.dataLoaded = function (newData) { window["_wx_loadedCb_"](newData); shareWeibo(newData); }; callbacks.ready && callbacks.ready(argv); } else { callbacks.ready && callbacks.ready(argv); shareWeibo(data); } }); } /** * 調起微信 Native 的圖片預覽組件。 * 參數不合法會直接導致微信客戶端 crash,務必做檢查。 */ function imagePreview(curSrc, srcList) { if (!curSrc || !srcList || srcList.length == 0) { return; } WeixinJSBridge.invoke('imagePreview', { 'current': curSrc, 'urls': srcList }); } /** 顯示右上角按鈕 */ function showOptionMenu() { WeixinJSBridge.call('showOptionMenu'); } /** 隱藏右上角按鈕 */ function hideOptionMenu() { WeixinJSBridge.call('hideOptionMenu'); } /** 顯示底部工具欄 */ function showToolbar() { WeixinJSBridge.call('showToolbar'); } /** 隱藏底部工具欄 */ function hideToolbar() { WeixinJSBridge.call('hideToolbar'); } /** * 取得網路類型: * network_type:wifi / edge / fail / wwan */ function getNetworkType(callback) { if (callback && typeof callback == 'function') { WeixinJSBridge.invoke('getNetworkType', {}, function (e) { callback(e.err_msg); }); } } /** 關閉當前微信公眾平台頁面 */ function closeWindow() { WeixinJSBridge.call("closeWindow"); } /** * 頁面加載完畢後執行 * WeixinApi.ready(function(Api){ ... }); */ function wxJsBridgeReady(readyCallback) { if (readyCallback && typeof readyCallback == 'function') { var Api = this; var wxReadyFunc = function () { readyCallback(Api); }; if (typeof window.WeixinJSBridge == "undefined") { if (document.addEventListener) { document.addEventListener('WeixinJSBridgeReady', wxReadyFunc, false); } else if (document.attachEvent) { document.attachEvent('WeixinJSBridgeReady', wxReadyFunc); document.attachEvent('onWeixinJSBridgeReady', wxReadyFunc); } } else { wxReadyFunc(); } } } return { version: "1.8", ready: wxJsBridgeReady, shareToTimeline: weixinShareTimeline, shareToWeibo: weixinShareWeibo, shareToFriend: weixinSendAppMessage, showOptionMenu: showOptionMenu, hideOptionMenu: hideOptionMenu, showToolbar: showToolbar, hideToolbar: hideToolbar, getNetworkType: getNetworkType, imagePreview: imagePreview, closeWindow: closeWindow }; })();
1. 必須等 Bridge 就緒。 微信的 JS-SDK 是透過 WeixinJSBridge 這個全域物件溝通的,而它在頁面載入後才存在。封裝裡的 ready() 就是為了解決這個時序問題——請務必把分享設定包在 ready 的回呼裡,否則會拿到 undefined。
2. 朋友圈的 desc 與 title 是對調的。 這段程式刻意把 title 餵給 desc、desc 餵給 title,這是微信 shareTimeline 介面的既有行為,不是筆誤。
3. async 模式的用途。 開啟 async: true 後,可以在使用者點選分享的那一刻才去請求分享內容(例如先呼叫後端取得最新的標題與封面),藉由 dataLoaded 回呼把資料補上。這是「分享出去的都是即時資料」的關鍵。
4. 這套寫法已被取代。 上述 WeixinJSBridge 屬於舊版內建分享介面,目前微信官方建議改用基於 wx.config 與 wx.updateAppMessageShareData/wx.updateTimelineShareData 的正式 JS-SDK,並由後端簽名。新專案請以官方最新文件為準;本文則適合作為理解底層溝通機制的參考。
本文已整理進《JavaScript 微信開發技巧匯總》,另有《微信小程序開發教程》可一併參考。