C#微信公众号开发之用户上下文WeixinContext和MessageContext
作者:Jeffrey?Su 发布时间:2022-04-23 09:31:54
概述
由于微信公众平台的特殊机制,所有的信息都由微信服务器转发而来,因此服务器是无法使用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的作用。
来源:https://github.com/JeffreySu/WeiXinMPSDK/wiki/
猜你喜欢
- 1,IDEA中Lombok作用数据库: 库 表 字段 对应的值 user表(id,name,age)实体对象pojo: 用来封装数据库中的数
- 简介在 Java 开发领域,热部署一直是一个难以解决的问题,目前的 Java 虚拟机只能实现方法体的修改热部署,对于整个类的结构修改,仍然需
- 一、概述Socket类是Java执行客户端TCP操作的基础类,这个类本身使用代码通过主机操作系统的本地TCP栈进行通信。Socket类的方法
- 本文实例讲述了C#设计模式之ChainOfResponsibility职责链模式解决真假美猴王问题。分享给大家供大家参考,具体如下:一、理论
- 每一个应用程序,其实都会有分享的需求,比如一键分享一篇文章或者一些活动到微博或者微信亦或者是twitter等社交平台,因为人类是社交动物,而
- 一、using语句using可以算是.NET中新的语法元素,它清楚地说明一个通常比较占用资源的对象何时开始使用和何时被手动释放。当using
- 本文实例讲述了Android编程之ListView和EditText发布帖子隐藏软键盘功能。分享给大家供大家参考,具体如下:在Android
- 背景之前和同事讨论一个问题,他们公司调研中发现forEach的速度比for的速度慢,当刚听到这个结论的时候有点诧异。因为之前看过国外的文章和
- 本文实例总结了C#中split用法。分享给大家供大家参考,具体如下:以下是我转载的两个不同的人的,方便大家及自己查阅string s=&qu
- 新手当在一个类文件中进行了一些操作之后,会造成sout快捷命令无法自动生成。比如操作了import引入其它包之后。主要是对IDEA操作的不熟
- 这个例子用于演示在Spring Boot应用中如何验证Web 应用的输入,我们将会建立一个简单的Spring MVC应用,来读取用户输入并使
- 一、BIO、NIO、AIO学习Netty需要了解BIO、NIO、AIO,具体可参考Java网络编程IO模型 — BIO、
- 规则1(无继承情况下):对于静态变量、静态初始化块、变量、初始化块、构造器,它们的初始化顺序依次是(静态变量、静态初始化块)>(变量、
- byte:java中最小的数据类型。1字节/8位。-128(2^7)~127(2^7-1),默认值0。short:短整型,2字节/16位,取
- 最新需要公司要求在不改变原来的登录逻辑的情况下,将原来的验证码登录的形式改成滑动图片的形式!下面是做出来的效果:实现思路:所有的图片数据,验
- 这篇文章主要介绍了springboot全局异常处理代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要
- 如今APP越来越多,我们每天所使用的的软件也越来越多,可是在我们不付费的情况下,App制造商如何实现,实现收入甚至是盈利呢?答案就是在我们打
- 近来,很多公司的APP都实现了人脸识别登录的功能。今天呢,银鹏带大家从头到尾做一下这个人脸识别登录。首先呢,我们需要采用一个拥有人脸识别算法
- 一,设计多图片打包下载逻辑:1,如果是要拉取腾讯云等资源服务器的图片,2,我们先把远程图片拉取到本地的临时文件夹,3,然后压缩临时文件夹,4
- 简介方案对比本处列举表示类型或状态的常用方法的对比。法1:使用数字表示(不推荐)//1:支付宝支付;2:微信支付;3:银行卡支付privat