Senparc.Weixin.MP SDK 微信公众平台开发教程二十三:在 .NET Core 2.0/3.0 中使用 MessageHandler 中间件

概述

  在 《Senparc.Weixin.MP SDK 微信公众平台开发教程(六):了解MessageHandler》 中我们已经了解了 MessageHandler 的运行原理和使用方法,从我设计了这种处理方式到现在已经 6 年多的时间,这是一种非常稳定而且(在如此复杂环境下)相对易于维护的的设计。

  现在 .NET Core 已经进入了一个新的阶段,随着 .NET Core 3.0 的发布,我决在兼容原有方式不改变的情况下,让 MessageHandler 可以支持 .NET Core(或者说 .NET Standard 2.0+)的中间件,为开发者提供另外一种使用 SDK 的方式。

  新的设计将达到如下目标或新特性:

  1. 不再依赖 Controller/Action,因此也不再依赖 FixWeixinBugWeixinResult 等一系列因为历史原因而存在的类和方法。你不必再为处理微信消息创建任何 Controller 或 WebApi;
  2. 不影响现有的运行效率,甚至更快;
  3. 默认仅支持异步方法;
  4. 更轻量、更少的配置代码
  5. 高度可用,不阉割任何功能。

准备开发

开发步骤

第一步:创建一个 .NET Core 3.0 Web 项目(空):

原始的 startup.cs 如下:

 1  1 namespace WechatMessageSample
 2  2 {
 3  3     public class Startup
 4  4     {
 5  5         // This method gets called by the runtime. Use this method to add services to the container.
 6  6          For more information on how to configure your application,visit https://go.microsoft.com/fwlink/?LinkID=398940
 7  7         void ConfigureServices(IServiceCollection services)
 8  8         {
 9  9         }
10 10 
11 11          This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
12 12          Configure(IApplicationBuilder app,IWebHostEnvironment env)
13 1314 14             if (env.IsDevelopment())
15 15             {
16 16                 app.UseDeveloperExceptionPage();
17 17             }
18 18 
19 19             app.UseRouting();
20 20 
21 21             app.UseEndpoints(endpoints =>
22 2223 23                 endpoints.MapGet("/",async context =>
24 24                 {
25 25                     await context.Response.WriteAsync(Hello World!");
26 26                 });
27 27             });
28 2829 29     }
30 30 }
View Code

 

第二步:使用 Nuget 添加 Senparc.Weixin SDK:

  上图标注出来的 3 个包分别是:公众号、小程序和企业微信,本实例主要演示公众号,其他两个平台使用方法是一致的,可以举一反三,不再赘述。

 

第三步:创建自定义消息处理器(MessageHandler):

 1 /// <summary>
 2 /// 自定义公众号消息处理
 3 </summary>
 4 class CustomMpMessageHandler : Senparc.Weixin.MP.MessageHandlers.MessageHandler<DefaultMpMessageContext>
 5 {
 6     public CustomMpMessageHandler(Stream inputStream,PostModel postModel,1)">int maxRecordCount = 0,1)">bool onlyAllowEcryptMessage = false,DeveloperInfo developerInfo = null)
 7         : base(inputStream,postModel,maxRecordCount,onlyAllowEcryptMessage,developerInfo)
 8     {
 9     }
11     override IResponseMessageBase DefaultResponseMessage(IRequestMessageBase requestMessage)
12 13         throw new NotImplementedException();
14 15 }

  一般情况下,此文件是独立的 .cs 文件,当前实例为了方便展示,一起写在了 startup.cs 文件中。

  以上是一个默认的空的 MessageHandler,还不能正常运行,我们为 DefaultResponseMessage 添加默认的返回消息:

 1  2  3     var responseMessage = base.CreateResponseMessage<ResponseMessageNews>();
 4     responseMessage.Articles.Add( Article()
 6         Title = 欢迎使用 Senparc.Weixin SDK, 7         Description = 这是一条默认消息 8         PicUrl = https://sdk.weixin.senparc.com/images/v2/logo.png 9         Url = https://weixin.senparc.com"
10     });
return responseMessage;
12 }

  也可以再创建一系列响应规则,例如处理文本信息,并返回一条文本:

override async Task<IResponseMessageBase> OnTextRequestAsync(RequestMessageText requestMessage)
2 base.CreateResponseMessage<ResponseMessageText>4     responseMessage.Content = $您发送了文字:{requestMessage.Content};
5     6 }

  以此类推,可以为每一种类型的消息创建处理过程。

  为了方便接下去的中间件对接,再创建一个初始化当前自定义 MessageHandler 示例的委托:

