TNW-微信公眾號中如何使用JSSDK

Javen205發表於2019-05-07

簡介

TNW: TypeScript(The) + Node.js(Next) + WeChat 微信公眾號開發腳手架,支援任何 Node.js 的服務端框架(Express、Nest、egg 等)

介面許可權以及文件

公眾號介面許可權說明

微信 JS-SDK 說明文件

JSSDK使用步驟

步驟一:繫結域名

正式號:登入微信公眾平臺進入 公眾號設定功能設定 裡填寫 JS介面安全域名

測試號:進入微信公眾帳號測試號申請系統 找到 JS介面安全域名 點選 修改

步驟二:引入JS檔案

在需要呼叫JS介面的頁面引入如下JS檔案:res2.wx.qq.com/open/js/jwe… (支援https)

步驟三:通過config介面注入許可權驗證配置

wx.config({
        debug: true,
        appId: '{{ appId }}',
        timestamp: '{{ timestamp }}',
        nonceStr: '{{ nonceStr }}',
        signature: '{{ signature }}',
        jsApiList: [
            'checkJsApi',
            '...省略其他'
        ]
    });
複製程式碼

TNW 中籤名實現

簽名演算法見 官方文件附錄1

特別注意: url 必須為頁面完整的URL包括引數

	@Get('jssdk')
  @Render('jssdk.hbs')
  async jssdk(@Req() request: Request, @Res() response: Response) {
    let appId = ApiConfigKit.getApiConfig.getAppId;
    let timestamp = new Date().getTime() / 1000;
    let nonceStr = uuid.v1();
    let url = "http://xxxx/jssdk?....";//填寫完整頁面的URL包括引數
    // 生成簽名
    let signature = await WeChat.jssdkSignature(nonceStr, timestamp, url);
    return {
      appId: appId,
      timestamp: timestamp,
      nonceStr: nonceStr,
      signature: signature
    };
  }
複製程式碼

步驟四:通過ready介面處理成功驗證

wx.ready(function(){
// config 資訊驗證後會執行 ready 方法,所有介面呼叫都必須在 config 介面獲得結果之後,config 是一個客戶端的非同步操作,所以如果需要在頁面載入時就呼叫相關介面,則須把相關介面放在 ready 函式中呼叫來確保正確執行。對於使用者觸發時才呼叫的介面,則可以直接呼叫,不需要放在 ready 函式中。
});
複製程式碼

步驟五:通過error介面處理失敗驗證

wx.error(function(res){
// config 資訊驗證失敗會執行 error 函式,如簽名過期導致驗證失敗,具體錯誤資訊可以開啟 config 的 debug 模式檢視,也可以在返回的 res 引數中檢視,對於 SPA 可以在這裡更新簽名。
});
複製程式碼

JSSDK 案例

所有JS介面列表見 官方文件附錄2

特別注意:

  1. 原有的 wx.onMenuShareTimeline、wx.onMenuShareAppMessage、wx.onMenuShareQQ、wx.onMenuShareQZone 介面,即將廢棄。請儘快遷移使用客戶端 6.7.2 及 JSSDK 1.4.0 以上版本支援的 wx.updateAppMessageShareData、updateTimelineShareData 介面。
  2. 分享介面中的 link 連結必須 JS 介面安全域名下的連結
  3. 公眾號微信支付後面再詳細介紹
<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8">
    <title>TNW 微信公眾號開發腳手架</title>
    <meta charset="utf-8">
    <meta http-equiv="pragma" content="no-cache">
    <meta http-equiv="cache-control" content="no-cache">
    <meta http-equiv="expires" content="0">
    <meta http-equiv="keywords" content="tnw,nodejs,微信公眾號開發">
    <meta http-equiv="description" content="tnw 微信公眾號開發腳手架,可整合到任何 Node.js MVC後端框架中">
    <meta name="viewport"
        content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
    <link rel="stylesheet" href="https://www.weixinsxy.com/jssdk/css/style.css">

