mirror of
https://gitee.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat.git
synced 2025-07-17 01:46:20 +08:00
105 lines
3.2 KiB
Markdown
105 lines
3.2 KiB
Markdown
## 如何解析回调通知事件？
|
||
|
||
---
|
||
|
||
对于微信推送过来的回调通知事件，本库封装了直接解析成事件模型的扩展方法，下面给出一个示例代码：
|
||
|
||
```csharp
|
||
/* 如果是 JSON 格式的通知内容，以 wxa_media_check 事件为例 */
|
||
string callbackJson = "{ ... }";
|
||
var callbackModel = client.DeserializeEventFromJson<Events.WxaMediaCheckEvent>(callbackJson);
|
||
|
||
/* 如果是 XML 格式的通知内容，以 text 事件为例 */
|
||
string callbackXml = "<xml> ... </xml>";
|
||
var callbackModel = client.DeserializeEventFromXml<Events.TextMessageEvent>(callbackXml);
|
||
```
|
||
|
||
完整的回调通知模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.Api/Events_ 目录。
|
||
|
||
---
|
||
|
||
### 事件类型：
|
||
|
||
由于微信会将全部事件推送到同一个回调通知地址上，开发者需要根据事件类型才能决定如何反序列化。
|
||
|
||
这里给出两种解决方案。
|
||
|
||
一种是利用 `System.Xml.Linq`：
|
||
|
||
```csharp
|
||
XDocument xDoc = XDocument.Parse(callbackXml);
|
||
string msgType = xDoc.Root?.Element("MsgType")?.Value?.ToUpper();
|
||
```
|
||
|
||
另一种是利用本库的扩展方法：
|
||
|
||
```csharp
|
||
WechatApiEvent eventModel = client.DeserializeEventFromXml(callbackXml);
|
||
string msgType = eventModel.MessageType?.ToUpper();
|
||
|
||
switch (msgType)
|
||
{
|
||
case "TEXT":
|
||
{
|
||
var callbackModel = client.DeserializeEventFromXml<Events.TextMessageEvent>(callbackXml);
|
||
}
|
||
break;
|
||
// 省略其他情况
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
### 安全模式：
|
||
|
||
在安全模式下，微信公众平台使用了一种特殊的 AES 算法对回调通知事件加密。
|
||
|
||
开发者可利用本库提供的 `WxBizMsgCryptor` 工具类自行解密相关字段。
|
||
|
||
此外，本库还封装了直接解密事件的扩展方法，下面给出一个示例代码：
|
||
|
||
```csharp
|
||
/* 在初始化客户端时需指定服务器推送的相关参数 */
|
||
var options = new WechatApiClientOptions()
|
||
{
|
||
AppId = "微信 AppId",
|
||
AppSecret = "微信 AppSecret",
|
||
PushEncodingAESKey = "服务器推送的 EncodingAESKey",
|
||
PushToken = "服务器推送的 Token"
|
||
};
|
||
var client = new WechatApiClient(options);
|
||
|
||
/* 如果是 XML 格式的加密通知内容，以 text 事件为例 */
|
||
string callbackXml = "<xml> <Encrypt>...</Encrypt> </xml>";
|
||
var callbackModel = client.DeserializeEventFromXml<Events.TextMessageEvent>(callbackXml, safety: true);
|
||
```
|
||
|
||
---
|
||
|
||
### 被动回复：
|
||
|
||
当用户发送消息给公众号、或某些特定的用户操作引发的事件推送时，开发者可以在响应中返回特定 XML 结构，来对该消息进行响应。
|
||
|
||
本库还封装了直接序列化被动回复事件的扩展方法，下面给出一个示例代码：
|
||
|
||
```csharp
|
||
/* 以被动回复文本消息为例 */
|
||
var replyModel = new Events.TextMessageReply()
|
||
{
|
||
ToUserName = "接收方 OpenId",
|
||
FromUserName = "开发者 GhId",
|
||
MessageType = "text",
|
||
Content = "被动回复的文本内容",
|
||
CreateTimestamp = 1234567890
|
||
};
|
||
string replyXml = client.SerializeEventToXml(replyModel);
|
||
```
|
||
|
||
如果是在安全模式下，那么可以：
|
||
|
||
```csharp
|
||
string replyXml = client.SerializeEventToXml(replyModel, safety: true);
|
||
```
|
||
|
||
完整的被动回复模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.Api/Events/MpReply_ 目录。
|