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

2023-11-02 23:43:16

概述

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

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

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

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

准备开发

开发环境：Visual Studio 2019 / Visual Studio Code
.NET 版本：.NET Core 3.0
关于 .NET Core 的中间件介绍：https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware/?view=aspnetcore-3.0

开发步骤

第一步：创建一个 .NET Core 3.0 Web 项目（空）：

原始的 startup.cs 如下：

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

 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         public 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         public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
13 13         {
14 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 22             {
23 23                 endpoints.MapGet("/", async context =>
24 24                 {
25 25                     await context.Response.WriteAsync("Hello World!");
26 26                 });
27 27             });
28 28         }
29 29     }
30 30 }

View Code

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

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

第三步：创建自定义消息处理器（MessageHandler）：

/// <summary>
/// 自定义公众号消息处理
/// </summary>
public class CustomMpMessageHandler : Senparc.Weixin.MP.MessageHandlers.MessageHandler<DefaultMpMessageContext>
{
   public CustomMpMessageHandler(Stream inputStream, PostModel postModel, int maxRecordCount = 0, bool onlyAllowEcryptMessage = false, DeveloperInfo developerInfo = null)
       : base(inputStream, postModel, maxRecordCount, onlyAllowEcryptMessage, developerInfo)
   {
   }

   public override IResponseMessageBase DefaultResponseMessage(IRequestMessageBase requestMessage)
   {
       throw new NotImplementedException();
   }
}

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

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

public override IResponseMessageBase DefaultResponseMessage(IRequestMessageBase requestMessage)
{
   var responseMessage = base.CreateResponseMessage<ResponseMessageNews>();
   responseMessage.Articles.Add(new Article()
   {
       Title = "欢迎使用 Senparc.Weixin SDK",
       Description = "这是一条默认消息",
       PicUrl = "https://sdk.weixin.senparc.com/images/v2/logo.png",
       Url = "https://weixin.senparc.com"
   });
   return responseMessage;
}

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

public override async Task<IResponseMessageBase> OnTextRequestAsync(RequestMessageText requestMessage)
{
   var responseMessage = base.CreateResponseMessage<ResponseMessageText>();
   responseMessage.Content = $"您发送了文字：{requestMessage.Content}";
   return responseMessage;
}

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

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

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

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

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

修改 ConfigureServices() 方法：

public Startup(IConfiguration configuration)
{
   Configuration = configuration;
}

public IConfiguration Configuration { get; }

public void ConfigureServices(IServiceCollection services)
{
   services.AddMemoryCache();//使用本地缓存必须添加（按需）

   services.AddSenparcWeixinServices(Configuration);//Senparc.Weixin 注册
}

修改 Configure() 方法参数：

1 public void Configure(IApplicationBuilder app, IWebHostEnvironment env,
2         IOptions<SenparcSetting> senparcSetting, IOptions<SenparcWeixinSetting> senparcWeixinSetting)

Configure() 方法内追加：

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

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

指定使用 MessageHandler 中间件，只需一行：

app.UseMessageHandlerForMp("/WeixinAsync", CustomMpMessageHandler.GenerateMessageHandler,
    o => o.AccountSettingFunc = c => senparcWeixinSetting.Value);