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

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

    从这篇文章中我们已经了解了微信公众平台消息传递的方式,这种方式有一个先天的缺陷:不同用户的请求都来自同一个微信服务器,这使得常规的Session无法使用(始终面对同一个请求对象,况且还有对方服务器Cookie是否能保存的问题)。

    这就要求我们自己建立一套独立的对话上下文请求机制。

    上一篇《Senparc.Weixin.MP SDK 微信公众平台开发教程(六):了解MessageHandler》中我们了解到,Senparc.Weixin.MP SDK提供了一套非常便捷的消息处理机制,这套机制上面,我们有增加了一个叫MessageContext的上下文处理机制,下面我们就来说一说这个功能的使用(参考开源项目Wiki中的《用户上下文WeixinContext和MessageContext》一文)。

     更多实际应用的代码可以参考开源项目中的Demo:https://github.com/JeffreySu/WeiXinMPSDK,此外您也可以关注下方的微信二维码,不断发送文字及各种信息进行测试(发送文字的时候才能看到完整结果,期间可以发送其他任意类型)。

 



 

概述

由于微信公众平台的特殊机制,所有的信息都由微信服务器转发而来,因此服务器是无法使用Session对用户会话的上下文进行管理的。

为此Senparc.WeiXin.MP SDK增加了上下文的模块,并集成到了MessageHandler中。

WeixinContext

WeixinContext是所有单个用户上下文(MessageContext)实体的容器(暂且称为全局上下文)。WeixinContext本身不是静态类,意味着您可以在同一个应用中创建多个上下文实体。

同时,一个静态的WeixinContext实例被放入到MessageHandler<TM>中,因此所有项目中由MessageHandler<TM>派生的子类中的WeixinContext是唯一的、全局的(注:TM为实现IMessageContext的类,包括SDK中已经提供的MessageContext)。

因此我们在任何一个实现了MessageHandler<TM>的实例中(比如叫MyMessageHandler),都可以访问到一个类型和名称都叫WeixinContext的对象。

WeixinContext用于保存所用户的上下文(MessageContext),并且提供了一系列的方法,主要方法包括:

      /// <summary>
      /// 重置所有上下文参数,所有记录将被清空
      /// </summary>
      public void Restore()
      {
          ...
      }

      /// <summary>
      /// 获取MessageContext,如果不存在,返回null
      /// 这个方法的更重要意义在于操作TM队列,及时移除过期信息,并将最新活动的对象移到尾部
      /// </summary>
      /// <param name="userName">用户名(OpenId)</param>
      /// <returns></returns>
      private TM GetMessageContext(string userName)
      {
          ...
      }

      /// <summary>
      /// 获取MessageContext
      /// </summary>
      /// <param name="userName">用户名(OpenId)</param>
      /// <param name="createIfNotExists">True:如果用户不存在,则创建一个实例,并返回这个最新的实例
      /// False:用户储存在,则返回null</param>
      /// <returns></returns>
      private TM GetMessageContext(string userName, bool createIfNotExists)
      {
          ...
      }

      /// <summary>
      /// 获取MessageContext,如果不存在,使用requestMessage信息初始化一个,并返回原始实例
      /// </summary>
      /// <returns></returns>
      public TM GetMessageContext(IRequestMessageBase requestMessage)
      {
          ...
      }

      /// <summary>
      /// 获取MessageContext,如果不存在,使用requestMessage信息初始化一个,并返回原始实例
      /// </summary>
      /// <returns></returns>
      public TM GetMessageContext(IResponseMessageBase responseMessage)
      {
          ...
      }

      /// <summary>
      /// 记录请求信息
      /// </summary>
      /// <param name="requestMessage">请求信息</param>
      public void InsertMessage(IRequestMessageBase requestMessage)
      {
          ...
      }

      /// <summary>
      /// 记录响应信息
      /// </summary>
      /// <param name="responseMessage">响应信息</param>
      public void InsertMessage(IResponseMessageBase responseMessage)
      {
          ...
      }

      /// <summary>
      /// 获取最新一条请求数据,如果不存在,则返回Null
      /// </summary>
      /// <param name="userName">用户名(OpenId)</param>
      /// <returns></returns>
      public IRequestMessageBase GetLastRequestMessage(string userName)
      {
          ...
      }

      /// <summary>
      /// 获取最新一条响应数据,如果不存在,则返回Null
      /// </summary>
      /// <param name="userName">用户名(OpenId)</param>
      /// <returns></returns>
      public IResponseMessageBase GetLastResponseMessage(string userName)
      {
          ...
      }

WeixinContext中有两个用于储存用户上下文的对象:MessageCollection及MessageQueue。

这两个对象中的元素集合是重合的,但是MessageQueue对元素进行了排序,以便及时处理掉顶部过期的上下文。

ExpireMinutes用于定义上下文时间有效期,默认为90分钟。可以在程序的任何地方设置设个参数,且立即生效。

PS:MessageQueue中删除过期数据的逻辑以极高的效率运作,开发时无需考虑CPU占用及对象冲突的问题(额外校验时间是否超时)。

MessageContext

MessageContext用于保存单个用户的上下文信息,被储存在WeixinContext的MessageCollection及MessageQueue对象中。 IMessageContext定义如下:

  public interface IMessageContext
  {
      /// <summary>
      /// 用户名(OpenID)
      /// </summary>
      string UserName { get; set; }
      /// <summary>
      /// 最后一次活动时间(用户主动发送Resquest请求的时间)
      /// </summary>
      DateTime LastActiveTime { get; set; }
      /// <summary>
      /// 接收消息记录
      /// </summary>
      List<IRequestMessageBase> RequestMessages { get; set; }
      /// <summary>
      /// 响应消息记录
      /// </summary>
      List<IResponseMessageBase> ResponseMessages { get; set; }
      /// <summary>
      /// 临时储存数据,如用户状态等,出于保持.net 3.5版本,这里暂不使用dynamic
      /// </summary>
      object StorageData { get; set; }
  }