</head>

<body>
    <div class="wxapi_container">
        <div class="wxapi_index_container">
            <ul class="label_box lbox_close wxapi_index_list">
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-basic">基礎介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-share">分享介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-image">影像介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-voice">音訊介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-smart">智慧介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-device">裝置資訊介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-location">地理位置介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-webview">介面操作介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-scan">微信掃一掃介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-shopping">微信小店介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-card">微信卡券介面</a></li>
                <li class="label_item wxapi_index_item"><a class="label_inner" href="#menu-pay">微信支付介面</a></li>
            </ul>
        </div>
        <div class="lbox_close wxapi_form">
            <h3 id="menu-basic">基礎介面</h3>
            <span class="desc">判斷當前客戶端是否支援指定JS介面</span>
            <button class="btn btn_primary" id="checkJsApi">checkJsApi</button>

            <h3 id="menu-share">分享介面</h3>
            <span class="desc">“分享給朋友”及“分享到QQ”</span>
            <button class="btn btn_primary" id="updateAppMessageShareData">updateAppMessageShareData</button>
            <span class="desc">“分享到朋友圈”及“分享到QQ空間”</span>
            <button class="btn btn_primary" id="updateTimelineShareData">updateTimelineShareData</button>
            <span class="desc">分享到騰訊微博</span>
            <button class="btn btn_primary" id="onMenuShareWeibo">onMenuShareWeibo</button>

            <h3 id="menu-image">影像介面</h3>
            <span class="desc">拍照或從手機相簿中選圖介面</span>
            <button class="btn btn_primary" id="chooseImage">chooseImage</button>
            <span class="desc">預覽圖片介面</span>
            <button class="btn btn_primary" id="previewImage">previewImage</button>
            <span class="desc">上傳圖片介面</span>
            <button class="btn btn_primary" id="uploadImage">uploadImage</button>
            <span class="desc">下載圖片介面</span>
            <button class="btn btn_primary" id="downloadImage">downloadImage</button>

            <h3 id="menu-voice">音訊介面</h3>
            <span class="desc">開始錄音介面</span>
            <button class="btn btn_primary" id="startRecord">startRecord</button>
            <span class="desc">停止錄音介面</span>
            <button class="btn btn_primary" id="stopRecord">stopRecord</button>
            <span class="desc">播放語音介面</span>
            <button class="btn btn_primary" id="playVoice">playVoice</button>
            <span class="desc">暫停播放介面</span>
            <button class="btn btn_primary" id="pauseVoice">pauseVoice</button>
            <span class="desc">停止播放介面</span>
            <button class="btn btn_primary" id="stopVoice">stopVoice</button>
            <span class="desc">上傳語音介面</span>
            <button class="btn btn_primary" id="uploadVoice">uploadVoice</button>
            <span class="desc">下載語音介面</span>
            <button class="btn btn_primary" id="downloadVoice">downloadVoice</button>

            <h3 id="menu-smart">智慧介面</h3>
            <span class="desc">識別音訊並返回識別結果介面</span>
            <button class="btn btn_primary" id="translateVoice">translateVoice</button>

            <h3 id="menu-device">裝置資訊介面</h3>
            <span class="desc">獲取網路狀態介面</span>
            <button class="btn btn_primary" id="getNetworkType">getNetworkType</button>

            <h3 id="menu-location">地理位置介面</h3>
            <span class="desc">使用微信內建地圖檢視位置介面</span>
            <button class="btn btn_primary" id="openLocation">openLocation</button>
            <span class="desc">獲取地理位置介面</span>
            <button class="btn btn_primary" id="getLocation">getLocation</button>

            <h3 id="menu-webview">介面操作介面</h3>
            <span class="desc">隱藏右上角選單介面</span>
            <button class="btn btn_primary" id="hideOptionMenu">hideOptionMenu</button>
            <span class="desc">顯示右上角選單介面</span>
            <button class="btn btn_primary" id="showOptionMenu">showOptionMenu</button>
            <span class="desc">關閉當前網頁視窗介面</span>
            <button class="btn btn_primary" id="closeWindow">closeWindow</button>
            <span class="desc">批量隱藏功能按鈕介面</span>
            <button class="btn btn_primary" id="hideMenuItems">hideMenuItems</button>
            <span class="desc">批量顯示功能按鈕介面</span>
            <button class="btn btn_primary" id="showMenuItems">showMenuItems</button>
            <span class="desc">隱藏所有非基礎按鈕介面</span>
            <button class="btn btn_primary" id="hideAllNonBaseMenuItem">hideAllNonBaseMenuItem</button>
            <span class="desc">顯示所有功能按鈕介面</span>
            <button class="btn btn_primary" id="showAllNonBaseMenuItem">showAllNonBaseMenuItem</button>

            <h3 id="menu-scan">微信掃一掃</h3>
            <span class="desc">調起微信掃一掃介面</span>
            <button class="btn btn_primary" id="scanQRCode0">scanQRCode(微信處理結果)</button>
            <button class="btn btn_primary" id="scanQRCode1">scanQRCode(直接返回結果)</button>
        </div>
    </div>
