Senparc.Weixin.MP SDK 微信公众平台开发教程(十六):AccessToken自动管理机制

Senparc.Weixin.MP SDK 微信公众平台开发教程(十六):AccessToken自动管理机制

在《Senparc.Weixin.MP SDK 微信公众平台开发教程(八):通用接口说明》中,我介绍了获取AccessToken(通用接口)的方法。

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


1

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

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


1

var accessToken = AccessTokenContainer.GetAccessToken(_appId);

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


1

var result = CommonApi.GetMenu(accessToken);

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

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

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

调用代码

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


1

var result = CommonApi.GetMenu(appId);

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


1

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()方法,代码如下:


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

namespace Senparc.Weixin.MP

{

    /// <summary>

    /// 针对AccessToken无效或过期的自动处理类

    /// </summary>

    public static class ApiHandlerWapper

    {

        /// <summary>

        /// 使用AccessToken进行操作时,如果遇到AccessToken错误的情况,重新获取AccessToken一次,并重试。

        /// 使用此方法之前必须使用AccessTokenContainer.Register(_appId, _appSecret);或JsApiTicketContainer.Register(_appId, _appSecret);方法对账号信息进行过注册,否则会出错。

        /// </summary>

        /// <typeparam name="T"></typeparam>

        /// <param name="fun"></param>

        /// <param name="accessTokenOrAppId">AccessToken或AppId。如果为null,则自动取已经注册的第一个appId/appSecret来信息获取AccessToken。</param>

        /// <param name="retryIfFaild">请保留默认值true,不用输入。</param>

        /// <returns></returns>

        public static T TryCommonApi<T>(Func<string, T> fun, string accessTokenOrAppId = nullbool retryIfFaild = truewhere T : WxJsonResult

        {

            string appId = null;

            string accessToken = null;

            if (accessTokenOrAppId == null)

            {

                appId = AccessTokenContainer.GetFirstOrDefaultAppId();

                if (appId == null)

                {

                    throw new WeixinException("尚无已经注册的AppId,请先使用AccessTokenContainer.Register完成注册(全局执行一次即可)!");

                }

            }

            else if (ApiUtility.IsAppId(accessTokenOrAppId))

            {

                if (!AccessTokenContainer.CheckRegistered(accessTokenOrAppId))

                {

                    throw new WeixinException("此appId尚未注册,请先使用AccessTokenContainer.Register完成注册(全局执行一次即可)!");

                }

                appId = accessTokenOrAppId;

            }

            else

            {

                //accessToken

                accessToken = accessTokenOrAppId;

            }

            T result = null;

            try

            {

                if (accessToken == null)

                {

                    var accessTokenResult = AccessTokenContainer.GetAccessTokenResult(appId, false);

                    accessToken = accessTokenResult.access_token;

                }

                result = fun(accessToken);

            }

            catch (ErrorJsonResultException ex)

            {

                if (!retryIfFaild

                    && appId != null

                    && ex.JsonResult.errcode == ReturnCode.获取access_token时AppSecret错误或者access_token无效)

                {

                    //尝试重新验证

                    var accessTokenResult = AccessTokenContainer.GetAccessTokenResult(appId, true);

                    accessToken = accessTokenResult.access_token;

                    result = TryCommonApi(fun, appId, false);

                }

            }

            return result;

        }

    }

}

