全面启用 MessageHandler 中间件，以及配套异步方法

.gitignore

@@ -74,3 +74,4 @@ packages/
 /Samples/net45-mvc/Senparc.Weixin.MP.Sample/App_Data/NeuChar/*
 /Samples/net45-mvc/Senparc.Weixin.MP.Sample/App_Data/SenparcTraceLog/*
 /Samples/netcore3.0-mvc/Senparc.Weixin.Sample.NetCore3/App_Data/SenparcTraceLog
+/Samples/netcore3.0-mvc/Senparc.Weixin.Sample.NetCore3/Properties/PublishProfiles/FolderProfile.pubxml

Samples/net45-mvc/Senparc.Weixin.MP.Sample.CommonService/MessageHandlers/CustomMessageHandler/Async/CustomMessageHandlerAsync.cs

@@ -0,0 +1,65 @@
+/*----------------------------------------------------------------
+    Copyright (C) 2019 Senparc
+
+    文件名：CustomMessageHandlerAsync.cs
+    文件功能描述：自定义MessageHandler（异步方法）
+
+
+    创建标识：Senparc - 20191003
+----------------------------------------------------------------*/
+
+//DPBMARK_FILE MP
+using System;
+using System.Diagnostics;
+using System.Linq;
+using System.Threading.Tasks;
+using Senparc.NeuChar.Context;
+using Senparc.Weixin.Exceptions;
+using Senparc.CO2NET.Extensions;
+using Senparc.Weixin.HttpUtility;
+using Senparc.Weixin.MP.AdvancedAPIs;
+using Senparc.Weixin.MP.Entities;
+using Senparc.Weixin.MP.Helpers;
+using Senparc.Weixin.MP.MessageHandlers;
+using Senparc.Weixin.MP.Sample.CommonService.Download;
+using Senparc.Weixin.MP.Sample.CommonService.Utilities;
+using Senparc.NeuChar.Entities;
+using System.Threading;
+
+#if NET45
+using System.Web;
+#else
+using Microsoft.AspNetCore.Http;
+#endif
+
+//TODO:提供异步上下文消息方法
+
+namespace Senparc.Weixin.MP.Sample.CommonService.CustomMessageHandler
+{
+    /// <summary>
+    /// 自定义MessageHandler
+    /// </summary>
+    public partial class CustomMessageHandler
+    {
+        public override async Task OnExecutingAsync(CancellationToken cancellationToken)
+        {
+            //测试MessageContext.StorageData
+
+            var currentMessageContext = await base.GetCurrentMessageContext();
+            if (currentMessageContext.StorageData == null || (currentMessageContext.StorageData is int))
+            {
+                currentMessageContext.StorageData = (int)0;
+                await GlobalMessageContext.UpdateMessageContextAsync(currentMessageContext);//储存到缓存
+            }
+            await base.OnExecutingAsync(cancellationToken);
+        }
+
+        public override async Task OnExecutedAsync(CancellationToken cancellationToken)
+        {
+            var currentMessageContext = await base.GetCurrentMessageContext();
+            currentMessageContext.StorageData = ((int)currentMessageContext.StorageData) + 1;
+            GlobalMessageContext.UpdateMessageContext(currentMessageContext);//储存到缓存
+            await base.OnExecutedAsync(cancellationToken);
+        }
+    }
+}

Samples/net45-mvc/Senparc.Weixin.MP.Sample.CommonService/MessageHandlers/CustomMessageHandler/CustomMessageHandler.cs

@@ -116,33 +116,13 @@ public CustomMessageHandler(Stream inputStream, PostModel postModel, int maxReco
             };
         }
 
-        public override void OnExecuting()
-        {
-            //测试MessageContext.StorageData
-
-            var currentMessageContext = base.GetCurrentMessageContext();
-            if (currentMessageContext.StorageData == null || (currentMessageContext.StorageData is int))
-            {
-                currentMessageContext.StorageData = (int)0;
-                GlobalMessageContext.UpdateMessageContext(currentMessageContext);//储存到缓存
-            }
-            base.OnExecuting();
-        }
-
-        public override void OnExecuted()
-        {
-            base.OnExecuted();
-            var currentMessageContext = base.GetCurrentMessageContext();
-            currentMessageContext.StorageData = ((int)currentMessageContext.StorageData) + 1;
-            GlobalMessageContext.UpdateMessageContext(currentMessageContext);//储存到缓存
-        }
 
         /// <summary>
         /// 处理文字请求
         /// </summary>
         /// <param name="requestMessage">请求消息</param>
         /// <returns></returns>
