【重要更新】Senparc.Weixin SDK v6.5 升级说明

  Senparc.Weixin SDK v6.5 将微信消息上下文进行了大幅度的重构,支持了使用分布式缓存存储上下文信息,这意味着在分布式系统中,现在 Senparc.Weixin SDK 也能提供跨服务器的上下文消息共享。

  当前的分布式上下文支持依赖了 NeuChar 提供的跨平台消息上下文解决方案,因此在公众号、小程序、企业微信中都已经默认支持此功能(开放平台接收的是系统推送,暂时没有必要支持)。

  本次升级对应 Senparc.Weixin.dll:v6.5.0,Senparc.Weixin.MP.dll:v16.8.0。

一、升级

  本次升级也带来了一些变化,如果您的系统是从旧版本升级到新版本,需要做一些修改或注意一些要点:列举如下:

  1、相关模块中提供了 DefaultMessageContext:DefaultMpMessageContextDefaultWxOpenMessageContextDefaultWorkMessageContext。这是之前版本中,需要用户自定义 CustomMessageContext的默认实现。因此从现在开始,如果开发者不需要对上下文进行特殊的改写处理,使用 Senparc.Weixin 官方默认的规则,已经无需再创建 CustomMessageContext,可以直接这样定义 CustomMessageHandler:

using Senparc.Weixin.MP.MessageContexts;
//...

public partial class CustomMessageHandler : MessageHandler<DefaultMpMessageContext>
{
    //....
}

  2、注意:您仍然可以使用先前定义的 CustomMessageContext,不过其中所包含的 CustomMessageContext_MessageContextRemoved() 方法将被忽略(因为系统无法收到缓存过期的通知)。这一点在技术上可以实现,只是在当前版本中暂未提供。解决的方法是使用一个外部的队列或者线程,严格同步缓存信息,并及时向系统广提示信号。

    如果您已经创建了 CustomMessageContext,并希望继续使用它们,请将基类从原先的:

    public class CustomMessageContext : MessageContext<IRequestMessageBase, IResponseMessageBase>
    {

        //...
    }

    变更为:

    public class CustomMessageContext : DefaultMpMessageContext
    {

        //...
    }

  命名空间:Senparc.Weixin.MP.MessageContexts。

  如果是小程序或企业微信,则将上述 DefaultMpMessageContext 改为 DefaultWxOpenMessageContext 或 DefaultWorkMessageContext。

  3、RequestMessageFactory.GetRequestEntity() 方法现在要求提供上下文实例。

  之前可以使用如下代码独立于 MessageHandler 生成一个 RequestMessage 对象:

                var requestDoc = XDocument.Load(Request.InputStream);
                var requestMessage = RequestMessageFactory.GetRequestEntity(requestDoc);

  现在需要加入一个确定的上下文对象:

                var requestDoc = XDocument.Load(Request.InputStream);
                var requestMessage = RequestMessageFactory.GetRequestEntity(new DefaultMpMessageContext(), requestDoc);

  当然,您也仍然可以使用自己定义的 CustomMessageContext。

  4、原先的 MessageHandler 中提供了 GlobalWeixinContext 属性,用于在本地内存中储存所有的上下文信息,现在由于已经升级为分布式缓存,因此已经没有此对象。

  在 MessageHandler 内部可以通过 base.GetCurrentMessageContext() 方法获取当前用户的上下文信息(示例),原先的 base.CurrentMessageContext 属性已经过期,请勿再使用。

  注意:无论是已经过期的 GetCurrentMessageContext 属性还是新的 GetCurrentMessageContext() 方法,每次访问都会从缓存读取,这意味着如果你使用了分布式缓存,并且需要反复读取当前用户上下文信息,建议使用一个局部变量先读取出来,然后再处理,例如:

                    var currentMessageContext = base.GetCurrentMessageContext();
                    if (currentMessageContext.RequestMessages.Count > 1)
                    {
                        result.AppendFormat("您刚才还发送了如下消息({0}/{1}):\r\n", currentMessageContext.RequestMessages.Count,
                            currentMessageContext.StorageData);
                        for (int i = currentMessageContext.RequestMessages.Count - 2; i >= 0; i--)
                        {
                            var historyMessage = currentMessageContext.RequestMessages[i];
                            result.AppendFormat("{0} 【{1}】{2}\r\n",
                                historyMessage.CreateTime.ToString("HH:mm:ss"),
                                historyMessage.MsgType.ToString(),
                                (historyMessage is RequestMessageText)
                                    ? (historyMessage as RequestMessageText).Content
                                    : "[非文字类型]"
                                );
                        }
                        result.AppendLine("\r\n");
                    }

  如果需要在 MessageHandler 外部获取某个用户的上下文信息,则可以这样做:

            //创建 GlobalMessageContext 对象
            var globalMessageContext = new GlobalMessageContext<DefaultMpMessageContext, IRequestMessageBase, IResponseMessageBase>();
            var openId = "<Your OpenId>";
            var myMessageContext = globalMessageContext.GetMessageContext(openId);