static Func<Stream,PostModel,1)">int,CustomMpMessageHandler> GenerateMessageHandler = (stream,maxRecordCount)
2                 => new CustomMpMessageHandler(stream,1)">false);

  上述 CustomMpMessageHandler 构造函数中的最后一个 bool 参数(onlyAllowEcryptMessage),提供了一种加强的安全策略,可以指定是否只允许处理加密消息,开启之后,试图使用明文进行消息推送(嗅探)的请求将被拒绝(前提是对方已经拿到了正确的 Token),并终止后续处理流程,确保程序安全。

 

第四步:修改 startup.cs 进行全局注册

修改 ConfigureServices() 方法:

public Startup(IConfiguration configuration)
 3     Configuration = configuration;
}
 5 
 6 public IConfiguration Configuration { get; }
 7 
10     services.AddMemoryCache();使用本地缓存必须添加(按需)
11 
12     services.AddSenparcWeixinServices(Configuration);Senparc.Weixin 注册
13 }

修改 Configure() 方法参数:

2         IOptions<SenparcSetting> senparcSetting,IOptions<SenparcWeixinSetting> senparcWeixinSetting)

Configure() 方法内追加:

1 app.UseSenparcGlobal(env,senparcSetting.Value,globalRegister => { })
2    .UseSenparcWeixin(senparcWeixinSetting.Value,weixinRegister =>
3    {
4        weixinRegister.RegisterMpAccount(senparcWeixinSetting.Value,【盛派网络小助手】公众号5    });

  至此注册工作已经全部完成!

指定使用 MessageHandler 中间件,只需一行:

app.UseMessageHandlerForMp(/WeixinAsync第五步:配置 appsetting.json

  参考:appsetting.json

  找到公众号的相关设置,修改 Token、AppId 等参数。

 

第六步:完成。

 

使用

  使用 Ctrl + F5 打开当前项目,可以看到默认输出的 Hello World 消息,打开上述设置的 /Weixin 地址:

 

测试地址:https://sdk.weixin.senparc.com/WeixinAsync

  此时我们已经可以开始将站点部署到外网,提供给公众进行服务,所有的去重、加解密、上下文等过程系统已经全部配备。

测试

  Senparc.Weixin SDK 为了方便开发者测试公众号消息,已经提供了一套模拟器,可以用于发送和接收公众号消息的测试。

  注意:如果测试本地 localhost 的项目,需要在本地运行模拟器,上述模拟器也已经包含在开源 Sample 中,可以下载后在本地运行并使用:

  同样也支持并发测试以及加密模式:

  如果同时发送两条 MsgId 相同的消息,会被自动去重过滤:

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

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


在上文中,我介绍了事件驱动型架构的一种简单的实现,并演示了一个完整的事件派发、订阅和处理的流程。这种实现太简单了,百十行代码就展示了一个基本工作原理。然而,要将这样的解决方案运用到实际生产环境,还有很长的路要走。今天,我们就研究一下在事件处理器中,对象生命周期的管理问题。事实上,不仅仅是在事件处理器
上文已经介绍了Identity Service的实现过程。今天我们继续,实现一个简单的Weather API和一个基于Ocelot的API网关。 回顾 《Angular SPA基于Ocelot API网关与IdentityServer4的身份认证与授权(一)》 Weather API Weather
最近我为我自己的应用开发框架Apworks设计了一套案例应用程序,并以Apache 2.0开源,开源地址是:https://github.com/daxnet/apworks-examples,目的是为了让大家更为方便地学习和使用.NET Core、最新的前端开发框架Angular,以及Apwork
HAL(Hypertext Application Language,超文本应用语言)是一种RESTful API的数据格式风格,为RESTful API的设计提供了接口规范,同时也降低了客户端与服务端接口的耦合度。很多当今流行的RESTful API开发框架,包括Spring REST,也都默认支
在前面两篇文章中,我详细介绍了基本事件系统的实现,包括事件派发和订阅、通过事件处理器执行上下文来解决对象生命周期问题,以及一个基于RabbitMQ的事件总线的实现。接下来对于事件驱动型架构的讨论,就需要结合一个实际的架构案例来进行分析。在领域驱动设计的讨论范畴,CQRS架构本身就是事件驱动的,因此,
HAL,全称为Hypertext Application Language,它是一种简单的数据格式,它能以一种简单、统一的形式,在API中引入超链接特性,使得API的可发现性(discoverable)更强,并具有自描述的特点。使用了HAL的API会更容易地被第三方开源库所调用,并且使用起来也很方便
何时使用领域驱动设计?其实当你的应用程序架构设计是面向业务的时候,你已经开始使用领域驱动设计了。领域驱动设计既不是架构风格(Architecture Style),也不是架构模式(Architecture Pattern),它也不是一种软件开发方法论,所以,是否应该使用领域驱动设计,以及什么时候使用
《在ASP.NET Core中使用Apworks快速开发数据服务》一文中,我介绍了如何使用Apworks框架的数据服务来快速构建用于查询和管理数据模型的RESTful API,通过该文的介绍,你会看到,使用Apworks框架开发数据服务是何等简单快捷,提供的功能也非常多,比如对Hypermedia的
在上一讲中,我们已经完成了一个完整的案例,在这个案例中,我们可以通过Angular单页面应用(SPA)进行登录,然后通过后端的Ocelot API网关整合IdentityServer4完成身份认证。在本讲中,我们会讨论在当前这种架构的应用程序中,如何完成用户授权。 回顾 《Angular SPA基于
Keycloak是一个功能强大的开源身份和访问管理系统,提供了一整套解决方案,包括用户认证、单点登录(SSO)、身份联合、用户注册、用户管理、角色映射、多因素认证和访问控制等。它广泛应用于企业和云服务,可以简化和统一不同应用程序和服务的安全管理,支持自托管或云部署,适用于需要安全、灵活且易于扩展的用
3月7日,微软发布了Visual Studio 2017 RTM,与之一起发布的还有.NET Core Runtime 1.1.0以及.NET Core SDK 1.0.0,尽管这些并不是最新版,但也已经从preview版本升级到了正式版。所以,在安装Visual Studio 2017时如果启用了
在上文中,我介绍了如何在Ocelot中使用自定义的中间件来修改下游服务的response body。今天,我们再扩展一下设计,让我们自己设计的中间件变得更为通用,使其能够应用在不同的Route上。比如,我们可以设计一个通用的替换response body的中间件,然后将其应用在多个Route上。 O
不少关注我博客的朋友都知道我在2009年左右开发过一个名为Apworks的企业级应用程序开发框架,旨在为分布式企业系统软件开发提供面向领域驱动(DDD)的框架级别的解决方案,并对多种系统架构风格提供支持。这个框架的开发和维护我坚持了很久,一直到2015年,我都一直在不停地重构这个项目。目前这个项目在
好吧,这个题目我也想了很久,不知道如何用最简单的几个字来概括这篇文章,原本打算取名《Angular单页面应用基于Ocelot API网关与IdentityServer4ʺSP.NET Identity实现身份认证与授权》,然而如你所见,这样的名字实在是太长了。所以,我不得不缩写“单页面应用”几个字
在前面两篇文章中,我介绍了基于IdentityServer4的一个Identity Service的实现,并且实现了一个Weather API和基于Ocelot的API网关,然后实现了通过Ocelot API网关整合Identity Service做身份认证的API请求。今天,我们进入前端开发,设计
Ocelot是ASP.NET Core下的API网关的一种实现,在微服务架构领域发挥了非常重要的作用。本文不会从整个微服务架构的角度来介绍Ocelot,而是介绍一下最近在学习过程中遇到的一个问题,以及如何使用中间件(Middleware)来解决这样的问题。 问题描述 在上文中,我介绍了一种在Angu
在大数据处理和人工智能时代,数据工厂(Data Factory)无疑是一个非常重要的大数据处理平台。市面上也有成熟的相关产品,比如Azure Data Factory,不仅功能强大,而且依托微软的云计算平台Azure,为大数据处理提供了强大的计算能力,让大数据处理变得更为稳定高效。由于工作中我的项目
在上文中,我们讨论了事件处理器中对象生命周期的问题,在进入新的讨论之前,首先让我们总结一下,我们已经实现了哪些内容。下面的类图描述了我们已经实现的组件及其之间的关系,貌似系统已经变得越来越复杂了。其中绿色的部分就是上文中新实现的部分,包括一个简单的Event Store,一个事件处理器执行上下文的接
在之前《在ASP.NET Core中使用Apworks快速开发数据服务》一文的评论部分,.NET大神张善友为我提了个建议,可以使用Compile As a Service的Roslyn为语法解析提供支持。在此非常感激友哥给我的建议,也让我了解了一些Roslyn的知识。使用Roslyn的一个很大的好处
很长一段时间以来,我都在思考如何在ASP.NET Core的框架下,实现一套完整的事件驱动型架构。这个问题看上去有点大,其实主要目标是为了实现一个基于ASP.NET Core的微服务,它能够非常简单地订阅来自于某个渠道的事件消息,并对接收到的消息进行处理,于此同时,它还能够向该渠道发送事件消息,以便