-        public override IResponseMessageBase OnTextRequest(RequestMessageText requestMessage)
+        public override async Task<IResponseMessageBase> OnTextRequestAsync(RequestMessageText requestMessage)
         {
             //说明：实际项目中这里的逻辑可以交给Service处理具体信息，参考OnLocationRequest方法或/Service/LocationSercice.cs
 
@@ -194,8 +174,7 @@ public override IResponseMessageBase OnTextRequest(RequestMessageText requestMes
 
             var defaultResponseMessage = base.CreateResponseMessage<ResponseMessageText>();
 
-            var requestHandler =
-                requestMessage.StartHandler()
+            var requestHandler = await requestMessage.StartHandler()
                 //关键字不区分大小写，按照顺序匹配成功后将不再运行下面的逻辑
                 .Keyword("约束", () =>
                 {
@@ -399,13 +378,28 @@ public override IResponseMessageBase OnTextRequest(RequestMessageText requestMes
                     return defaultResponseMessage;
                 })
 
-                //Default不一定要在最后一个
-                .Default(() =>
+
+                //“一次订阅消息”接口测试
+                .Keyword("订阅", () =>
+                {
+                    defaultResponseMessage.Content = "点击打开：https://sdk.weixin.senparc.com/SubscribeMsg";
+                    return defaultResponseMessage;
+                })
+                //正则表达式
+                .Regex(@"^\d+#\d+$", () =>
+                {
+                    defaultResponseMessage.Content = string.Format("您输入了：{0}，符合正则表达式：^\\d+#\\d+$", requestMessage.Content);
+                    return defaultResponseMessage;
+                })
+
+                //当 Default 使用异步方法时，需要写在最后一个，且 requestMessage.StartHandler() 前需要使用 await 等待异步方法执行；
+                //当 Default 使用同步方法，不一定要在最后一个,并且不需要使用 await
+                .Default(async () =>
                 {
                     var result = new StringBuilder();
                     result.AppendFormat("您刚才发送了文字信息：{0}\r\n\r\n", requestMessage.Content);
 
-                    var currentMessageContext = base.GetCurrentMessageContext();
+                    var currentMessageContext = await base.GetCurrentMessageContext();
                     if (currentMessageContext.RequestMessages.Count > 1)
                     {
                         result.AppendFormat("您刚才还发送了如下消息（{0}/{1}）：\r\n", currentMessageContext.RequestMessages.Count,
@@ -432,18 +426,6 @@ public override IResponseMessageBase OnTextRequest(RequestMessageText requestMes
 
                     defaultResponseMessage.Content = result.ToString();
 
-                    return defaultResponseMessage;
-                })
-                //“一次订阅消息”接口测试
-                .Keyword("订阅", () =>
-                {
-                    defaultResponseMessage.Content = "点击打开：https://sdk.weixin.senparc.com/SubscribeMsg";
-                    return defaultResponseMessage;
-                })
-                //正则表达式
-                .Regex(@"^\d+#\d+$", () =>
-                {
-                    defaultResponseMessage.Content = string.Format("您输入了：{0}，符合正则表达式：^\\d+#\\d+$", requestMessage.Content);
                     return defaultResponseMessage;
                 });
 
@@ -455,14 +437,14 @@ public override IResponseMessageBase OnTextRequest(RequestMessageText requestMes
         /// </summary>
         /// <param name="requestMessage"></param>
         /// <returns></returns>
-        public override IResponseMessageBase OnLocationRequest(RequestMessageLocation requestMessage)
+        public override async Task<IResponseMessageBase> OnLocationRequestAsync(RequestMessageLocation requestMessage)
         {
             var locationService = new LocationService();
             var responseMessage = locationService.GetResponseMessage(requestMessage as RequestMessageLocation);
             return responseMessage;
         }
 
-        public override IResponseMessageBase OnShortVideoRequest(RequestMessageShortVideo requestMessage)
+        public override async Task<IResponseMessageBase> OnShortVideoRequestAsync(RequestMessageShortVideo requestMessage)
         {
             var responseMessage = this.CreateResponseMessage<ResponseMessageText>();
             responseMessage.Content = "您刚才发送的是小视频";
@@ -474,7 +456,7 @@ public override IResponseMessageBase OnShortVideoRequest(RequestMessageShortVide
         /// </summary>
         /// <param name="requestMessage"></param>
         /// <returns></returns>
-        public override IResponseMessageBase OnImageRequest(RequestMessageImage requestMessage)
+        public override async Task<IResponseMessageBase> OnImageRequestAsync(RequestMessageImage requestMessage)
         {
             //一隔一返回News或Image格式
             if (base.GlobalMessageContext.GetMessageContext(requestMessage).RequestMessages.Count() % 2 == 0)
@@ -511,7 +493,7 @@ public override IResponseMessageBase OnImageRequest(RequestMessageImage requestM
         /// </summary>
         /// <param name="requestMessage"></param>
         /// <returns></returns>
-        public override IResponseMessageBase OnVoiceRequest(RequestMessageVoice requestMessage)
+        public override async Task<IResponseMessageBase> OnVoiceRequestAsync(RequestMessageVoice requestMessage)
         {
             var responseMessage = CreateResponseMessage<ResponseMessageMusic>();
             //上传缩略图
@@ -543,7 +525,7 @@ public override IResponseMessageBase OnVoiceRequest(RequestMessageVoice requestM
         /// </summary>
         /// <param name="requestMessage"></param>
         /// <returns></returns>
-        public override IResponseMessageBase OnVideoRequest(RequestMessageVideo requestMessage)
+        public override async Task<IResponseMessageBase> OnVideoRequestAsync(RequestMessageVideo requestMessage)
         {
             var responseMessage = CreateResponseMessage<ResponseMessageText>();
             responseMessage.Content = "您发送了一条视频信息，ID：" + requestMessage.MediaId;
@@ -583,7 +565,7 @@ public override IResponseMessageBase OnVideoRequest(RequestMessageVideo requestM
         /// </summary>
         /// <param name="requestMessage"></param>
         /// <returns></returns>
-        public override IResponseMessageBase OnLinkRequest(RequestMessageLink requestMessage)
+        public override async Task<IResponseMessageBase> OnLinkRequestAsync(RequestMessageLink requestMessage)
         {
             var responseMessage = ResponseMessageBase.CreateFromRequestMessage<ResponseMessageText>(requestMessage);
             responseMessage.Content = string.Format(@"您发送了一条连接信息：
@@ -593,7 +575,7 @@ public override IResponseMessageBase OnLinkRequest(RequestMessageLink requestMes
             return responseMessage;
         }
 
-        public override IResponseMessageBase OnFileRequest(RequestMessageFile requestMessage)
+        public override async Task<IResponseMessageBase> OnFileRequestAsync(RequestMessageFile requestMessage)
         {
             var responseMessage = requestMessage.CreateResponseMessage<ResponseMessageText>();
             responseMessage.Content = string.Format(@"您发送了一个文件：
@@ -609,10 +591,10 @@ public override IResponseMessageBase OnFileRequest(RequestMessageFile requestMes
         /// </summary>
         /// <param name="requestMessage"></param>
         /// <returns></returns>
-        public override IResponseMessageBase OnEventRequest(IRequestMessageEventBase requestMessage)
+        public override async Task<IResponseMessageBase> OnEventRequestAsync(IRequestMessageEventBase requestMessage)
         {
-            var eventResponseMessage = base.OnEventRequest(requestMessage);//对于Event下属分类的重写方法，见：CustomerMessageHandler_Events.cs
-                                                                           //TODO: 对Event信息进行统一操作
+            var eventResponseMessage = await base.OnEventRequestAsync(requestMessage);//对于Event下属分类的重写方法，见：CustomerMessageHandler_Events.cs
+                                                                                      //TODO: 对Event信息进行统一操作
             return eventResponseMessage;
         }
 
@@ -631,7 +613,7 @@ public override IResponseMessageBase DefaultResponseMessage(IRequestMessageBase
         }
 
 
-        public override IResponseMessageBase OnUnknownTypeRequest(RequestMessageUnknownType requestMessage)
+        public override async Task<IResponseMessageBase> OnUnknownTypeRequestAsync(RequestMessageUnknownType requestMessage)
         {
             /*
              * 此方法用于应急处理SDK没有提供的消息类型，

Samples/net45-mvc/Senparc.Weixin.MP.Sample.CommonService/MessageHandlers/WorkMessageHandler/WorkCustomMessageContext.cs

@@ -20,7 +20,7 @@
 
 namespace Senparc.Weixin.MP.Sample.CommonService.WorkMessageHandler
 {
-    public class WorkCustomMessageContext : Senparc.Weixin.Work.MessageContexts.DefaultWorkMessageContext
+    public class WorkCustomMessageContext : Senparc.Weixin.Work.MessageContexts.DefaultWorkMessageContext, IMessageContext<IWorkRequestMessageBase, IWorkResponseMessageBase>
     {
         public WorkCustomMessageContext()
         {

Samples/net45-mvc/Senparc.Weixin.MP.Sample.CommonService/MessageHandlers/WorkMessageHandler/WorkCustomMessageHandler.cs

@@ -22,6 +22,12 @@ namespace Senparc.Weixin.MP.Sample.CommonService.WorkMessageHandlers
 {
     public class WorkCustomMessageHandler : WorkMessageHandler<WorkCustomMessageContext>
     {
+        /// <summary>
+        /// 为中间件提供生成当前类的委托
+        /// </summary>
+        public static Func<Stream, PostModel, int, WorkCustomMessageHandler> GenerateMessageHandler = (stream, postModel, maxRecordCount) => new WorkCustomMessageHandler(stream, postModel, maxRecordCount);
+
+
         public WorkCustomMessageHandler(Stream inputStream, PostModel postModel, int maxRecordCount = 0)
             : base(inputStream, postModel, maxRecordCount)
         {

Samples/net45-mvc/Senparc.Weixin.MP.Sample.CommonService/MessageHandlers/WxOpenMessageHandler/CustomWxOpenMessageHandler.cs

@@ -21,6 +21,8 @@
 using Senparc.NeuChar.MessageHandlers;
 using Senparc.NeuChar.Entities;
 using Senparc.CO2NET.Utilities;
+using System;
+using System.Threading;
 
 #if NET45
 using System.Web.Configuration;
@@ -39,6 +41,12 @@ public partial class CustomWxOpenMessageHandler : WxOpenMessageHandler<CustomWxO
         private string appId = Config.SenparcWeixinSetting.WxOpenAppId;
         private string appSecret = Config.SenparcWeixinSetting.WxOpenAppSecret;
 
+        /// <summary>
+        /// 为中间件提供生成当前类的委托
+        /// </summary>
+        public static Func<Stream, PostModel, int, CustomWxOpenMessageHandler> GenerateMessageHandler = (stream, postModel, maxRecordCount) => new CustomWxOpenMessageHandler(stream, postModel, maxRecordCount);
+
+
         public CustomWxOpenMessageHandler(Stream inputStream, PostModel postModel, int maxRecordCount = 0)
             : base(inputStream, postModel, maxRecordCount)
         {
@@ -64,20 +72,22 @@ public CustomWxOpenMessageHandler(Stream inputStream, PostModel postModel, int m
         }
 
 
-        public override void OnExecuting()
+        public override async Task OnExecutingAsync(CancellationToken cancellationToken)
         {
             //测试MessageContext.StorageData
-            if (CurrentMessageContext.StorageData == null || (CurrentMessageContext.StorageData is int))
+            var currentMessageContext = await base.GetCurrentMessageContext();
+            if (currentMessageContext.StorageData == null || (currentMessageContext.StorageData is int))
             {
-                CurrentMessageContext.StorageData = 0;
+                currentMessageContext.StorageData = 0;
             }
-            base.OnExecuting();
+            await base.OnExecutingAsync(cancellationToken);
         }
 
-        public override void OnExecuted()
+        public override async Task OnExecutedAsync(CancellationToken cancellationToken)
         {
-            base.OnExecuted();
-            CurrentMessageContext.StorageData = ((int)CurrentMessageContext.StorageData) + 1;
+            await base.OnExecutedAsync(cancellationToken);
+            var currentMessageContext = await base.GetCurrentMessageContext();
+            currentMessageContext.StorageData = ((int)currentMessageContext.StorageData) + 1;
         }
 
 

Samples/net45-mvc/Senparc.Weixin.MP.Sample.CommonService/Senparc.Weixin.NetCore3Sample.CommonService.csproj

@@ -2,10 +2,10 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp3.0</TargetFramework>
-    <Version>1.0.0.0</Version>
+    <Version>2.0.0.0</Version>
     <AssemblyName>Senparc.Weixin.MP.Sample.CommonService</AssemblyName>
     <RootNamespace>Senparc.Weixin.MP.Sample.CommonService</RootNamespace>
-    <Description>此项目是 Sample.netcore 下启动项目</Description>
+    <Description>此项目是 Sample.NETCore3 下启动项目</Description>
   </PropertyGroup>
 
   <ItemGroup>
@@ -14,7 +14,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.SignalR" Version="1.1.0" />
-    <PackageReference Include="Senparc.NeuChar" Version="1.0.102-preview2" />
+    <PackageReference Include="Senparc.NeuChar" Version="1.0.102-preview7.4.2" />
     <PackageReference Include="System.Diagnostics.FileVersionInfo" Version="4.3.0" />
   </ItemGroup>
 

Samples/net45-mvc/Senparc.Weixin.MP.Sample/Controllers/Work/WorkController.cs

@@ -29,9 +29,9 @@ namespace Senparc.Weixin.MP.Sample.Controllers
     /// </summary>
     public class WorkController : Controller
     {
-        public static readonly string Token = "fzBsmSaI8XE1OwBh";//与企业微信账号后台的Token设置保持一致，区分大小写。
-        public static readonly string EncodingAESKey = "9J8CQ7iF9mLtQDZrUM1loOVQ6oNDxVtBi1DBU2oaewl";//与微信企业账号后台的EncodingAESKey设置保持一致，区分大小写。
-        public static readonly string CorpId = "wx7618c0a6d9358622";//与微信企业账号后台的EncodingAESKey设置保持一致，区分大小写。
+        public static readonly string Token = Config.SenparcWeixinSetting.WorkSetting.WeixinCorpToken;//与企业微信账号后台的Token设置保持一致，区分大小写。
+        public static readonly string EncodingAESKey = Config.SenparcWeixinSetting.WorkSetting.WeixinCorpEncodingAESKey;//与微信企业账号后台的EncodingAESKey设置保持一致，区分大小写。
+        public static readonly string CorpId = Config.SenparcWeixinSetting.WorkSetting.WeixinCorpId;//与微信企业账号后台的CorpId设置保持一致，区分大小写。
 
 
         public WorkController()

Samples/net45-webforms/Senparc.Weixin.MP.Sample.WebForms/Work.aspx.cs

@@ -12,9 +12,9 @@ namespace Senparc.Weixin.MP.Sample.WebForms
 {
     public partial class Work : System.Web.UI.Page
     {
-        public static readonly string Token = "fzBsmSaI8XE1OwBh";//与微信企业账号后台的Token设置保持一致，区分大小写。
-        public static readonly string EncodingAESKey = "9J8CQ7iF9mLtQDZrUM1loOVQ6oNDxVtBi1DBU2oaewl";//与微信企业账号后台的EncodingAESKey设置保持一致，区分大小写。
-        public static readonly string CorpId = "wx7618c0a6d9358622";//与微信企业账号后台的EncodingAESKey设置保持一致，区分大小写。
+        public static readonly string Token = Config.SenparcWeixinSetting.WorkSetting.WeixinCorpToken;//与企业微信账号后台的Token设置保持一致，区分大小写。
+        public static readonly string EncodingAESKey = Config.SenparcWeixinSetting.WorkSetting.WeixinCorpEncodingAESKey;//与微信企业账号后台的EncodingAESKey设置保持一致，区分大小写。
+        public static readonly string CorpId = Config.SenparcWeixinSetting.WorkSetting.WeixinCorpId;//与微信企业账号后台的CorpId设置保持一致，区分大小写。
 
         protected void Page_Load(object sender, EventArgs e)
         {