TNW-獲取微信公眾號的 access_token

Javen205發表於2019-04-30
TNW

簡介

TNW: TypeScript(The) + Node.js(Next) + WeChat 微信公眾號開發腳手架，支援 http 模組擴充套件、支援任何 Node.js 的服務端框架(Express、NestJS、eggjs 等)

概述

access_token 是公眾號的全域性唯一介面呼叫憑據，公眾號呼叫各介面時都需使用 access_token。開發者需要進行妥善儲存。access_token 的儲存至少要保留 512 個字元空間。access_token 的有效期目前為2個小時，需定時重新整理，重複獲取將導致上次獲取的 access_token 失效。

公眾平臺的API呼叫所需的 access_token 的使用及生成方式說明：

1、建議公眾號開發者使用中控伺服器統一獲取和重新整理 access_token，其他業務邏輯伺服器所使用的access_token 均來自於該中控伺服器，不應該各自去重新整理，否則容易造成衝突，導致 access_token 覆蓋而影響業務；

2、目前 access_token 的有效期通過返回的 expire_in 來傳達，目前是 7200 秒之內的值。中控伺服器需要根據這個有效時間提前去重新整理新 access_token。在重新整理過程中，中控伺服器可對外繼續輸出的老 access_token，此時公眾平臺後臺會保證在5分鐘內，新老 access_token都可用，這保證了第三方業務的平滑過渡；

3、access_token 的有效時間可能會在未來有調整，所以中控伺服器不僅需要內部定時主動重新整理，還需要提供被動重新整理 access_token 的介面，這樣便於業務伺服器在API呼叫獲知 access_token 已超時的情況下，可以觸發access_token 的重新整理流程。

公眾號和小程式均可以使用 AppId 和 AppSecret 呼叫本介面來獲取 access_token。AppId 和 AppSecret 可在“微信公眾平臺-開發-基本配置”頁中獲得（需要已經成為開發者，且帳號沒有異常狀態）。**呼叫介面時，請登入“微信公眾平臺-開發-基本配置”提前將伺服器 IP 地址新增到 IP 白名單中，否則將無法呼叫成功。**小程式無需配置IP白名單。

以上內容來自 官方文件

劃重點：

  • 呼叫 access_token 介面需要在微信公眾平臺配置 IP 白名單
  • access_token 有效期為 7200 秒
  • 可以提前重新整理 access_token ，此時公眾平臺後臺會保證在5分鐘內新老 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、如果快取中的已過期就呼叫重新整理介面來獲取新的 acces_token 
     */
    public static async getAccessToken() {
        let ac: ApiConfig = ApiConfigKit.getApiConfig;
        let accessToken: AccessToken | undefined = this.getAvailableAccessToken(ac);
        if (accessToken) {
            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 | undefined {
        let result: AccessToken | undefined;
        let accessTokenCache: IAccessTokenCache = ApiConfigKit.getAccessTokenCache;
        let accessTokenJson: string = accessTokenCache.get(apiConfig.getAppId);
        if (accessTokenJson) {
            result = new AccessToken(accessTokenJson);
        }
        if (result && result.isAvailable()) {
            return result;
        } else {
            return undefined;
        }
    }

    /**
     * 獲取新的 acces_token 並設定快取
     * @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 {
            new Error("獲取accessToken異常");
        }
    }
}
複製程式碼

預設 access_token 快取在記憶體中，但這有一個缺點，當應用關閉後又得重新獲取。所以 TNW 中提供了設定快取的擴充套件。

快取擴充套件

access_token 快取介面 IAccessTokenCache

export interface IAccessTokenCache {
    get(key: string): string;
    set(key: string, jsonValue: string): void;
    remove(key: string): void;
}
複製程式碼

預設實現 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);
    }
}
複製程式碼

設定替換預設快取

DefaultAccessTokenCache 替換為你的實現類即可 比如：快取至檔案、Redis 等

ApiConfigKit.setAccessTokenCache(new DefaultAccessTokenCache());
複製程式碼

遺留問題

直接傳入介面的實現類會出現異常 無法呼叫型別缺少呼叫簽名的表示式 待解決

開源推薦

相關文章