微信開發如何保證access_token/jsapi_ticket長期有效
- 2019 年 12 月 6 日
- 筆記
為了使第三方開發者能夠為用戶提供更多更有價值的個性化服務,微信公眾平台開放了許多接口,包括自定義菜單接口、客服接口、獲取用戶信息接口、用戶分組接口、群發接口等,開發者在調用這些接口時,都需要傳入一個相同的參數access_token,它是公眾賬號的全局唯一票據,它是接口訪問憑證。
access_token的有效期是7200秒(兩小時),在有效期內,可以一直使用,只有當access_token過期時,才需要再次調用接口獲取access_token。在理想情況下,一個7×24小時運行的系統,每天只需要獲取12次access_token,即每2小時獲取一次。如果在有效期內,再次獲取access_token,那麼上一次獲取的access_token將失效。
目前,獲取access_token接口的調用頻率限制為2000次/天,如果每次發送客服消息、獲取用戶信息、群發消息之前都要先調用獲取access_token接口得到接口訪問憑證,這顯然是不合理的,一方面會更耗時(多了一次接口調用操作),另一方面2000次/天的調用限制恐怕也不夠用。因此,在實際應用中,我們需要將獲取到的access_token存儲起來,然後定期調用access_token接口更新它,以保證隨時取出的access_token都是有效的。
1、如何定時獲取access_token? 在Java中,如果要定時執行某項任務,需要用到java.util.Timer類,對於喜歡使用框架的朋友,可以採用開源的任務調度框架quartz,spring框架也支持quartz。除此這外,還有一種方法就是啟動一個線程,在線程的run()方法中寫一個死循環,然後使用Thread.sleep()來保證線程定時執行某項任務。
2、將access_token保存在哪? 對於access_token的存儲,可以考慮存儲在文件、數據庫或內存中。具體採用哪種存儲方式,需要根據項目實際情況而定。如果只有一台服務器,直接將access_token存儲在內存中是最簡便有效的方式。 在本文中,筆者將演示的定期獲取並存儲access_token的流程為:Web服務器啟動時就加載一個Servlet,在Servlet的init()方法中啟動一個線程,在線程的run()方法中通過死循環+Thread.sleep()的方式定期獲取access_token,然後將獲取到的access_token保存在public static修飾的變量中。 在工程中創建一個InitServlet類,該類的代碼如下:
import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * 初始化servlet * 用 TokenThread.token 來得到接口訪問憑證access_toke */ public class InitServlet extends HttpServlet { private static final long serialVersionUID = 1L; private static Logger log = LoggerFactory.getLogger(InitServlet.class); public void init() throws ServletException { // 獲取web.xml中配置的參數 TokenThread.appid = Wx_appId; TokenThread.appsecret = Wx_appsecret; log.info("微信appid:{}", TokenThread.appid); log.info("微信appsecret:{}", TokenThread.appsecret); // 未配置appid、appsecret時給出提示 if ("".equals(TokenThread.appid) || "".equals(TokenThread.appsecret)) { log.error("appid 或 appsecret 配置為空,請仔細核對!"); } else { // 啟動定時獲取access_token的線程 new Thread(new TokenThread()).start(); } } }
從上面的代碼可以看出,InitServlet類只重寫了init()方法,並沒有重寫doGet()和doPost()兩個方法,因為我們並不打算讓InitServlet來處理訪問請求。init()方法的實現也比較簡單,先獲取在web.xml中配置的參數appid和appsecret,再啟動線程TokenThread定時獲取access_token。 InitServlet在web.xml中的配置添加如下:
<!-- access token緩存 --> <servlet> <servlet-name>initServlet</servlet-name> <servlet-class>com.nit.support.utils.wechat.InitServlet</servlet-class> <load-on-startup>0</load-on-startup> </servlet>
InitServlet在web.xml中的配置與普通Servlet的配置有幾點區別:1)通過配置<init-param>向Servlet中傳入參數;2)通過配置<load-on-startup>使得Web服務器啟動時就加載該Servlet;3)沒有配置<servlet-mapping>,因為InitServlet並不對外提供訪問。 TokenThread的源代碼如下:
import java.util.concurrent.ConcurrentHashMap; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.test.utils.wechat.pojo.Token; /** * 定時獲取微信access_token的線程 * 用 TokenThread.token 來得到接口訪問憑證access_toke */ public class TokenThread implements Runnable { private static Logger log = LoggerFactory.getLogger(TokenThread.class); // 第三方用戶唯一憑證 public static String appid = ""; // 第三方用戶唯一憑證密鑰 public static String appsecret = ""; // token public static Token accessToken = null; // jsapi_ticket public static String jsapi_ticket = null; public static ConcurrentHashMap<String, Token> token = new ConcurrentHashMap<>(); public static ConcurrentHashMap<String, String> ticket = new ConcurrentHashMap<>(); public void run() { while (true) { try { accessToken = CommonUtil.getToken(appid, appsecret); token.put(appid, accessToken); if (null != accessToken) { log.info("獲取access_token成功,有效時長{}秒 token:{}", accessToken.getExpiresIn(), accessToken.getAccessToken()); jsapi_ticket = CommonUtil.getJsApiTicket(accessToken.getAccessToken()); ticket.put(appid, jsapi_ticket); if(null != jsapi_ticket) { log.info("獲取jsapi_ticket成功, jsapi_ticket:{}", jsapi_ticket); // 休眠7000秒 Thread.sleep((accessToken.getExpiresIn() - 200) * 1000); //Thread.sleep(60 * 1000);//測試休眠1分鐘 } else{ // 如果jsapi_ticket為null,60秒後再獲取 Thread.sleep(60 * 1000); } } else { // 如果access_token為null,60秒後再獲取 Thread.sleep(60 * 1000); } } catch (InterruptedException e) { try { Thread.sleep(60 * 1000); } catch (InterruptedException e1) { log.error("{}", e1); } log.error("{}", e); } } } }
代碼通過while(true){}構造了一個死循環(永久執行);調用公眾平台接口獲取access_token;讓線程休眠7000秒再運行,即每隔7000秒獲取一次access_token,保證access_token永不失效。在項目中的其他類,可以通過調用 TokenThread.accessToken.getToken() 來得到接口訪問憑證access_token。