簡介
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 = 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 並設置緩存
* @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異常";
}
}
}
默認 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());
遺留問題
直接傳入接口的實現類會出現異常 無法調用類型缺少調用簽名的表達式 待解決
開源推薦
-
TNW
微信公衆號開發腳手架:https://gitee.com/javen205/TNW -
IJPay
讓支付觸手可及:https://gitee.com/javen205/IJPay - SpringBoot 微服務高效開發
mica
工具集:https://gitee.com/596392912/mica -
Avue
一款基於 vue 可配置化的神奇框架:https://gitee.com/smallweigit/avue -
pig
宇宙最強微服務(架構師必備):https://gitee.com/log4j/pig -
SpringBlade
完整的線上解決方案(企業開發必備):https://gitee.com/smallc/SpringBlade