公众号及小程序的微信接口是通过 xml 格式进行数据交换的。

比如接收普通消息的接口:

当普通微信用户向公众账号发消息时,微信服务器将 POST 消息的 XML 数据包到开发者填写的 URL 上。

-- 微信官方文档 - 接收普通消息

<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1348831860</CreateTime>
<MsgType><![CDATA[text]]></MsgType>
<Content><![CDATA[this is a test]]></Content>
<MsgId>1234567890123456</MsgId>
</xml>

不仅微信端推送给我们的数据是 XML 类型的,我们调用微信接口,也需要传递 XML 类型的数据。

比如被动回复用户消息:

当用户发送消息给公众号时(或某些特定的用户操作引发的事件推送时),会产生一个 POST 请求,开发者可以在响应包(Get)中返回特定 XML 结构,来对该消息进行响应(现支持回复文本、图片、图文、语音、视频、音乐)。严格来说,发送被动响应消息其实并不是一种接口,而是对微信服务器发过来消息的一次回复。

-- 微信官方文档 - 被动回复用户消息

<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>12345678</CreateTime>
<MsgType><![CDATA[text]]></MsgType>
<Content><![CDATA[你好]]></Content>
</xml>

因此,不同于常见的 JSON,要求我们在接口中需要处理 XML 格式的数据。

创建示例项目

使用 Nest 的命令行工具创建一个示例项目用于后面的演示。

$ nest n xml-handling

XML 数据的接收

接收和处理 XML 类型的数据,可使用 body-parser-xml

安装依赖

$ yarn add body-parser body-parser-xml

启用 body-parser 中间件

使用上面的中间件对请求传递的 XML 数据进行解析。

src/main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module'; const bodyParser = require('body-parser');
require('body-parser-xml')(bodyParser); async function bootstrap() {
const app = await NestFactory.create(AppModule); app.use(
bodyParser.xml({
xmlParseOptions: {
explicitArray: false, // 始终返回数组。默认情况下只有数组元素数量大于 1 是才返回数组。
},
}),
); await app.listen(3000);
}
bootstrap();

接收并处理 XML 数据

假设配置的是微信在收到用户消息时,调用我们的 wxhandler 接口。

src/app.controller.ts

import { Body, Controller, Logger, Post } from '@nestjs/common';
import { inspect } from 'util'; /**
* 微信回调给开发者的消息
*/
interface IWxMessageXmlData {
/** 开发者微信号 e.g. `gh_019087f88815`*/
ToUserName: string;
/** 发送方帐号(一个OpenID)e.g.: `o5w5awUl***5pIJKY`*/
FromUserName: string;
/** 消息创建时间 (整型)e.g.`1595855711` */
CreateTime: string;
/** 消息类型,此处为 `event` */
MsgType: string;
/** 事件类型,subscribe(订阅)、unsubscribe(取消订阅) */
Event: 'subscribe' | 'unsubscribe';
/** 事件KEY值,目前无用 */
EventKey: string;
} @Controller()
export class AppController {
@Post('wxhandler')
async wxhandler(@Body('xml') xmlData: IWxMessageXmlData) {
Logger.log(`xml data got: ${inspect(xmlData)}`);
return '';
}
}

测试:

$ curl --location --request POST 'localhost:3000/wxhandler' \
--header 'Content-Type: application/xml' \
--data-raw '<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1348831860</CreateTime>
<MsgType><![CDATA[text]]></MsgType>
<Content><![CDATA[this is a test]]></Content>
<MsgId>1234567890123456</MsgId>
</xml>'

从打印的日志中查看解析后的 XML 数据:

[Nest] 89424   - 10/19/2020, 7:58:00 PM   xml data got:
{ ToUserName: 'toUser',
FromUserName: 'fromUser',
CreateTime: '1348831860',
MsgType: 'text',
Content: 'this is a test',
MsgId: '1234567890123456' }
+3850ms

XML 数据的返回

让接口响应 XML 数据,需要我们在代码中先创建该类型的数据,可通过 xmlbuilder2 来进行。

安装依赖

$ yarn add xmlbuilder2

使用 xmlbuilder2 创建 XML 数据

通过上述工具进行 XML 的创建然后作为请求的响应。

src/app.controller.ts

import { Body, Controller, Logger, Post } from '@nestjs/common';
import { inspect } from 'util';
+ import { create } from 'xmlbuilder2'; @Controller()
export class AppController {
@Post('wxhandler')
async wxhandler(@Body('xml') xmlData: IWxMessageXmlData) {
Logger.log(`xml data got:\n ${inspect(xmlData)}\n`);
+ const res = create({
+ xml: {
+ ToUserName: 'openid_xxx', // 接收方帐号(收到的OpenID)
+ FromUserName: 'openod_yyy', // 开发者微信号
+ CreateTime: new Date().getTime(), // 消息创建时间 (整型)
+ MsgType: 'text',
+ Content: 'some text',
+ },
+ }).end({ prettyPrint: true });
return res;
}
}

测试并查看返回:

$ curl --location --request POST 'localhost:3000/wxhandler' \
--header 'Content-Type: application/xml' \
--data-raw '<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1348831860</CreateTime>
<MsgType><![CDATA[text]]></MsgType>
<Content><![CDATA[this is a test]]></Content>
<MsgId>1234567890123456</MsgId>
</xml>'
<?xml version="1.0"?>
<xml>
<ToUserName>openid_xxx</ToUserName>
<FromUserName>openod_yyy</FromUserName>
<CreateTime>1603109187287</CreateTime>
<MsgType>text</MsgType>
<Content>some text</Content>
</xml>⏎

