微信开发深度解析：MessageHandler——简化消息处理流程

本文节选自苏震巍撰写的《微信开发深度解析：微信公众号、小程序高效开发秘籍》一书，由电子工业出版社出版。
责编：陈秋歌，关注微信开发等领域，寻求报道或者投稿请发邮件至chenqg#csdn.net。

MessageHandler 是一个微信消息的处理模块，也是整个微信开发过程中不可缺少的一部分。在 MessageHandler 中，开发者可以非常轻松地处理所有类型的微信消息。

本文将介绍 MessageHandler 的原理以及使用方法，包括支撑MessageHandler 运行所必需的实体类型、工厂方法等相关知识的介绍。

设计思想

如果你已经了解微信消息的基本通信原理，那我们现在可以非常方便地构造出一个简单的消息处理功能，如下：

StreamReader str = new StreamReader(Request.InputStream, System.Text.Encoding. UTF8);
XmlDocument xml = new XmlDocument();
xml.Load(str);
var wx = new WeixinRequest();
wx.ToUserName = xml.SelectSingleNode("xml").SelectSingleNode("ToUserName").InnerText;
wx.FromUserName = xml.SelectSingleNode("xml").SelectSingleNode("FromUserName"). InnerText;
wx.MsgType = xml.SelectSingleNode("xml").SelectSingleNode("MsgType").InnerText;
if (wx.MsgType.Trim() == "event")
{
    wx.EventName = xml.SelectSingleNode("xml").SelectSingleNode("Event").InnerText;
    //  WriteLog(wx.EventName);
    if (wx.EventName.ToUpper() == "LOCATION")
    {
        wx.Latitude = xml.SelectSingleNode("xml").SelectSingleNode("Latitude").InnerText;
        wx.Longitude = xml.SelectSingleNode("xml").SelectSingleNode("Longitude"). InnerText;
        wx.Precision = xml.SelectSingleNode("xml").SelectSingleNode("Precision"). InnerText;
    }
    else
    {
        wx.EventKey = xml.SelectSingleNode("xml").SelectSingleNode("EventKey"). InnerText;
    }
}
else if (wx.MsgType.Trim() == "text")
{
    wx.Content= xml.SelectSingleNode("xml").SelectSingleNode("Content").InnerText;
} else if (...)
{
    //...
}

这个方法也是目前很多其他框架甚至微信官方的Demo使用的，但是这种方法我可以用“不美好”来形容。

不美——首先使用字符串拼接的方式非常丑陋，其次哪怕使用 XmlDocument 或 XDocument 等面向对象的方式去处理，面对几十种不同的微信消息类型以及一一对应的不同的格式，代码将变得非常冗长而且难以维护。这样的代码你的老板或客户会喜欢吗？

不好——这样的写法坏处太多：

• 可移植性差
• 并没有做到很好地分离（无论是和整个应用程序还是不同请求类型之间）
• 如果要做单元测试就必须整体代码一起上
• 基本上不具备可扩展性
• 容错能力很差，即使做到了，代码已经无法直视
• 正常人用多了会心情不好

那么，“美好”的消息处理方式应该是怎么样的呢？

下面就将 Senparc.Weixin.MP.MessageHandler 介绍给你。

首先，美好的 MessageHandler 必须具有对消息类型的自动识别和分类能力。

第二，美好的 MessageHandler 必须能够同时、自动处理“明文”“兼容模式”“加密模式”三种（所有）消息加密类型，并且让开发者忘掉加密这回事情的存在。

第三，美好的 MessageHandler 必须能够提供很好的消息容器以及储存容器，来解决消息去重、Session 等一系列的问题。

第四，美好的 MessageHandler 必须能够兼容 MVC 和 WebFroms 不同的请求处理方式。

第五，美好的 MessageHandler 必须能够提供统一逻辑处理的接口，方便在特定的环节对消息进行统一处理。

第六，美好的 MessageHandler 必须具备优秀的可测试性和扩展能力。

第七，美好的 MessageHandler 必须能做到很好的逻辑分离。

第八，美好的 MessageHandler 必须让你用起来心情好。

第九，美好的 MessageHandler 不能保证你能在 10 分钟内，完成一个满足以上八条的简单微信应用从开发到上线、发布的全过程。但是我们做到了。

消息类型

概述

微信的互动消息包含请求消息和响应消息两类：

• 请求消息：由微信服务器发送到应用服务器的消息（通常由用户微信操作触发或用户主动发送）。
  -响应消息：应用服务器收到请求消息之后，返回给微信服务器的消息。响应消息可以被转发到用户微信，也可以采用“沉默”的方式不给予响应。

所有的消息类型如图1所示（至本文发布，消息类型又丰富了许多）。

图1

无论是请求消息还是响应消息，各自还包括不同的消息类型，其中每一种消息类型，又都有不同的参数和对应的格式要求。

对应每一种消息具体的参数和 XML 格式可以参考微信官方Wiki，这里不再赘述。本书将重点针对面向对象的类展开介绍，使用 Senparc.Weixin SDK 的开发者基本上可以忘掉微信的 XML 格式和要求，只需要了解如何面向对象地处理消息。当然，对于 XML 的了解将帮助你更加从容地处理一些问题，例如测试和调试过程都可能需要用到 XML。

命名规则

为了可以使用 C# 面向对象地处理问题，同时也更加规范地进行编程，我们决定在一些地方改变微信原有的命名规则（全部使用小写，用下划线_分隔不同单词），而使用 C# 推荐的命名方式（Pascal 大小写命名法）来作为类名或属性名称。如微信文档中的属性或名称可能为 access_token，在 Senparc.Weixin 中将被命名为 AccessToken。当阅读微信官方的文档时理解这样的变化举一反三即可。

当然，这种改变是灵活的，有一些地方我们仍然需要保持参数名称的“原貌”来确保 JSON 和 XML 自动转换的准确性和稳定性。

这样的改变不仅出现在消息类型中，对本书后面会介绍的 API 和其他功能同样适用。
全局消息基类

在所有这些消息类型中，都具有一些相同的属性，因此在 MessageHandler 体系中，我们为所有的消息创建了一个基类 MessageBase ：

    /// <summary>
    /// 所有Request和Response消息的基类
    /// </summary>
    public abstract class MessageBase : IMessageBase
    {
        public string ToUserName { get; set; }
        public string FromUserName { get; set; }
        public DateTime CreateTime { get; set; }
    }

MessageBase将作为所有消息的基类，无论是请求消息还是响应消息，也无论是微信公众号还是企业号或开放平台等