C#微信公众号开发之接收事件推送与消息排重的方法

本文实例讲述了c#微信公众号开发之接收事件推送与消息排重的方法。分享给大家供大家参考。具体分析如下：

微信服务器在5秒内收不到响应会断掉连接，并且重新发起请求，总共重试三次。这样的话，问题就来了。有这样一个场景：当用户关注微信账号时，获取当前用户信息，然后将信息写到数据库中。类似于pc端网站的注册。可能由于这个关注事件中，我们需要处理的业务逻辑比较复杂。如送积分啊，写用户日志啊，分配用户组啊。等等……一系列的逻辑需要执行，或者网络环境比较复杂，无法保证5秒内响应当前用户的操作，那如果当操作尚未完成，微信服务器又给我们的服务器推送了一条相同的关注事件，我们将再次执行我们的那些逻辑，这样就有可能导致数据库中出现重复的数据（有的童鞋就会说了，我在插入数据之前先判断当前是否已经存在了，如果存在了就不执行插入的操作。我想说的是，我当初也是这样想的，但真实的运行环境和我们的调试环境还是有差距的，直到发现数据库中有不少重复的用户信息时，我才发现消息去重的重要性。）。

 
消息的去重普通消息和事件消息是有区别的。普通消息使用msgid,而事件消息使用fromusername + createtime。我的思路是：
 
新建类basemsg，有三个属性分别是fromuser，msgflag，createtime。代码如下：

public class basemsg
{
        /// <summary>
        /// 发送者标识
        /// </summary>
        public string fromuser { get; set; }
        /// <summary>
        /// 消息表示。普通消息时，为msgid，事件消息时，为事件的创建时间
        /// </summary>
        public string msgflag { get; set; }
        /// <summary>
        /// 添加到队列的时间
        /// </summary>
        public datetime createtime { get; set; }
}

 
创建个静态列表_queue，用来存储消息列表，列表的类型是list<basemsg>.
在处理微信消息体前，首先判断列表是否实例化，如果没有实例化则实例化，否则判断列表的长度是否大于或等于50（这个可以自定义，用处就是微信并发的消息量），如果大于或等于50，则保留20秒内未响应的消息（5秒重试一次，总共重试3次，就是15秒，保险起见这里写20秒）。
获取当前消息体的消息类型，并根据_queue判断当前消息是否已经请求了。如果是事件则保存fromuser和创建时间。如果是普通消息则保存msgflag。下面是代码：

if (_queue == null)
{
 _queue = new list<basemsg>();
}
else if(_queue.count>=50)
{
 _queue = _queue.where(q => { return q.createtime.addseconds(20) > datetime.now; }).tolist();//保留20秒内未响应的消息
}
xelement xdoc = xelement.parse(xml);
var msgtype = xdoc.element("msgtype").value.toupper();
var fromusername = xdoc.element("fromusername").value;
var msgid = xdoc.element("msgid").value;
var createtime = xdoc.element("createtime").value;
msgtype type = (msgtype)enum.parse(typeof(msgtype), msgtype);
if (type!=msgtype.event)
{
 if (_queue.firstordefault(m => { return m.msgflag == msgid; }) == null)
 {
     _queue.add(new basemsg
     {
  createtime = datetime.now,
  fromuser = fromusername,
  msgflag = msgid
     });
 }
 else
 {
     return null;
 }
      
}
else
{
 if (_queue.firstordefault(m => { return m.msgflag == createtime; }) == null)
 {
     _queue.add(new basemsg
     {
  createtime = datetime.now,
  fromuser = fromusername,
  msgflag = createtime
     });
 }
 else
 {
     return null;
 }
}

 
当消息已经存在队列中时，则不转换当前的消息为实体了，直接返回null，调用的时候，当返回null时就不做任何处理。
 
下面开始讲解事件消息。接上篇讲。所有的消息都继承basemessage，而所有的事件类型都包含一个event的属性。这里为了方便调用，将消息

/// <summary>
/// 事件类型枚举
/// </summary>
public enum event
{
        /// <summary>
        /// 非事件类型
        /// </summary>
        noevent,
        /// <summary>
        /// 订阅
        /// </summary>
        subscribe,
        /// <summary>
        /// 取消订阅
        /// </summary>
        unsubscribe,
        /// <summary>
        /// 扫描带参数的二维码
        /// </summary>
        scan,
        /// <summary>
        /// 地理位置
        /// </summary>
        location,
        /// <summary>
        /// 单击按钮
        /// </summary>
        click,
        /// <summary>
        /// 链接按钮
        /// </summary>
        view,
        /// <summary>
        /// 扫码推事件
        /// </summary>
        scancode_push,
        /// <summary>
        /// 扫码推事件且弹出“消息接收中”提示框
        /// </summary>
        scancode_waitmsg,
        /// <summary>
        /// 弹出系统拍照发图
        /// </summary>
        pic_sysphoto,
        /// <summary>
        /// 弹出拍照或者相册发图
        /// </summary>
        pic_photo_or_album,
        /// <summary>
        /// 弹出微信相册发图器
        /// </summary>
        pic_weixin,
        /// <summary>
        /// 弹出地理位置选择器
        /// </summary>
        location_select,
        /// <summary>
        /// 模板消息推送
        /// </summary>
        templatesendjobfinish
}

 
定义好枚举后，就是定义消息实体了。
 