  对应API的源代码原来是这样的:


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

/// <summary>

/// 获取当前菜单,如果菜单不存在,将返回null

/// </summary>

/// <param name="accessToken"></param>

/// <returns></returns>

public static GetMenuResult GetMenu(string 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<GetMenuResultFull>(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;

}

  现在使用TryCommonApi()方法之后:


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

/// <summary>

/// 获取当前菜单,如果菜单不存在,将返回null

/// </summary>

/// <param name="accessTokenOrAppId">AccessToken或AppId。当为AppId时,如果AccessToken错误将自动获取一次。当为null时,获取当前注册的第一个AppId。</param>

/// <returns></returns>

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<GetMenuResultFull>(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中发布。

时间: 2024-10-26 09:22:59

Senparc.Weixin.MP SDK 微信公众平台开发教程(十六):AccessToken自动管理机制的相关文章

Senparc.Weixin.MP SDK 微信公众平台开发教程(六):了解MessageHandler

上一篇<Senparc.Weixin.MP SDK 微信公众平台开发教程(五):使用Senparc.Weixin.MP SDK>我们讲述了如何使用Senparc.Weixin.MP SDK对接微信最基础的验证API,这一篇我们将具体讲一下这个SDK处理微信消息的核心:MessageHandler. 有关MessageHandler的实现原理和说明,在这篇Wiki中已经说得比较详细了,这里用代码演示一下. 延续上一篇的代码,我们继续为项目添加一个CustomMessageHandle.cs类:

Senparc.Weixin.MP SDK 微信公众平台开发教程(五):使用Senparc.Weixin.MP SDK

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(五):使用Senparc.Weixin.MP SDK Senparc.Weixin.MP SDK已经涵盖了微信5.0的所有公共API,以及2013年10月29日升级之后大部分实用的接口. 整个项目的源代码以及已经编译好的程序集可以在这个项目中获取到:https://github.com/JeffreySu/WeiXinMPSDK 我们现在从无到有建立一个ASP.NET MVC项目,来看一下如何与微信进行对接(Webforms

Senparc.Weixin.MP SDK 微信公众平台开发教程(七):解决用户上下文(Session)问题

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(七):解决用户上下文(Session)问题 从这篇文章中我们已经了解了微信公众平台消息传递的方式,这种方式有一个先天的缺陷:不同用户的请求都来自同一个微信服务器,这使得常规的Session无法使用(始终面对同一个请求对象,况且还有对方服务器Cookie是否能保存的问题). 这就要求我们自己建立一套独立的对话上下文请求机制. 上一篇<Senparc.Weixin.MP SDK 微信公众平台开发教程(六):了解MessageHa

Senparc.Weixin.MP SDK 微信公众平台开发教程(九):自定义菜单接口说明

上一篇<Senparc.Weixin.MP SDK 微信公众平台开发教程(八):通用接口说明>介绍了如何通过通用接口获取AccessToken,有了AccessToken,我们就可以来操作自定义菜单,以及其他的高级接口,这一篇单讲自定义菜单. 一.自定义菜单规则 自定义菜单分为一级菜单和二级菜单. 一级菜单数量为1-3个,即打开公众账号直接可以看到排列在最下方的最多3个按钮.一级菜单的文字最多不能超过16字节(相当于8个汉字). 二级菜单从属于一级菜单,数量为1-5个.二级菜单的文字不最多不能

Senparc.Weixin.MP SDK 微信公众平台开发教程(二):成为开发者

Senparc.Weixin.MP SDK 微信公众平台开发教程(二):成为开发者 这一篇主要讲作为一名使用公众平台接口的开发者,你需要知道的一些东西.其中也涉及到一些微信官方的规定或比较掩蔽的注意点.欢迎补充! 我觉得做好成为开发者的准备比稀里糊涂开通微信后台的"高级"功能更重要,所以这一节先放在前面说. 一.公众平台的通讯过程 作为开发者,我们需要面对的主要有两个对象:微信服务器和应用程序(网站)服务器. 当微信用户向你的公众平台发送一条消息,实际上这条消息首先发送到微信服务器,由

Senparc.Weixin.MP SDK 微信公众平台开发教程(二十一):在小程序中使用 WebSocket (.NET Core)

本文将介绍如何在 .NET Core 环境下,借助 SignalR 在小程序内使用 WebSocket.关于 WebSocket 和 SignalR 的基础理论知识不在这里展开,已经有足够的参考资料,例如参考 SignalR 的官方教程:https://docs.microsoft.com/zh-cn/aspnet/core/signalr/introduction?view=aspnetcore-2.1 我们先看一下完成本教程内容后,在小程序内实现的 WebSocket 效果: 私有及群发消息

Senparc.Weixin.MP SDK 微信公众平台开发教程(十二):OAuth2.0说明

紧接上一篇<Senparc.Weixin.MP SDK 微信公众平台开发教程(十一):高级接口说明>,这里专讲OAuth2.0. 理解OAuth2.0 首先我们通过一张图片来了解一下OAuth2.0的运作模式: 从上图我们可以看到,整个过程进行了2次"握手",最终利用授权的AccessToken进行一系列的请求,相关的过程说明如下: A:由客户端向服务器发出验证请求,请求中一般会携带这些参数 ID标识,例如appId 验证后跳转到的URL(redirectUrl) 状态参数

Senparc.Weixin.MP SDK 微信公众平台开发教程(十一):高级接口说明

这里所说的高级接口是指面向通过认证的服务号开通的高级功能. 高级功能大致可以分类为: 用户接口 分组接口 客服接口(有别于之前介绍的多客服) 群发接口 多媒体接口 二维码接口 模板消息接口(不是所有账号都可开通) OAuth2.0(相对比较复杂,后面会有专门介绍) 以上所有的接口都包含在Senparc.Weixin.MP.AdvancedAPIs命名空间下. 一些共同的操作 几乎所有的高级接口都需要用到AccessToken来通讯(注意,下面如果没有特殊说明的接口都需要这个AccessToken

Senparc.Weixin.MP SDK 微信公众平台开发教程(十五):消息加密

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(十五):消息加密 前不久,微信的企业号使用了强制的消息加密方式,随后公众号也加入了可选的消息加密选项.目前企业号和公众号的加密方式是一致的(格式会有少许差别). 加密设置 进入公众号后台的“开发者中心”,我们可以看到Url对接的设置: 点击[修改设置],可以进入到修改页面: 加密的方式一共有3种: 明文模式,即原始的消息格式 兼容模式,明文.密文将共存,正式发布的产品不建议使用(因为仍然包含了明文,达不到加密的效果) 安全模