首页 > PHP资讯 > 工具库 > 微信公众平台开发:AccessToken自动管理机制

微信公众平台开发:AccessToken自动管理机制

工具库
在《微信公众平台开发:通用接口说明》中,我介绍了获取AccessToken(通用接口)的方法。

在实际的开发过程中,所有的高级接口都需要提供AccessToken,因此我们每次在调用高级接口之前,都需要执行一次获取AccessToken的方法,例如:

var accessToken = AccessTokenContainer.TryGetAccessToken(appId, appSecret);

或者当你对appId和appSecret进行过全局注册之后,也可以这样做:

var accessToken = AccessTokenContainer.GetAccessToken(_appId);

然后使用这个accessToken输入到高级接口的方法中,例如我们可以这样获取菜单:

var result = CommonApi.GetMenu(accessToken);

  通常情况下,这已经是一个很简洁的API调用过程。但是我们不愿意就这样停止,我们准备把几乎所有的API调用都缩短到一行。

这么做的同时,除了让代码更加简便,我们还有两个愿望:

让API可以自动处理已经变更的AccessToken(在负载均衡等多个服务器同时操作同一个微信公众号的情况下,可能出现AccessToken在外部被刷新,导致本机AccessToken失效的情况),并且重新获取、返回最终正确的API结果。

不改变目前API调用的方式,完全向下兼容。

调用代码

修改之后,我们可以直接这样一行调用API,每次只需要提供一个appId:

var result = CommonApi.GetMenu(appId);

当前在执行之前,我们需要像以前一样全局注册一下appId和appSecret:

AccessTokenContainer.Register(_appId, _appSecret);//全局只需注册一次,例如可以放在Global的Application_Start()方法中。

可以看到,原先的accessToken换成了appId(新版本仍然支持输入accessToken),省去了获取accessToken的过程。具体的过程见下文说明。

SDK源代码实现过程

之前为了实现自动处理(预料外的)过期的AccessToken,SDK已经提供了Senparc.Weixin.MP/AccessTokenHandlerWapper.Do()方法。这次升级将AccessTokenHandlerWapper.cs重命名为ApiHandlerWapper.cs,废除Do()方法,添加TryCommonApi()方法,代码如下:

namespace Senparc.Weixin.MP{    ///     /// 针对AccessToken无效或过期的自动处理类    ///     public static class ApiHandlerWapper    {        ///         /// 使用AccessToken进行操作时,如果遇到AccessToken错误的情况,重新获取AccessToken一次,并重试。        /// 使用此方法之前必须使用AccessTokenContainer.Register(_appId, _appSecret);或JsApiTicketContainer.Register(_appId, _appSecret);方法对账号信息进行过注册,否则会出错。        ///         ///         /// 
/// public static GetMenuResult GetMenu(string accessTokenOrAppId){    return ApiHandlerWapper.TryCommonApi(accessToken =>      {          var url = string.Format("https://api.weixin.qq.com/cgi-bin/menu/get?access_token={0}", accessToken);           var jsonString = HttpUtility.RequestUtility.HttpGet(url, Encoding.UTF8);          //var finalResult = GetMenuFromJson(jsonString);           GetMenuResult finalResult;          JavaScriptSerializer js = new JavaScriptSerializer();          try          {              var jsonResult = js.Deserialize(jsonString);              if (jsonResult.menu == null || jsonResult.menu.button.Count == 0)              {                  throw new WeixinException(jsonResult.errmsg);              }               finalResult = GetMenuFromJsonResult(jsonResult);          }          catch (WeixinException ex)          {              finalResult = null;          }           return finalResult;      }, accessTokenOrAppId);}

我们可以观察到有这样几处变化:

1. 原先的accessToken变量名称改为了accessTokenOrAppId(新版本中所有相关接口都将如此变化)。

修改之后,这个参数可以输入accessToken(向下兼容),也可以输入appId(无需再获取accessToken),SDK会根据字符串长度自动判断属于哪种类型的参数。提供的参数有3种可能:

a) appId。使用appId需要事先对appId和appSecret进行全局注册(上文已说过),当调用API的过程中发现缓存的AccessToken过期时,SDK会自动刷新AccessToken,并重新尝试一次API请求,确保返回正确的结果。如果appId没有被注册过,会抛出异常。

b) accessToken。这种情况下将使用原始的请求方式,如果accessToken无效,将直接抛出异常,不会重试。

c) null。当accessTokenOrAppId参数为null时,SDK会自动获取全局注册的第一个appId。如果某个应用只针对一个确定的微信号开发,可以使用这种方法。当全局没有注册任何appId时,将抛出异常。

2. 原方法内的访问API的代码没有做任何修改,只是被嵌套到了return ApiHandlerWapper.TryCommonApi(accessToken =>{...},accessTokenOrAppId)的方法中,以委托的形式出现,目的是为了在第一次可能的请求失败之后,SDK可以自动执行一次一模一样的代码。

此功能已经在Senparc.Weixin.MP v12.1中发布。


更多微信公众平台开发:AccessToken自动管理机制相关文章请关注PHP中文网!

工具库

本文由欣才IT学院整理发布,未经许可,禁止转载。
支持32不支持0