</body>
<script type="text/javascript" src="http://res2.wx.qq.com/open/js/jweixin-1.4.0.js"></script>
<script type="text/javascript">
    wx.config({
        debug: true,//開啟debug模式 正式環境設定為 false
        appId: '{{ appId }}',
        timestamp: '{{ timestamp }}',
        nonceStr: '{{ nonceStr }}',
        signature: '{{ signature }}',
        jsApiList: [
            'checkJsApi',
            'updateAppMessageShareData',
            'updateTimelineShareData',
            'onMenuShareWeibo',
            'hideMenuItems',
            'showMenuItems',
            'hideAllNonBaseMenuItem',
            'showAllNonBaseMenuItem',
            'translateVoice',
            'startRecord',
            'stopRecord',
            'onRecordEnd',
            'playVoice',
            'pauseVoice',
            'stopVoice',
            'uploadVoice',
            'downloadVoice',
            'chooseImage',
            'previewImage',
            'uploadImage',
            'downloadImage',
            'getNetworkType',
            'openLocation',
            'getLocation',
            'hideOptionMenu',
            'showOptionMenu',
            'closeWindow',
            'scanQRCode',
            'chooseWXPay',
            'openProductSpecificView',
            'addCard',
            'chooseCard',
            'openCard'
        ]
    });
    wx.ready(function () {
        // 1 判斷當前版本是否支援指定 JS 介面,支援批量判斷
        document.querySelector('#checkJsApi').onclick = function () {
            wx.checkJsApi({
                jsApiList: [
                    'getNetworkType',
                    'previewImage',
                    'onMenuShareTimeline',
                    'onMenuShareAppMessage',
                    'onMenuShareQQ',
                    'onMenuShareWeibo',
                ],
                success: function (res) {
                    alert(JSON.stringify(res));
                }
            });
        };

        // 2. 分享介面
        // 2.1 監聽“分享給朋友”,按鈕點選、自定義分享內容及分享結果介面
        // 自定義“分享給朋友”及“分享到QQ”按鈕的分享內容(1.4.0)
        document.querySelector('#updateAppMessageShareData').onclick = function () {
            wx.updateAppMessageShareData({
                title: 'TNW 微信公眾號開發腳手架',
                desc: '支援任何 Node.js 的 MVC 服務端框架',
                link: 'https://gitee.com/javen205/IJPay(此連結必須JS介面安全域名下的連結)',
                imgUrl: 'https://gitee.com/javen205/TNW/raw/master/docs/img/logo.png',
                trigger: function (res) {
                    alert('使用者點選傳送給朋友');
                },
                success: function (res) {
                    alert('已分享');
                },
                cancel: function (res) {
                    alert('已取消');
                },
                fail: function (res) {
                    alert(JSON.stringify(res));
                }
            });
            alert('已註冊獲取“傳送給朋友”狀態事件');
        };

        // 2.2 監聽“分享到朋友圈”按鈕點選、自定義分享內容及分享結果介面
        // 自定義“分享到朋友圈”及“分享到QQ空間”按鈕的分享內容(1.4.0)
        document.querySelector('#updateTimelineShareData').onclick = function () {
            wx.updateTimelineShareData({
                title: 'TNW 微信公眾號開發腳手架',
                desc: '支援任何 Node.js 的 MVC 服務端框架',
                link: 'https://gitee.com/javen205/TNW(此連結必須JS介面安全域名下的連結)',
                imgUrl: 'https://gitee.com/javen205/TNW/raw/master/docs/img/logo.png',
                trigger: function (res) {
                    alert('使用者點選分享到朋友圈');
                },
                success: function (res) {
                    alert('已分享');
                },
                cancel: function (res) {
                    alert('已取消');
                },
                fail: function (res) {
                    alert(JSON.stringify(res));
                }
            });
            alert('已註冊獲取“分享到朋友圈”狀態事件');
        };
        // 2.3 監聽“分享到微博”按鈕點選、自定義分享內容及分享結果介面
        document.querySelector('#onMenuShareWeibo').onclick = function () {
            wx.onMenuShareWeibo({
                title: 'TNW 微信公眾號開發腳手架',
                desc: '支援任何 Node.js 的 MVC 服務端框架',
                link: '此連結必須JS介面安全域名下的連結,
                imgUrl: 'https://gitee.com/javen205/TNW/raw/master/docs/img/logo.png',
                trigger: function (res) {
                    alert('使用者點選分享到微博');
                },
                complete: function (res) {
                    alert(JSON.stringify(res));
                },
                success: function (res) {
                    alert('已分享');
                },
                cancel: function (res) {
                    alert('已取消');
                },
                fail: function (res) {
                    alert(JSON.stringify(res));
                }
            });
            alert('已註冊獲取“分享到微博”狀態事件');
        };

        // 3 智慧介面
        var voice = {
            localId: '',
            serverId: ''
        };
        // 3.1 識別音訊並返回識別結果
        document.querySelector('#translateVoice').onclick = function () {
            if (voice.localId == '') {
                alert('請先使用 startRecord 介面錄製一段聲音');
                return;
            }
            wx.translateVoice({
                localId: voice.localId,
                complete: function (res) {
                    if (res.hasOwnProperty('translateResult')) {
                        alert('識別結果:' + res.translateResult);
                    } else {
                        alert('無法識別');
                    }
                }
            });
        };

        // 4 音訊介面
        // 4.2 開始錄音
        document.querySelector('#startRecord').onclick = function () {
            wx.startRecord({
                cancel: function () {
                    alert('使用者拒絕授權錄音');
                }
            });
        };

        // 4.3 停止錄音
        document.querySelector('#stopRecord').onclick = function () {
            wx.stopRecord({
                success: function (res) {
                    voice.localId = res.localId;
                },
                fail: function (res) {
                    alert(JSON.stringify(res));
                }
            });
        };

        // 4.4 監聽錄音自動停止
        wx.onVoiceRecordEnd({
            complete: function (res) {
                voice.localId = res.localId;
                alert('錄音時間已超過一分鐘');
            }
        });

        // 4.5 播放音訊
        document.querySelector('#playVoice').onclick = function () {
            if (voice.localId == '') {
                alert('請先使用 startRecord 介面錄製一段聲音');
                return;
            }
            wx.playVoice({
                localId: voice.localId
            });
        };

        // 4.6 暫停播放音訊
        document.querySelector('#pauseVoice').onclick = function () {
            wx.pauseVoice({
                localId: voice.localId
            });
        };

        // 4.7 停止播放音訊
        document.querySelector('#stopVoice').onclick = function () {
            wx.stopVoice({
                localId: voice.localId
            });
        };

        // 4.8 監聽錄音播放停止
        wx.onVoicePlayEnd({
            complete: function (res) {
                alert('錄音(' + res.localId + ')播放結束');
            }
        });

        // 4.8 上傳語音
        document.querySelector('#uploadVoice').onclick = function () {
            if (voice.localId == '') {
                alert('請先使用 startRecord 介面錄製一段聲音');
                return;
            }
            wx.uploadVoice({
                localId: voice.localId,
                success: function (res) {
                    alert('上傳語音成功,serverId 為' + res.serverId);
                    voice.serverId = res.serverId;
                }
            });
        };

        // 4.9 下載語音
        document.querySelector('#downloadVoice').onclick = function () {
            if (voice.serverId == '') {
                alert('請先使用 uploadVoice 上傳聲音');
                return;
            }
            wx.downloadVoice({
                serverId: voice.serverId,
                success: function (res) {
                    alert('下載語音成功,localId 為' + res.localId);
                    voice.localId = res.localId;
                }
            });
        };

        // 5 圖片介面
        // 5.1 拍照、本地選圖
        var images = {
            localId: [],
            serverId: []
        };
        document.querySelector('#chooseImage').onclick = function () {
            wx.chooseImage({
                success: function (res) {
                    images.localId = res.localIds;
                    alert('已選擇 ' + res.localIds.length + ' 張圖片');
                }
            });
        };

        // 5.2 圖片預覽
        document.querySelector('#previewImage').onclick = function () {
            wx.previewImage({
                current: 'https://gitee.com/javen205/TNW/raw/master/docs/img/logo.png',
                urls: [
                    'https://gitee.com/javen205/IJPay/raw/master/assets/img/IJPay-t.png',
                    'https://gitee.com/javen205/TNW/raw/master/docs/img/logo.png'
                ]
            });
        };

        // 5.3 上傳圖片
        document.querySelector('#uploadImage').onclick = function () {
            if (images.localId.length == 0) {
                alert('請先使用 chooseImage 介面選擇圖片');
                return;
            }
            var i = 0, length = images.localId.length;
            images.serverId = [];
            function upload() {
                wx.uploadImage({
                    localId: images.localId[i],
                    success: function (res) {
                        alert(JSON.stringify(res));
                        i++;
                        alert('已上傳:' + i + '/' + length);
                        images.serverId.push(res.serverId);
                        if (i < length) {
                            upload();
                        }
                    },
                    fail: function (res) {
                        alert(JSON.stringify(res));
                    }
                });
            }
            upload();
        };

        // 5.4 下載圖片
        document.querySelector('#downloadImage').onclick = function () {
            if (images.serverId.length === 0) {
                alert('請先使用 uploadImage 上傳圖片');
                return;
            }
            var i = 0, length = images.serverId.length;
            images.localId = [];
            function download() {
                wx.downloadImage({
                    serverId: images.serverId[i],
                    success: function (res) {
                        alert(JSON.stringify(res));
                        i++;
                        alert('已下載:' + i + '/' + length);
                        images.localId.push(res.localId);
                        if (i < length) {
                            download();
                        }
                    }
                });
            }
            download();
        };

        // 6 裝置資訊介面
        // 6.1 獲取當前網路狀態
        document.querySelector('#getNetworkType').onclick = function () {
            wx.getNetworkType({
                success: function (res) {
                    alert(res.networkType);
                },
                fail: function (res) {
                    alert(JSON.stringify(res));
                }
            });
        };

        // 7 地理位置介面
        // 7.1 檢視地理位置
        document.querySelector('#openLocation').onclick = function () {
            wx.openLocation({
                latitude: 23.099994,
                longitude: 113.324520,
                name: 'TIT 創意園',
                address: '廣州市海珠區新港中路 397 號',
                scale: 14,
                infoUrl: 'http://weixin.qq.com'
            });
        };

        // 7.2 獲取當前地理位置
        document.querySelector('#getLocation').onclick = function () {
            wx.getLocation({
                success: function (res) {
                    alert(JSON.stringify(res));
                },
                cancel: function (res) {
                    alert('使用者拒絕授權獲取地理位置');
                }
            });
        };

        // 8 介面操作介面
        // 8.1 隱藏右上角選單
        document.querySelector('#hideOptionMenu').onclick = function () {
            wx.hideOptionMenu();
        };

        // 8.2 顯示右上角選單
        document.querySelector('#showOptionMenu').onclick = function () {
            wx.showOptionMenu();
        };

        // 8.3 批量隱藏選單項
        document.querySelector('#hideMenuItems').onclick = function () {
            wx.hideMenuItems({
                menuList: [
                    'menuItem:readMode', // 閱讀模式
                    'menuItem:share:timeline', // 分享到朋友圈
                    'menuItem:copyUrl' // 複製連結
                ],
                success: function (res) {
                    alert('已隱藏“閱讀模式”,“分享到朋友圈”,“複製連結”等按鈕');
                },
                fail: function (res) {
                    alert(JSON.stringify(res));
                }
            });
        };

        // 8.4 批量顯示選單項
        document.querySelector('#showMenuItems').onclick = function () {
            wx.showMenuItems({
                menuList: [
                    'menuItem:readMode', // 閱讀模式
                    'menuItem:share:timeline', // 分享到朋友圈
                    'menuItem:copyUrl' // 複製連結
                ],
                success: function (res) {
                    alert('已顯示“閱讀模式”,“分享到朋友圈”,“複製連結”等按鈕');
                },
                fail: function (res) {
                    alert(JSON.stringify(res));
                }
            });
        };

        // 8.5 隱藏所有非基本選單項
        document.querySelector('#hideAllNonBaseMenuItem').onclick = function () {
            wx.hideAllNonBaseMenuItem({
                success: function () {
                    alert('已隱藏所有非基本選單項');
                }
            });
        };

        // 8.6 顯示所有被隱藏的非基本選單項
        document.querySelector('#showAllNonBaseMenuItem').onclick = function () {
            wx.showAllNonBaseMenuItem({
                success: function () {
                    alert('已顯示所有非基本選單項');
                }
            });
        };

        // 8.7 關閉當前視窗
        document.querySelector('#closeWindow').onclick = function () {
            wx.closeWindow();
        };

        // 9 微信原生介面
        // 9.1.1 掃描二維碼並返回結果
        document.querySelector('#scanQRCode0').onclick = function () {
            wx.scanQRCode({
                desc: 'scanQRCode desc'
            });
        };
        // 9.1.2 掃描二維碼並返回結果
        document.querySelector('#scanQRCode1').onclick = function () {
            wx.scanQRCode({
                needResult: 1,
                desc: 'scanQRCode desc',
                success: function (res) {

                    alert(JSON.stringify(res));
                }
            });
        };

        var shareData = typeof (shareData) === 'undefined' ? {
            title: 'TNW 微信公眾號開發腳手架',
            desc: '支援任何 Node.jsMVC 服務端框架',
            link: 'https://gitee.com/javen205/TNW',
            imgUrl: 'https://gitee.com/javen205/TNW/raw/master/docs/img/logo.png',
        } : shareData;

        wx.onMenuShareAppMessage(shareData);
        wx.onMenuShareTimeline(shareData);
    });

    wx.error(function (res) {
        alert(res.errMsg);
    });
</script>

</html>
複製程式碼

Java 版本

微信公眾號開發之如何使用JSSDK

開源推薦

相關文章