关注/取消关注事件
xml数据包如下：

<xml>
<tousername><![cdata[touser]]></tousername>
<fromusername><![cdata[fromuser]]></fromusername>
<createtime>123456789</createtime>
<msgtype><![cdata[event]]></msgtype>
<event><![cdata[subscribe]]></event>
</xml>

 
对应的实体：

/// <summary>
/// 订阅/取消订阅事件
/// </summary>
public class subeventmessage : eventmessage
{
        private string _eventkey;
        /// <summary>
        /// 事件key值，qrscene_为前缀，后面为二维码的参数值（已去掉前缀，可以直接使用）
        /// </summary>
        public string eventkey
        {
            get { return _eventkey; }
            set { _eventkey = value.replace("qrscene_", ""); }
        }
        /// <summary>
        /// 二维码的ticket，可用来换取二维码图片
        /// </summary>
        public string ticket { get; set; }
}

 
这里需要注意的是，当用户扫描带参数的二维码时，如果用户没有关注当前公众号，用户关注时，会在消息体中带上qrscene_参数，和ticket，所以这里定义了两个属性：eventkey，ticket。当给eventkey赋值时，替换掉qrscene_，因为我们真正需要的就是后面的参数。
 
扫描带参数二维码事件
用户扫描带场景值二维码时，可能推送一下两种事件：
 
如果用户还未关注公众号，则用户可以关注公众号，关注后微信会将带场景值关注事件推送给开发者。
如果用户已经关注公众号，则微信会将带场景值扫描事件推送给开发者。、
第一种上面已经讲了，这里就只说明下第二种。
 
用户已关注时的事件推送
 
xml包如下：

<xml>
<tousername><![cdata[touser]]></tousername>
<fromusername><![cdata[fromuser]]></fromusername>
<createtime>123456789</createtime>
<msgtype><![cdata[event]]></msgtype>
<event><![cdata[scan]]></event>
<eventkey><![cdata[scene_value]]></eventkey>
<ticket><![cdata[ticket]]></ticket>
</xml>

 
对应的实体如下：

/// <summary>
/// 扫描带参数的二维码实体
/// </summary>
public class scaneventmessage : eventmessage
{
 
        /// <summary>
        /// 事件key值，是一个32位无符号整数，即创建二维码时的二维码scene_id
        /// </summary>
        public string eventkey { get; set; }
        /// <summary>
        /// 二维码的ticket，可用来换取二维码图片
        /// </summary>
        public string ticket { get; set; }
}

 
上报地理位置事件
当公众号开启上报地理位置功能后，每次进入公众号会话时，用户同意上报地理位置后，都会在进入时上报地理位置，或在进入回话后每5秒上报一次地理位置，公众号可以再公众平台的后台中修改设置。上报地理位置时，微信会将上报地理位置事件推送到开发者填写的url。
 
xml数据包如下：

<xml>
<tousername><![cdata[touser]]></tousername>
<fromusername><![cdata[fromuser]]></fromusername>
<createtime>123456789</createtime>
<msgtype><![cdata[event]]></msgtype>
<event><![cdata[location]]></event>
<latitude>23.137466</latitude>
<longitude>113.352425</longitude>
<precision>119.385040</precision>
</xml>

 
对应的实体如下：

/// <summary>
/// 上报地理位置实体
/// </summary>
public class locationeventmessage : eventmessage
{
 
        /// <summary>
        /// 地理位置纬度
        /// </summary>
        public string latitude { get; set; }
        /// <summary>
        /// 地理位置经度
        /// </summary>
        public string longitude { get; set; }
       /// <summary>
        /// 地理位置精度
       /// </summary>
        public string precision { get; set; }
}

 
自定义菜单事件常用的事件有：click，view，scancode_puth，scancode_waitmsg，location_select。另外还有三种发图的事件，由于并不常用，笔者也没想到使用场景，再次就不一一讲述了，有兴趣的可以自己研究下，或者和我进行交流。
 
click事件推送的xml数据包：

