为了使第三方开发者能够为用户提供更多更有价值的个性化服务,微信公众平台开放了许多接口,包括自定义菜单接口、客服接口、获取用户信息接口、用户分组接口、群发接口等,开发者在调用这些接口时,都需要传入一个相同的参数access_token,它是公众账号的全局唯一票据,它是接口访问凭证。
access_token的有效期是7200秒(两小时),在有效期内,可以一直使用,只有当access_token过期时,才需要再次调用接口获取access_token。在理想情况下,一个7x24小时运行的系统,每天只需要获取12次access_token,即每2小时获取一次。如果在有效期内,再次获取access_token,那么上一次获取的access_token将失效。
目前,获取access_token接口的调用频率限制为2000次/天,如果每次发送客服消息、获取用户信息、群发消息之前都要先调用获取access_token接口得到接口访问凭证,这显然是不合理的,一方面会更耗时(多了一次接口调用操作),另一方面2000次/天的调用限制恐怕也不够用。因此,在实际应用中,我们需要将获取到的access_token存储起来,然后定期调用access_token接口更新它,以保证随时取出的access_token都是有效的。
请注意:这不是一篇讲解如何调用接口获取access_token的文章,关于access_token的获取,请参考文章《微信公众帐号开发教程第14篇-自定义菜单的创建及菜单事件响应》
在动手前先来简单分析一下,我们要解决的无非是如下两个问题:
1、如何定时获取access_token?
在Java中,如果要定时执行某项任务,需要用到java.util.Timer类,对于喜欢使用框架的朋友,可以采用开源的任务调度框架quartz,spring框架也支持quartz。除此这外,还有一种方法就是启动一个线程,在线程的run()方法中写一个死循环,然后使用Thread.sleep()来保证线程定时执行某项任务。
2、将access_token保存在哪?
对于access_token的存储,可以考虑存储在文件、数据库或内存中。具体采用哪种存储方式,需要根据项目实际情况而定。如果只有一台服务器,直接将access_token存储在内存中是最简便有效的方式。
本文介绍3个存储示例,当然还有很多方法示例中更好的,根据实际情况来选择,灵活变通。也喜欢读者朋友将好的方法进行留言分享,我也会实际亲测以后专门写一篇文章来分享。
存储在本地资源Properties文件中
存储在redis内存中
使用Servlet定时获取
(1)存储在本地资源Properties文件中
存储:首先获取AccessToken对象——》将json串解析,然后在当前类下新建的Properties文件中保存——》pproperties中增加一个endDate字段,代表失效时间
获取:判断properties文件是否存在,不存在就获取并存储——》判断endDate时间是否大于当前时间,也就是过期,过期重新获取,不过期就调用token字段
AccessToken对象基类
package com.rapido.weixin.access.bean; /** * 微信通用接口凭证 * * @author X-rapido * @description */ public class AccessToken { private String token; // 获取到的凭证 private int expiresIn; // 凭证有效时间,单位:秒 public AccessToken(){} public AccessToken(String token, int expiresIn){ this.token = token; this.expiresIn = expiresIn; } // 省略getter和setter }
核心Service类
package com.rapido.weixin.access.service; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.net.URLDecoder; import java.util.Calendar; import java.util.Date; import java.util.Properties; import net.sf.json.JSONObject; import org.apache.log4j.Logger; import com.rapido.weixin.access.bean.AccessToken; import com.rapido.weixin.commons.WeCharConfig; import com.rapido.weixin.utils.HttpProxyUtil; /** * Token服务类 * @author X-rapido * @description 获取Token对象,将token对象临时保存在于当前class类文件同目录文件夹下 */ public class TokenServer { private static Logger logger = Logger.getLogger(TokenServer.class); private String path = TokenServer.class.getResource("TokenServer.class").getFile(); /** * 获取token对象 * @return */ public AccessToken getAccessToken(){ return getAccessToken(false); } /** * 获取Token对象,如果没有或已失效,就重新获取,否则就从服务器获取 * @param reReq 是否重新请求token,在token获取失败或token过期时候调用,默认为false * @return */ public AccessToken getAccessToken(boolean reReq){ AccessToken access_token = null; try { path = URLDecoder.decode(path.substring(0,path.lastIndexOf("/") + 1), "utf-8"); // 要转码才行 String filename = path + "access_token.properties"; File file = new File(filename); Properties property = new Properties(); if(reReq){ logger.info("重新获取AccessToken"); access_token = saveToken(filename); // 重新请求AccessToken对象并保存到文件 } if (!file.exists()) { // Token文件不存在也重新获取 access_token = saveToken(filename); // 重新请求AccessToken对象并保存到文件 }else { // 读取Tokean文件 FileInputStream in = new FileInputStream(filename); property.load(in); in.close(); // 关闭流 String token = property.getProperty("token"); int expiresIn = Integer.valueOf(property.getProperty("expiresIn")); long endDate = Long.valueOf(property.getProperty("endDate")); // 获取Token失效时间 long now = System.currentTimeMillis(); if (now >= endDate) { logger.info("Token失效,重新获取"); access_token = saveToken(filename); // 重新请求AccessToken对象并保存到文件 }else { access_token = new AccessToken(token, expiresIn); } } } catch (Exception e) { logger.error("获取AccessToken数据失败" + e.getMessage()); } return access_token; } /** * 保存AccessToken数据 * @param filename 文件路径 * @throws IOException */ private AccessToken saveToken(String filename) throws IOException { try { AccessToken accessToken = getAccessToken(WeCharConfig.app_id, WeCharConfig.app_secret); // 获取Token if (accessToken != null) { logger.info("Tokean文件路径:" + filename); Properties property = new Properties(); property.setProperty("token", accessToken.getToken()); property.setProperty("expiresIn", String.valueOf(accessToken.getExpiresIn())); // 额外加入2个时间 Calendar cd = Calendar.getInstance(); cd.add(Calendar.SECOND, accessToken.getExpiresIn()); // 当前时间增加7200秒 Date date=cd.getTime(); property.setProperty("startDate", String.valueOf(System.currentTimeMillis())); // 获取token时间 property.setProperty("endDate", String.valueOf(date.getTime())); // token失效时间 FileOutputStream os = new FileOutputStream(filename); property.store(os, "ACCESS_TOKEN"); os.close(); logger.info("Tokean文件保存成功"); return accessToken; } } catch (Exception e) { logger.error("保存AccessToken数据失败" + e.getMessage()); } return null; } /** * 获取服务器的accessToken, 默认生效2小时,GET方式,限200(次/天) * @param appid 凭证 * @param appsecret 密钥 * @return */ private AccessToken getAccessToken(String app_id, String app_secret) { AccessToken accessToken = null; try { String api_url = WeCharConfig.access_token_url.replace("{appid}", app_id).replace("{secret}", app_secret); String resStr = HttpProxyUtil.sendGet(api_url); JSONObject jsonObject = JSONObject.fromObject(resStr); if (jsonObject != null) { accessToken = new AccessToken(); accessToken.setToken(jsonObject.get("access_token").toString()); accessToken.setExpiresIn(jsonObject.getInt("expires_in")); } } catch (Exception e) { logger.error("获取服务器的accessToken失败 "+ e.getMessage()); } return accessToken; } public static void main(String[] args) { TokenServer tokenServer = new TokenServer(); AccessToken access_token = tokenServer.getAccessToken(); // 获取Tokean String token = access_token.getToken(); if (null != token) { System.out.println("token: " + token); } } }
(2)存储在redis内存中
示例代码查看下一篇文章:微信公众号开发教程第19篇——使用Spring+Redis方式保存access_token
(3)使用Servlet定时获取
定期获取并存储access_token的流程为:Web服务器启动时就加载一个Servlet,在Servlet的init()方法中启动一个线程,在线程的run()方法中通过死循环+Thread.sleep()的方式定期获取access_token,然后将获取到的access_token保存在public static修饰的变量中。
在工程中创建一个InitServlet类,该类的代码如下:
package org.liufeng.weixin.servlet; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import org.liufeng.weixin.thread.TokenThread; import org.liufeng.weixin.util.WeixinUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * 初始化servlet */ public class InitServlet extends HttpServlet { private static final long serialVersionUID = 1L; private static Logger log = LoggerFactory.getLogger(WeixinUtil.class); public void init() throws ServletException { // 获取web.xml中配置的参数 TokenThread.appid = getInitParameter("appid"); TokenThread.appsecret = getInitParameter("appsecret"); log.info("weixin api appid:{}", TokenThread.appid); log.info("weixin api appsecret:{}", TokenThread.appsecret); // 未配置appid、appsecret时给出提示 if ("".equals(TokenThread.appid) || "".equals(TokenThread.appsecret)) { log.error("appid and appsecret configuration error, please check carefully."); } else { // 启动定时获取access_token的线程 new Thread(new TokenThread()).start(); } } }
从上面的代码可以看出,InitServlet类只重写了init()方法,并没有重写doGet()和doPost()两个方法,因为我们并不打算让InitServlet来处理访问请求。init()方法的实现也比较简单,先获取在web.xml中配置的参数appid和appsecret,再启动线程TokenThread定时获取access_token。
InitServlet在web.xml中的配置如下:
<?xml version="1.0" encoding="UTF-8"?> <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> <servlet> <servlet-name>initServlet</servlet-name> <servlet-class> org.liufeng.weixin.servlet.InitServlet </servlet-class> <!-- 配置获取access_token所需参数appid和appsecret --> <init-param> <param-name>appid</param-name> <param-value>wx617a123bb8bc99cd</param-value> </init-param> <init-param> <param-name>appsecret</param-name> <param-value>4d82cbbbb08714c12345b62d7hn3dcb8</param-value> </init-param> <load-on-startup>0</load-on-startup> </servlet> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> </web-app>
InitServlet在web.xml中的配置与普通Servlet的配置有几点区别:
通过配置<init-param>向Servlet中传入参数;
通过配置<load-on-startup>使得Web服务器启动时就加载该Servlet;
没有配置<servlet-mapping>,因为InitServlet并不对外提供访问。
TokenThread的源代码如下:
package org.liufeng.weixin.thread; import org.liufeng.weixin.pojo.AccessToken; import org.liufeng.weixin.util.WeixinUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * 定时获取微信access_token的线程 */ public class TokenThread implements Runnable { private static Logger log = LoggerFactory.getLogger(TokenThread.class); public static String appid = ""; // 第三方用户唯一凭证 public static String appsecret = ""; // 第三方用户唯一凭证密钥 public static AccessToken accessToken = null; public void run() { while (true) { try { accessToken = WeixinUtil.getAccessToken(appid, appsecret); if (null != accessToken) { log.info("获取access_token成功,有效时长{}秒 token:{}", accessToken.getExpiresIn(), accessToken.getToken()); Thread.sleep((accessToken.getExpiresIn() - 200) * 1000); // 休眠7000秒 } else { Thread.sleep(60 * 1000); // 如果access_token为null,60秒后再获取 } } catch (InterruptedException e) { try { Thread.sleep(60 * 1000); } catch (InterruptedException e1) { log.error("{}", e1); } log.error("{}", e); } } } }
代码中的第23行通过while(true){}构造了一个死循环(永久执行);第25行调用公众平台接口获取access_token;第29行让线程休眠7000秒再运行,即每隔7000秒获取一次access_token,保证access_token永不失效。在项目中的其他类,可以通过调用 TokenThread.accessToken.getToken() 来得到接口访问凭证access_token。在本地部署运行该程序,Tomcat启动完成后就会在控制台显示如下日志:
[INFO ] weixin api appid:wx617a123bb8bc99cd [INFO ] weixin api appsecret:4d82cbbbb08714c12345b62d7hn3dcb8 [INFO ] 获取access_token成功,有效时长7200秒 token:sFopJ9lMmLl4u-ad61ojKpS0TolhN2s3SnHoI2Mh5GgdiYb35i-7DG2T2CDyQKMe
为了能够直观看到定期获取access_token的效果,可以试着将TokenThread里的线程休眠时间修改为30秒或60秒。最后,附上本文所涉及的项目源代码,下载地址:http://download.csdn.net/detail/lyq8479/7300501
PS:2014年4月25日微信团队发布了修改access_token长度的通知,很多开发者问这次修改会对我们的程序产生什么影响,这里顺便回答一下:如果开发者将获取到的access_token存入数据库,就必须保证对应的字段长度足够大,至少能存储512个字符;如果开发者是将access_token存储在内存中,那什么都不需要修改。
未经允许请勿转载:程序喵 » 微信公众号开发教程第18篇——如何保证access_token长期有效