C#微信公眾號開發之接收事件推送與消息排重的方法

2020-01-24 02:11:28

字體：大中小

來源：轉載

供稿：網友

本文實例講述了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);
            }
        }
}