TNW-獲取微信公眾號的 access_token

簡介

TNW: TypeScript(The) + Node.js(Next) + WeChat 微信公眾號開發(fā)腳手架弊决,支持 http 模塊擴(kuò)展胳螟、支持任何 Node.js 的服務(wù)端框架(Express谨设、NestJS简烘、eggjs 等)

概述

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

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

1燕雁、建議公眾號開發(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í)公眾平臺后臺會保證在5分鐘內(nèi)胡岔,新老 access_token都可用法希,這保證了第三方業(yè)務(wù)的平滑過渡;

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

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

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

劃重點(diǎn):

  • 調(diào)用 access_token 接口需要在微信公眾平臺配置 IP 白名單
  • access_token 有效期為 7200 秒
  • 可以提前刷新 access_token ,此時(shí)公眾平臺后臺會保證在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)類會出現(xiàn)異常 無法調(diào)用類型缺少調(diào)用簽名的表達(dá)式 待解決

開源推薦

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市嗤栓,隨后出現(xiàn)的幾起案子冻河,更是在濱河造成了極大的恐慌,老刑警劉巖茉帅,帶你破解...
    沈念sama閱讀 218,858評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件叨叙,死亡現(xiàn)場離奇詭異,居然都是意外死亡堪澎,警方通過查閱死者的電腦和手機(jī)擂错,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來樱蛤,“玉大人钮呀,你說我怎么就攤上這事桃犬。” “怎么了行楞?”我有些...
    開封第一講書人閱讀 165,282評論 0 356
  • 文/不壞的土叔 我叫張陵攒暇,是天一觀的道長。 經(jīng)常有香客問我子房,道長形用,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,842評論 1 295
  • 正文 為了忘掉前任证杭,我火速辦了婚禮田度,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘解愤。我一直安慰自己镇饺,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,857評論 6 392
  • 文/花漫 我一把揭開白布送讲。 她就那樣靜靜地躺著奸笤,像睡著了一般。 火紅的嫁衣襯著肌膚如雪哼鬓。 梳的紋絲不亂的頭發(fā)上监右,一...
    開封第一講書人閱讀 51,679評論 1 305
  • 那天,我揣著相機(jī)與錄音异希,去河邊找鬼健盒。 笑死,一個(gè)胖子當(dāng)著我的面吹牛称簿,可吹牛的內(nèi)容都是我干的扣癣。 我是一名探鬼主播,決...
    沈念sama閱讀 40,406評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼憨降,長吁一口氣:“原來是場噩夢啊……” “哼父虑!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起券册,我...
    開封第一講書人閱讀 39,311評論 0 276
  • 序言:老撾萬榮一對情侶失蹤频轿,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后烁焙,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體航邢,經(jīng)...
    沈念sama閱讀 45,767評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年骄蝇,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了膳殷。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,090評論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖赚窃,靈堂內(nèi)的尸體忽然破棺而出册招,到底是詐尸還是另有隱情,我是刑警寧澤勒极,帶...
    沈念sama閱讀 35,785評論 5 346
  • 正文 年R本政府宣布是掰,位于F島的核電站,受9級特大地震影響辱匿,放射性物質(zhì)發(fā)生泄漏键痛。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,420評論 3 331
  • 文/蒙蒙 一匾七、第九天 我趴在偏房一處隱蔽的房頂上張望絮短。 院中可真熱鬧,春花似錦昨忆、人聲如沸丁频。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽席里。三九已至,卻和暖如春痢缎,著一層夾襖步出監(jiān)牢的瞬間胁勺,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評論 1 271
  • 我被黑心中介騙來泰國打工独旷, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人寥裂。 一個(gè)月前我還...
    沈念sama閱讀 48,298評論 3 372
  • 正文 我出身青樓嵌洼,卻偏偏與公主長得像,于是被迫代替她去往敵國和親封恰。 傳聞我的和親對象是個(gè)殘疾皇子麻养,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,033評論 2 355

推薦閱讀更多精彩內(nèi)容