二、新版本上下文架构及原理

  将单独发布文章介绍相关信息,尽情期待!

原文地址:https://www.cnblogs.com/szw/p/11568649.html

时间: 2024-07-31 13:27:31

【重要更新】Senparc.Weixin SDK v6.5 升级说明的相关文章

【重要更新】Senparc.Weixin SDK v4.4 升级说明

本次更新同时影响以下所有Senparc.Weixin相关版本的dll: Senparc.Weixin.dll 升级到 v4.4.2(重要) Senparc.Weixin.MP.dll 升级到 v13.4.0(重要) Senparc.Weixin.MP.MvcExtension.dll 无需升级 Senparc.Weixin.Open 升级到 v1.5.3(重要) Senparc.Weixin.QY.dll 升级到 v3.2.0(重要) 源代码:https://github.com/Jeffrey

【重要更新】Senparc.Weixin SDK v4.3.3升级说明

为了更好地适应微信越来越快的API更新速度和越来越多的API数量,本次Senparc.Weixin.dll v4.3.3对一些通用功能进行了深度的重构. 本次更新同时影响以下所有Senparc.Weixin相关版本的dll: Senparc.Weixin.dll 升级到 v4.3.3 Senparc.Weixin.MP.dll 升级到 v13.3.0(重要) Senparc.Weixin.MP.MvcExtension.dll 升级到 v1.4.1 Senparc.Weixin.Open 升级到

微信公众平台C# SDK:Senparc.Weixin.MP.dll

https://github.com/Senparc/WeiXinMPSDK [转] http://www.cnblogs.com/szw/archive/2013/01/13/senparc-weixin-mp-sdk.html 微信公众账号 Senparc.Weixin.MP SDK 开发教程 索引 Senparc.Weixin.MP SDK从一开始就坚持开源的状态,这个过程中得到了许多朋友的认可和支持. 目前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.TenPay 正式发布

微信支付刚出来的时候,和公众号的绑定关系很深(甚至旧版本使用的就是公众号的appId),随着微信生态的逐步丰富,微信支付越来越成为一个独立的平台,同时服务于公众号.小程序.开放平台.企业号/企业微信等诸多平台,甚至微信支付本身也有了一些独立的功能. 早期,顺应微信支付的设计,我们在 Senparc.Weixin.MP(公众号模块)中嵌入了微信支付功能,经过连续 6 年的迭代升级,微信支付已经扩展到QY(企业号).Work(企业微信).Open(开放平台).WxOpen(小程序)等模块,其中出现了

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(C#) - 已支持微信6.x API

因为正在计划做一个微信机器人,需要用ASP.NET,找了一下只有PHP的SDK,没有C#的,于是动手写了一个,已经全面支持微信6.x所有接口,包括多客服.卡券.微信支付等. 微信公众平台地址:http://mp.weixin.qq.com Senparc.Weixin.MP官网地址:http://weixin.senparc.com 所有源代码(SDK+示例): https://github.com/JeffreySu/WeiXinMPSDK(新版本已发布,可以在github中查看最新的代码和教

【转】微信公众账号 Senparc.Weixin.MP SDK 开发教程 索引

微信公众账号 Senparc.Weixin.MP SDK 开发教程 索引 Senparc.Weixin.MP SDK从一开始就坚持开源的状态,这个过程中得到了许多朋友的认可和支持. 目前SDK已经达到比较稳定的版本,这个过程中我觉得有必要整理一些思路和经验,和大家一起分享.也欢迎大家的补充! SDK还在不断优化升级中,开源项目见:https://github.com/JeffreySu/WeiXinMPSDK 微信技术交流社区:http://www.weiweihi.com/QA Senparc

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

Senparc.Weixin.MP SDK 微信公众平台开发教程(十六):AccessToken自动管理机制 在<Senparc.Weixin.MP SDK 微信公众平台开发教程(八):通用接口说明>中,我介绍了获取AccessToken(通用接口)的方法. 在实际的开发过程中,所有的高级接口都需要提供AccessToken,因此我们每次在调用高级接口之前,都需要执行一次获取AccessToken的方法,例如: 1 var accessToken = AccessTokenContainer.