示例代码

以上代码可在这个示例仓库 wayou/xml-handling 中找到。

相关资源

The text was updated successfully, but these errors were encountered:

Nest 中处理 XML 类型的请求与响应的更多相关文章

  1. Spring Boot 2.x基础教程:如何扩展XML格式的请求和响应

    在之前的所有Spring Boot教程中,我们都只提到和用到了针对HTML和JSON格式的请求与响应处理.那么对于XML格式的请求要如何快速的在Controller中包装成对象,以及如何以XML的格式 ...

  2. 知方可补不足~sqlserver中对xml类型字段的操作

    回到目录 在sqlserver中有很多种数据类型,而XML数据类型是比较新奇怪的一种格式,我们平常接触的可能比较少,用的也少,而在某些场合,使用XML类型可能会使我们的开发变简单,下面就是一种情况: ...

  3. T-SQL——关于XML类型

    目录 0. 将结果集转化为XML格式 1. 列值拼接为字符串 2. 字符串转换为列值 3. 一些说明 参考 志铭-2021年10月23日 10:43:21 0. 将结果集转化为XML格式 测试数据 I ...

  4. HTTP协议简介详解 HTTP协议发展 原理 请求方法 响应状态码 请求头 请求首部 java模拟浏览器客户端服务端

    协议简介 协议,自然语言里面就是契约,也是双方或者多方经过协商达成的一致意见; 契约也即类似于合同,自然有甲方123...,乙方123...,哪些能做,哪些不能做; 通信协议,也即是双方通过网络通信必 ...

  5. Java Servlet (1) —— Filter过滤请求与响应

    Java Servlet (1) -- Filter过滤请求与响应 版本: Java EE 6 参考来源: Oracle:The Java EE 6 Tutorial: Filtering Reque ...

  6. Fiddler之模拟响应、修改请求或响应数据(断点)

    在测试过程中,有时候需要修改请求或响应数据,或者直接模拟服务器响应,此时可以使用fiddler进行此类操作.可以使用断点功能完成. 一.修改请求数据 在发起请求后,需要修改请求的数据时,可以设置请求前 ...

  7. Spring Boot中如何扩展XML请求和响应的支持

    在之前的所有Spring Boot教程中,我们都只提到和用到了针对HTML和JSON格式的请求与响应处理.那么对于XML格式的请求要如何快速的在Controller中包装成对象,以及如何以XML的格式 ...

  8. Spring Boot中扩展XML请求和响应的支持

    在Spring Boot中,我们大多时候都只提到和用到了针对HTML和JSON格式的请求与响应处理.那么对于XML格式的请求要如何快速的在Controller中包装成对象,以及如何以XML的格式返回一 ...

  9. struts.xml中的结果类型与视图

    实际上在Struts2框架中,一个完整的结果视图配置文件应该是: ? 1 2 3 4 5 <action name="Action名称" class="Action ...

随机推荐

  1. 优化程序性能(CSAPP)

    [前言]虽然现在没有接触过大型项目,但是工作了会注重性能.学习一下,应该能更好更快的理解别人写的经典优化的代码.结合CSAPP和自己的理解,总结一下. 一.程序优化综述 1.高效程序的特点 (1)适当 ...

  2. Android Layout属性

    通用属性 android:layout_height android:layout_width 值 含义 fill_parent/match_parent 高度或者宽度对齐到父控件 wrap_cont ...

  3. JAVA学生宿舍管理系统

    转: JAVA学生宿舍管理系统 需要的工具 1.SQL Server 2.Eclipse 3.JDBC连接数据库驱动 https://download.microsoft.com/download/A ...

  4. win10使用cmd命令关闭防火墙

    在搜索框内输入cmd,右键选择管理员运行 然后输入: NetSh Advfirewall set allprofiles state off #关闭防火墙 Netsh Advfirewall show ...

  5. React函数式组件和类组件[Dan]

    一篇对Dan的 How Are Function Components Different from Classes? 一文的个人阅读总结,内容来自于此.强烈推荐阅读 Dan Abramov.的博客. ...

  6. 在windows上安装MySQL数据库注意点及Navicat Premium 15的破解

    在windows上安装MySQL数据库  跟随慕课网教程(http://www.imooc.com/wiki/mysqllesson/mysqlwindows.html)下载安装MySQL: 其中注意 ...

  7. [UWP] 模仿哔哩哔哩的一键三连

    1. 一键三连 什么是一键三连? 哔哩哔哩弹幕网中用户可以通过长按点赞键同时完成点赞.投币.收藏对UP主表示支持,后UP主多用"一键三连"向视频浏览者请求对其作品同时进行点赞.投币 ...

  8. WPF 基础 - 事件

    1. 前言 WPF 事件的路由环境是 UI 组件树,先来看看这棵树. 1.1 Logical Tree 和 Visual Tree WPF 中的树有两种,一颗是逻辑树,另一颗也是逻辑树. 开玩笑,WP ...

  9. SQL练习——LeetCode解题和总结(2)

    602. Friend Requests II: Who Has the Most Friends[M] 一.表信息 In social network like Facebook or Twitte ...

  10. VMware 虚拟机安装(使用CentOS镜像)

    (1)启动虚拟机,点击"文件"-->"新建虚拟机",选择安装类型,推荐"典型".       (2)选择稍后安装操作系统       ...