各种消息交互

简介

TNWX: TypeScript + Node.js + WeiXin 微信系开发脚手架，支持微信公众号、微信支付、微信小游戏、微信小程序、企业号/企业微信。最最最重要的是能快速的集成至任何 Node.js 框架(Express、Nest、Egg、Koa 等)

测试号申请

测试时请自己的测试号各种消息交互 - 图1

开启开发者模式

这里说的各种消息交互是指的 开发者模式下的消息交互 如何开启开发者模式

接收各种消息

在 TNWX 中实现微信公众号各种消息交互非常简单，步骤如下：

  • 接收各种消息
  • 调用 WeChat.handleMsg(…) 方法处理分发消息
  • 实现 MsgAdapter 接口，实现业务逻辑以及各种消息回复 开发者 URL 的 POST 方法下接收各种消息 具体实现代码如下

Express 示例

  1. // 接收微信消息入口
  2. app.post('/msg', function (req: any, res: any) {
  3.     console.log('post...', req.query);
  4.         // 支持多公众号
  5.     let appId: string = req.query.appId;
  6.     if (appId) {
  7.         ApiConfigKit.setCurrentAppId(appId);
  8.     }
  9.         // 获取签名相关的参数用于消息解密(测试号以及明文模式无此参数)
  10.     let msgSignature = req.query.msg_signature,
  11.         timestamp = req.query.timestamp,
  12.         nonce = req.query.nonce;
  14.     //监听 data 事件 用于接收数据
  15.     let buffer: Uint8Array[] = [];
  16.     req.on('data', function (data: any) {
  17.         buffer.push(data);
  18.     });
  20.     req.on('end', function () {
  21.         let msgXml = Buffer.concat(buffer).toString('utf-8');
  22.         // 处理消息并响应对应的回复
  23.         // ....
  24.     });
  25. });

Nest 示例

  1. @Post("/msg")
  2.   PostMsg(@Req() req: Request, @Res() res: Response) {
  3.     let that = this;
  4.     console.log('post...', req.query);
  5.         // 支持多公众号
  6.     let appId: string = req.query.appId;
  7.     if (appId) {
  8.       ApiConfigKit.setCurrentAppId(appId);
  9.     }
  10.         // 获取签名相关的参数用于消息解密(测试号以及明文模式无此参数)
  11.     let msgSignature = req.query.msg_signature,
  12.       timestamp = req.query.timestamp,
  13.       nonce = req.query.nonce;
  15.     //监听 data 事件 用于接收数据
  16.     let buffer: Uint8Array[] = [];
  17.     req.on('data', function (data: any) {
  18.       buffer.push(data);
  19.     });
  21.     req.on('end', function () {
  22.       let msgXml = Buffer.concat(buffer).toString('utf-8');
  23.       // 处理消息并响应对应的回复
  24.       // ...
  25.     });
  26.   }

处理并分发消息

  1. WeChat.handleMsg(msgAdapter: MsgAdapter, msgXml: string, msgSignature?: string, timestamp?: string, nonce?: string)

handleMsg 中包含了消息的解密、各种消息分发、消息加密、各种消息回复。这里就不贴源码了，感兴趣的可以看看源码，源码也有详细的注释。

Gitee-TNWX-WeChat各种消息交互 - 图2

GitHub-TNWX-WeChat各种消息交互 - 图3

其中 msgXml 、msgSignature、timestamp 、nonce 已在上面的 接收各种消息中 获得，就差 MsgAdapter 了。

MsgAdapter 介绍

MsgAdapter 接口中定义的方法如下：

  1. export interface MsgAdapter {
  2.     // 处理文本消息
  3.     processInTextMsg(inTextMsg: InTextMsg): OutMsg;
  4.     // 处理图片消息
  5.     processInImageMsg(inImageMsg: InImageMsg): OutMsg;
  6.     // 处理声音消息
  7.     processInVoiceMsg(inVoiceMsg: InVoiceMsg): OutMsg;
  8.     // 处理视频消息
  9.     processInVideoMsg(inVideoMsg: InVideoMsg): OutMsg;
  10.     // 处理小视频消息
  11.     processInShortVideoMsg(inShortVideoMsg: InShortVideoMsg): OutMsg;
  12.     // 处理地理位置消息
  13.     processInLocationMsg(inLocationMsg: InLocationMsg): OutMsg;
  14.     // 处理链接消息
  15.     processInLinkMsg(inLinkMsg: InLinkMsg): OutMsg;
  16.     // 处理语音识别结果
  17.     processInSpeechRecognitionResults(inSpeechRecognitionResults: InSpeechRecognitionResults): OutMsg;
  18.     // 处理未定义的消息(其他消息...小哥该扩展了)
  19.     processIsNotDefinedMsg(inNotDefinedMsg: InNotDefinedMsg): OutMsg;
  21.     // 处理关注、取消关注事件
  22.     processInFollowEvent(inFollowEvent: InFollowEvent): OutMsg;
  23.     // 处理扫码事件
  24.     processInQrCodeEvent(inQrCodeEvent: InQrCodeEvent): OutMsg;
  25.     // 处理地理位置事件
  26.     processInLocationEvent(inLocationEvent: InLocationEvent): OutMsg;
  27.     // 处理地理位置事件
  28.     processInMenuEvent(inMenuEvent: InMenuEvent): OutMsg;
  29.     // 处理模板消息事件
  30.     processInTemplateMsgEvent(inTemplateMsgEvent: InTemplateMsgEvent): OutMsg;
  31.     // 处理摇一摇周边事件
  32.     processInShakearoundUserShakeEvent(inShakearoundUserShakeEvent: InShakearoundUserShakeEvent): OutMsg;
  33. }

