TNW-獲取微信公眾號(hào)的 access_token

簡介

TNW: TypeScript(The) + Node.js(Next) + WeChat 微信公眾號(hào)開發(fā)腳手架，支持 http 模塊擴(kuò)展、支持任何 Node.js 的服務(wù)端框架(Express、NestJS、eggjs 等)

概述

access_token 是公眾號(hào)的全局唯一接口調(diào)用憑據(jù)，公眾號(hào)調(diào)用各接口時(shí)都需使用 access_token。開發(fā)者需要進(jìn)行妥善保存。access_token 的存儲(chǔ)至少要保留 512 個(gè)字符空間。access_token 的有效期目前為2個(gè)小時(shí)，需定時(shí)刷新，重復(fù)獲取將導(dǎo)致上次獲取的 access_token 失效。

公眾平臺(tái)的API調(diào)用所需的 access_token 的使用及生成方式說明：

1、建議公眾號(hào)開發(fā)者使用中控服務(wù)器統(tǒng)一獲取和刷新 access_token，其他業(yè)務(wù)邏輯服務(wù)器所使用的access_token 均來自于該中控服務(wù)器，不應(yīng)該各自去刷新，否則容易造成沖突，導(dǎo)致 access_token 覆蓋而影響業(yè)務(wù)；

2、目前 access_token 的有效期通過返回的 expire_in 來傳達(dá)，目前是 7200 秒之內(nèi)的值。中控服務(wù)器需要根據(jù)這個(gè)有效時(shí)間提前去刷新新 access_token。在刷新過程中，中控服務(wù)器可對外繼續(xù)輸出的老 access_token，此時(shí)公眾平臺(tái)后臺(tái)會(huì)保證在5分鐘內(nèi)，新老 access_token都可用，這保證了第三方業(yè)務(wù)的平滑過渡；

3、access_token 的有效時(shí)間可能會(huì)在未來有調(diào)整，所以中控服務(wù)器不僅需要內(nèi)部定時(shí)主動(dòng)刷新，還需要提供被動(dòng)刷新 access_token 的接口，這樣便于業(yè)務(wù)服務(wù)器在API調(diào)用獲知 access_token 已超時(shí)的情況下，可以觸發(fā)access_token 的刷新流程。

公眾號(hào)和小程序均可以使用 AppId 和 AppSecret 調(diào)用本接口來獲取 access_token。AppId 和 AppSecret 可在“微信公眾平臺(tái)-開發(fā)-基本配置”頁中獲得（需要已經(jīng)成為開發(fā)者，且?guī)ぬ?hào)沒有異常狀態(tài)）。調(diào)用接口時(shí)，請登錄“微信公眾平臺(tái)-開發(fā)-基本配置”提前將服務(wù)器 IP 地址添加到 IP 白名單中，否則將無法調(diào)用成功。小程序無需配置IP白名單。

以上內(nèi)容來自 官方文檔

劃重點(diǎn)：

  • 調(diào)用 access_token 接口需要在微信公眾平臺(tái)配置 IP 白名單
  • access_token 有效期為 7200 秒
  • 可以提前刷新 access_token ，此時(shí)公眾平臺(tái)后臺(tái)會(huì)保證在5分鐘內(nèi)新老 access_token 都可用

TNW 中獲取 access_token

export class AccessTokenApi {
    private static url: string = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=%s&secret=%s";
    /**
     * 獲取 acces_token 
     * 1、先從緩存中獲取，如果可用就直接返回
     * 2、如果緩存中的已過期就調(diào)用刷新接口來獲取新的 acces_token 
     */
    public static async getAccessToken() {
        let ac: ApiConfig = ApiConfigKit.getApiConfig;
        let accessToken: AccessToken = this.getAvailableAccessToken(ac);
        if (accessToken && accessToken.isAvailable) {
            if(ApiConfigKit.isDevMode) console.log("緩存中的 accesstoken");
            return accessToken;
        }
        if(ApiConfigKit.isDevMode) console.log("刷新 accesstoken");
        return await this.refreshAccessToken(ac);;
    }
    /**
     * 通過 appId 從緩存中獲取 acces_token
     * @param apiConfig 
     */
    private static getAvailableAccessToken(apiConfig: ApiConfig): AccessToken {
        let result!: AccessToken;
        let accessTokenCache: IAccessTokenCache = ApiConfigKit.getAccessTokenCache;
        let accessTokenJson: string = accessTokenCache.get(apiConfig.getAppId);
        if (accessTokenJson) {
            result = new AccessToken(accessTokenJson);
            if (result && result.isAvailable) {
                return result;
            }
        }
        return result;
    }

    /**
     * 獲取新的 acces_token 并設(shè)置緩存
     * @param apiConfig 
     */
    public static async refreshAccessToken(apiConfig: ApiConfig) {
        let url = util.format(this.url, apiConfig.getAppId, apiConfig.getAppScrect);
        let data = await HttpKit.getHttpDelegate.httpGet(url);
        if (data) {
            let accessToken: AccessToken = new AccessToken(data)
            let accessTokenCache: IAccessTokenCache = ApiConfigKit.getAccessTokenCache;
            accessTokenCache.set(apiConfig.getAppId, accessToken.getCacheJson);
            return accessToken;
        } else {
            return "獲取accessToken異常";
        }
    }
}

默認(rèn) access_token 緩存在內(nèi)存中，但這有一個(gè)缺點(diǎn)，當(dāng)應(yīng)用關(guān)閉后又得重新獲取。所以 TNW 中提供了設(shè)置緩存的擴(kuò)展。

緩存擴(kuò)展

access_token 緩存接口 IAccessTokenCache

export interface IAccessTokenCache {
    get(key: string): string;
    set(key: string, jsonValue: string): void;
    remove(key: string): void;
}

默認(rèn)實(shí)現(xiàn) DefaultAccessTokenCache

export class DefaultAccessTokenCache implements IAccessTokenCache {

    private map: Map<string, string> = new Map<string, string>();

    get(key: string): string {
        return this.map.get(key) || '';
    }

    set(key: string, jsonValue: string) {
        this.map.set(key, jsonValue);
    }

    remove(key: string) {
        this.map.delete(key);
    }
}

設(shè)置替換默認(rèn)緩存

DefaultAccessTokenCache 替換為你的實(shí)現(xiàn)類即可 比如：緩存至文件、Redis 等

ApiConfigKit.setAccessTokenCache(new DefaultAccessTokenCache());

遺留問題

直接傳入接口的實(shí)現(xiàn)類會(huì)出現(xiàn)異常 無法調(diào)用類型缺少調(diào)用簽名的表達(dá)式 待解決

開源推薦

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容