您可以根据自己的需要创建自己的类,实现这个接口,并且被WeixinContext使用。当然如果你的要求不是那么特殊,而且你比较懒的话,SDK提供了一个默认的MessageContext实现:

  /// <summary>
  /// 微信消息上下文(单个用户)
  /// </summary>
  public class MessageContext : IMessageContext
  {
      public string UserName { get; set; }
      public DateTime LastActiveTime { get; set; }
      public List<IRequestMessageBase> RequestMessages { get; set; }
      public List<IResponseMessageBase> ResponseMessages { get; set; }

      public object StorageData { get; set; }

      public MessageContext()
      {
          /*
           * 注意:即使使用其他类实现IMessageContext,
           * 也务必在这里进行下面的初始化,尤其是设置当前时间,
           * 这个时间关系到及时从缓存中移除过期的消息,节约内存使用
           */
          RequestMessages = new List<IRequestMessageBase>();
          ResponseMessages = new List<IResponseMessageBase>();
          LastActiveTime = DateTime.Now;
      }
  }

上面的代码根据注释很好理解,需要说明一下的是StorageData。这是一个用于储存任何和用户上下文有关数据的容器,WeixinContext和IMessageContext没有对它进行任何引用,完全由开发者决定里面的内容(比如用户执行到哪一步、或某个比较重要的位置信息等等),类似于Session的作用。

 

 

    系列教程索引:http://www.cnblogs.com/szw/archive/2013/05/14/weixin-course-index.html

时间: 2024-07-29 00:27:44

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

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

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

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

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(十一):高级接口说明     这里所说的高级接口是指面向通过认证的服务号开通的高级功能.     高级功能大致可以分类为: 用户接口 分组接口 客服接口(有别于之前介绍的多客服) 群发接口 多媒体接口 二维码接口 模板消息接口(不是所有账号都可开通) OAuth2.0(相对比较复杂,后面会有专门介绍) 以上所有的接口都包含在Senparc.Weixin.MP.AdvancedAPIs命名空间下. 一些共同的操作 几乎所有的高

Senparc.Weixin.MP SDK 微信公众平台开发教程(八):通用接口说明

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(八):通用接口说明 一.基础说明     这里说的"通用接口(CommonAPIs)"是使用微信公众账号一系列高级功能的必备验证功能(应用于开发模式).     我们通过微信后台唯一的凭证,向通用接口发出请求,得到访问令牌(AccessToken),然后使用访问令牌去使用各项需要身份验证的高级功能,例如自定义菜单.获取用户信息.单发消息.群发消息等等.     目前所有的服务号和通过认证的订阅号,都可以在微信公众账

Senparc.Weixin.MP SDK 微信公众平台开发教程(一):微信公众平台注册

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(一):微信公众平台注册     微信公众平台(下面简称"公众平台")注册步骤和导航还是比较流畅的,因此这个教程对于上网经验丰富的朋友来说,有点多余.不过为了保持教程系列的完整性,这里还是认认真真把流程梳理一遍.   第一步:进入公众平台地址:https://mp.weixin.qq.com  第二步:如果还没有账号,点击右上角的立即注册按钮. 第三步:填写"1.基本信息",并点击[注册]: 第四

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项目,来看一下如何与微

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

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

Senparc.Weixin.MP SDK 微信公众平台开发教程(三):微信公众平台开发验证

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(三):微信公众平台开发验证     要对接微信公众平台的"开发模式",即对接到自己的网站程序,必须在注册成功之后(见Senparc.Weixin.MP SDK 微信公众平台开发教程(一):微信公众平台注册),等待官方审核,审核通过之后,会在后台顶部出现"高级功能"菜单.     使用"高级功能">"开发模式"之前,必须有一个已经部署在Internet

Senparc.Weixin.MP SDK 微信公众平台开发教程(十三):地图相关接口说明

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(十三):地图相关接口说明 为了方便大家开发LBS应用,SDK对常用计算公式,以及百度和谷歌的地图接口做了封装. 常用计算: 用于计算2个坐标点之间的直线距离:Senparc.Weixin.MP.Helpers.Distance(double n1, double e1, double n2, double e2) 根据距离获取维度差:Senparc.Weixin.MP.Helpers.GetLatitudeDifferenc

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

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(六):了解MessageHandler     上一篇<Senparc.Weixin.MP SDK 微信公众平台开发教程(五):使用Senparc.Weixin.MP SDK>我们讲述了如何使用Senparc.Weixin.MP SDK对接微信最基础的验证API,这一篇我们将具体讲一下这个SDK处理微信消息的核心:MessageHandler.     有关MessageHandler的实现原理和说明,在这篇Wiki中已经

Senparc.Weixin.MP SDK 微信公众平台开发教程(十四):请求消息去重

原文:Senparc.Weixin.MP SDK 微信公众平台开发教程(十四):请求消息去重 为了确保信息请求消息的到达率,微信服务器在没有及时收到响应消息(ResponseMessage)的情况下,会多次发送同一条请求消息(RequestMessage),包括MsgId等在内的所有文本内容都是一致的. 这种机制确保了在诸如网络状况不佳的情况下消息的回复成功率,但是有时候由于服务器负荷.本身请求过程就需要好几秒才能完成等情况,多次重复的消息反而成了服务器的负担,甚至对业务和数据也可能造成影响.