<xml>
<tousername><![cdata[touser]]></tousername>
<fromusername><![cdata[fromuser]]></fromusername>
<createtime>123456789</createtime>
<msgtype><![cdata[event]]></msgtype>
<event><![cdata[click]]></event>
<eventkey><![cdata[eventkey]]></eventkey>
</xml>

 
view事件推送的xml数据包和click的格式是一样的，所以定义一个类就可以了，如下：

/// <summary>
/// 普通菜单事件，包括click和view
/// </summary>
public class normalmenueventmessage : eventmessage
{
 
        /// <summary>
        /// 事件key值，设置的跳转url
        /// </summary>
        public string eventkey { get; set; }
}

 
scancode事件的xml数据包如下：

<xml><tousername><![cdata[tousername]]></tousername>
<fromusername><![cdata[fromusername]]></fromusername>
<createtime>1419265698</createtime>
<msgtype><![cdata[event]]></msgtype>
<event><![cdata[scancode_push]]></event>
<eventkey><![cdata[eventkey]]></eventkey>
<scancodeinfo><scantype><![cdata[qrcode]]></scantype>
<scanresult><![cdata[http://weixin.qq.com/r/jey5orle0u_urvbc9xk2]]></scanresult>
</scancodeinfo>
</xml>

 
对应的实体如下：

/// <summary>
/// 菜单扫描事件
/// </summary>
public class scanmenueventmessage : eventmessage
{
 
        /// <summary>
        /// 事件key值
        /// </summary>
        public string eventkey { get; set; }
        /// <summary>
        /// 扫码类型。qrcode是二维码，其他的是条码
        /// </summary>
        public string scantype { get; set; }
        /// <summary>
        /// 扫描结果
        /// </summary>
        public string scanresult { get; set; }
}

 
至此，当前常用的事件类型消息都已定义完毕，结合上一篇所讲的，将xml数据包转换成对象的完整代码如下：

public class messagefactory
{
        private static list<basemsg> _queue;
        public static basemessage createmessage(string xml)
        {
            if (_queue == null)
            {
                _queue = new list<basemsg>();
            }
            else if(_queue.count>=50)
            {
                _queue = _queue.where(q => { return q.createtime.addseconds(20) > datetime.now; }).tolist();//保留20秒内未响应的消息
            }
            xelement xdoc = xelement.parse(xml);
            var msgtype = xdoc.element("msgtype").value.toupper();
            var fromusername = xdoc.element("fromusername").value;
            var msgid = xdoc.element("msgid").value;
            var createtime = xdoc.element("createtime").value;
            msgtype type = (msgtype)enum.parse(typeof(msgtype), msgtype);
            if (type!=msgtype.event)
            {
                if (_queue.firstordefault(m => { return m.msgflag == msgid; }) == null)
                {
                    _queue.add(new basemsg
                    {
                        createtime = datetime.now,
                        fromuser = fromusername,
                        msgflag = msgid
                    });
                }
                else
                {
                    return null;
                }
              
            }
            else
            {
                if (_queue.firstordefault(m => { return m.msgflag == createtime; }) == null)
                {
                    _queue.add(new basemsg
                    {
                        createtime = datetime.now,
                        fromuser = fromusername,
                        msgflag = createtime
                    });
                }
                else
                {
                    return null;
                }
            }
            switch (type)
            {
                case msgtype.text: return utils.convertobj<textmessage>(xml);
                case msgtype.image: return utils.convertobj<imgmessage>(xml);
                case msgtype.video: return utils.convertobj<videomessage>(xml);
                case msgtype.voice: return utils.convertobj<voicemessage>(xml);
                case msgtype.link:
                    return utils.convertobj<linkmessage>(xml);
                case msgtype.location:
                    return utils.convertobj<locationmessage>(xml);
                case msgtype.event://事件类型
                {
                    var eventtype = (event)enum.parse(typeof(event), xdoc.element("event").value.toupper());
                    switch (eventtype)
                    {
                        case event.click:
                            return utils.convertobj<normalmenueventmessage>(xml);
                        case event.view: return utils.convertobj<normalmenueventmessage>(xml);
                        case event.location: return utils.convertobj<locationeventmessage>(xml);
                        case event.location_select: return utils.convertobj<locationmenueventmessage>(xml);
                        case event.scan: return utils.convertobj<scaneventmessage>(xml);
                        case event.subscribe: return utils.convertobj<subeventmessage>(xml);
                        case event.unsubscribe: return utils.convertobj<subeventmessage>(xml);
                        case event.scancode_waitmsg: return utils.convertobj<scanmenueventmessage>(xml);
                        default:
                            return utils.convertobj<eventmessage>(xml);
                    }
                } break;
                default:
                    return utils.convertobj<basemessage>(xml);
            }
        }
}

希望本文所述对大家基于c#的微信开发有所帮助。