利用C#開發微信公眾號之接收事件推播與訊息排重的方法介紹
- 高洛峰原創
- 2017-03-19 18:00:561457瀏覽
這篇文章主要介紹利用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，用來儲存訊息列表，清單的類型是Listf822bda892e76d613fb5d807a4e9e7c8.
在處理微信訊息體前，先判斷列表是否實例化，如果沒有實例化則實例化，否則判斷列表的長度是否大於或等於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#開發微信公眾號之接收事件推播與訊息排重的方法介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！