簡介
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á)式 待解決
開源推薦
-
TNW
微信公眾號開發(fā)腳手架:https://gitee.com/javen205/TNW -
IJPay
讓支付觸手可及:https://gitee.com/javen205/IJPay - SpringBoot 微服務(wù)高效開發(fā)
mica
工具集:https://gitee.com/596392912/mica -
Avue
一款基于 vue 可配置化的神奇框架:https://gitee.com/smallweigit/avue -
pig
宇宙最強(qiáng)微服務(wù)(架構(gòu)師必備):https://gitee.com/log4j/pig -
SpringBlade
完整的線上解決方案(企業(yè)開發(fā)必備):https://gitee.com/smallc/SpringBlade