InXxxxMsg 统一继承自 InMsg ，InXxxxEvent 统一继承自 EventInMsg 而 EventInMsg 又继承自 InMsg ，所以在任何的 inXxxxx 中都很容易获取到 toUserName(开发者微信号即appId)、 fromUserName(发送方帐号openId) 。 TNWX 支持多公众号，后面会使用到此 appId 来实现不同公众号回复不同的消息

响应对应的回复

代码实现比较简单就不过多介绍了，请看源码

提醒：回复消息时可以对不同的公众号做特殊的处理

  1. export class MsgController implements MsgAdapter {
  3.     processInTextMsg(inTextMsg: InTextMsg): OutMsg {
  4.         let outMsg: any;
  5.         let content: string = "IJPay 让支付触手可及 \n\nhttps://gitee.com/javen205/IJPay";
  6.         if ("极速开发微信公众号" == inTextMsg.getContent) {
  7.             // 多公众号支持 分别给不同的公众号发送不同的消息
  8.             if (ApiConfigKit.getApiConfig.getAppId == 'wx614c453e0d1dcd12') {
  9.                 content = "极速开发微信公众号 \n\nhttps://github.com/javen205/weixin_guide"
  10.                 outMsg = new OutTextMsg(inTextMsg);
  11.                 outMsg.setContent(content);
  12.             } else {
  13.                 content = "极速开发微信公众号 \n\nhttps://github.com/javen205/TNWX"
  14.                 outMsg = new OutTextMsg(inTextMsg);
  15.                 outMsg.setContent(content);
  16.             }
  18.         } else if ("聚合支付" == inTextMsg.getContent) {
  19.               // 最新规则：开发者只能回复1条图文消息；其余场景最多可回复8条图文消息
  20.             outMsg = new OutNewsMsg(inTextMsg);
  21.             outMsg.addArticle("聚合支付了解下", "IJPay 让支付触手可及",
  22.                 "https://gitee.com/javen205/IJPay/raw/master/assets/img/IJPay-t.png", "https://gitee.com/javen205/IJPay")
  23.             outMsg.addArticle("jfinal-weixin", "极速开发微信公众号",
  24.                 "https://gitee.com/javen205/IJPay/raw/master/assets/img/IJPay-t.png", "https://gitee.com/JFinal/jfinal-weixin")
  25.         } else {
  26.             // outMsg = new OutTextMsg(inTextMsg);
  27.             // outMsg.setContent(content);
  28.             // 转发给多客服PC客户端
  29.             outMsg = new OutCustomMsg(inTextMsg);
  30.             console.log("转发给多客服PC客户端");
  32.         }
  33.         return outMsg;
  34.     }
  36.     processInImageMsg(inImageMsg: InImageMsg): OutMsg {
  37.         let outMsg = new OutImageMsg(inImageMsg);
  38.         outMsg.setMediaId = inImageMsg.getMediaId;
  39.         return outMsg;
  40.     }
  41.     processInVoiceMsg(inVoiceMsg: InVoiceMsg): OutMsg {
  42.         let outMsg = new OutVoiceMsg(inVoiceMsg);
  43.         outMsg.setMediaId = inVoiceMsg.getMediaId;
  44.         return outMsg;
  45.     }
  46.     processInVideoMsg(inVideoMsg: InVideoMsg): OutMsg {
  47.         let outMsg = new OutVideoMsg(inVideoMsg);
  48.         outMsg.setMediaId = inVideoMsg.getMediaId;
  49.         outMsg.setDescription = "IJPay 让支付触手可及";
  50.         outMsg.setTitle = "视频消息";
  51.         return outMsg;
  52.     }
  53.     processInShortVideoMsg(inShortVideoMsg: InShortVideoMsg): OutMsg {
  54.         let outMsg = new OutVideoMsg(inShortVideoMsg);
  55.         outMsg.setMediaId = inShortVideoMsg.getMediaId;
  56.         outMsg.setDescription = "TypeScript + Node.js 开发微信公众号";
  57.         outMsg.setTitle = "短视频消息";
  58.         return outMsg;
  59.     }
  60.     processInLocationMsg(inLocationMsg: InLocationMsg): OutMsg {
  61.         return this.renderOutTextMsg(inLocationMsg,
  62.             "位置消息... \n\nX:" + inLocationMsg.getLocation_X + " Y:" + inLocationMsg.getLocation_Y + "\n\n" + inLocationMsg.getLabel);
  63.     }
  64.     processInLinkMsg(inLinkMsg: InLinkMsg): OutMsg {
  65.         let text = new OutTextMsg(inLinkMsg);
  66.         text.setContent("链接频消息..." + inLinkMsg.getUrl);
  67.         return text;
  68.     }
  69.     processInSpeechRecognitionResults(inSpeechRecognitionResults: InSpeechRecognitionResults): OutMsg {
  70.         let text = new OutTextMsg(inSpeechRecognitionResults);
  71.         text.setContent("语音识别消息..." + inSpeechRecognitionResults.getRecognition);
  72.         return text;
  73.     }
  75.     processInFollowEvent(inFollowEvent: InFollowEvent): OutMsg {
  77.         if (InFollowEvent.EVENT_INFOLLOW_SUBSCRIBE == inFollowEvent.getEvent) {
  78.             return this.renderOutTextMsg(inFollowEvent,
  79.                 "感谢你的关注 么么哒 \n\n交流群：114196246");
  80.         }
  81.         else if (InFollowEvent.EVENT_INFOLLOW_UNSUBSCRIBE == inFollowEvent.getEvent) {
  82.             console.error("取消关注：" + inFollowEvent.getFromUserName);
  83.             return this.renderOutTextMsg(inFollowEvent);
  84.         } else {
  85.             return this.renderOutTextMsg(inFollowEvent);
  86.         }
  87.     }
  89.     processInQrCodeEvent(inQrCodeEvent: InQrCodeEvent): OutMsg {
  90.         if (InQrCodeEvent.EVENT_INQRCODE_SUBSCRIBE == inQrCodeEvent.getEvent) {
  91.             console.debug("扫码未关注：" + inQrCodeEvent.getFromUserName);
  92.             return this.renderOutTextMsg(inQrCodeEvent,
  93.                 "感谢您的关注，二维码内容：" + inQrCodeEvent.getEventKey);
  94.         }
  95.         else if (InQrCodeEvent.EVENT_INQRCODE_SCAN == inQrCodeEvent.getEvent) {
  96.             console.debug("扫码已关注：" + inQrCodeEvent.getFromUserName);
  97.             return this.renderOutTextMsg(inQrCodeEvent);
  98.         } else {
  99.             return this.renderOutTextMsg(inQrCodeEvent);
  100.         }
  101.     }
  102.     processInLocationEvent(inLocationEvent: InLocationEvent): OutMsg {
  103.         console.debug("发送地理位置事件：" + inLocationEvent.getFromUserName);
  105.         return this.renderOutTextMsg(inLocationEvent,
  106.             "地理位置是：" + inLocationEvent.getLatitude);
  107.     }
  108.     processInMenuEvent(inMenuEvent: InMenuEvent): OutMsg {
  109.         console.debug("菜单事件：" + inMenuEvent.getFromUserName);
  111.         return this.renderOutTextMsg(inMenuEvent,
  112.             "菜单事件内容是：" + inMenuEvent.getEventKey);
  113.     }
  114.     processInTemplateMsgEvent(inTemplateMsgEvent: InTemplateMsgEvent): OutMsg {
  115.         console.debug("模板消息事件：" + inTemplateMsgEvent.getFromUserName + " " + inTemplateMsgEvent.getStatus);
  116.         return this.renderOutTextMsg(inTemplateMsgEvent,
  117.             "消息发送状态：" + inTemplateMsgEvent.getStatus);
  118.     }
  120.     processInShakearoundUserShakeEvent(inShakearoundUserShakeEvent: InShakearoundUserShakeEvent): OutMsg {
  121.         console.debug("摇一摇事件：" + inShakearoundUserShakeEvent.getFromUserName + " " + inShakearoundUserShakeEvent.getUuid);
  122.         return this.renderOutTextMsg(inShakearoundUserShakeEvent,
  123.             "uuid：" + inShakearoundUserShakeEvent.getUuid);
  124.     }
  126.     processIsNotDefinedMsg(inNotDefinedMsg: InNotDefinedMsg): OutMsg {
  127.         return this.renderOutTextMsg(inNotDefinedMsg,
  128.             "未知消息");
  129.     }
  131.     renderOutTextMsg(inMsg: InMsg, content?: string): OutTextMsg {
  132.         let outMsg = new OutTextMsg(inMsg);
  133.         outMsg.setContent(content ? content : " ");
  134.         return outMsg;
  135.     }
  136. }

开源推荐