在Node.js的Express项目开发中,经常会遇到需要返回XML格式数据的需求,比如对接部分老旧的第三方系统或者遵循特定的接口规范时,就需要把后端处理得到的JSON数据转换为XML格式再返回。下面我们就来一步步实现这个功能。

实现前的准备工作
要完成JSON到XML的转换,我们需要先安装对应的转换依赖库,这里选择xml2js库,它支持双向转换,使用起来也比较方便。同时需要保证已经初始化了Express项目,如果还没有初始化项目,可以先执行以下命令创建基础项目结构:
# 初始化Node.js项目 npm init -y # 安装Express和xml2js依赖 npm install express xml2js
核心转换逻辑实现
xml2js库的Builder类可以用来将JSON对象转换为XML字符串,我们只需要把需要返回的JSON数据传入对应的构建方法即可。下面是基础的转换函数示例:
const { Builder } = require('xml2js');
/**
* 将JSON对象转换为XML字符串
* @param {Object} jsonData 需要转换的JSON数据
* @returns {String} 转换后的XML字符串
*/
function jsonToXml(jsonData) {
const builder = new Builder({
// 配置XML的声明头,包含版本和编码
xmldec: { version: '1.0', encoding: 'UTF-8' },
// 是否允许CDATA块,根据需求调整
cdata: true
});
// 构建XML字符串,默认根节点是root,可根据需要修改
return builder.buildObject(jsonData);
}
自定义XML根节点
默认情况下转换后的XML根节点是<root>,如果我们需要自定义根节点名称,可以在传入的JSON数据外层包裹一层自定义键名,示例如下:
// 自定义根节点为userInfo,转换后的XML根标签就是<userInfo>
const jsonData = {
userInfo: {
name: '张三',
age: 25,
email: 'test@ipipp.com'
}
};
const xmlResult = jsonToXml(jsonData);
console.log(xmlResult);
上述代码执行后得到的XML内容如下:
<?xml version="1.0" encoding="UTF-8"?> <userInfo> <name>张三</name> <age>25</age> <email>test@ipipp.com</email> </userInfo>
Express接口中返回XML数据
在Express的接口处理逻辑中,我们只需要调用上面的转换函数,然后把结果设置正确的响应头后返回即可。注意要设置Content-Type为application/xml,这样客户端才能正确识别返回的数据格式。
const express = require('express');
const { Builder } = require('xml2js');
const app = express();
// 内置中间件,用于解析JSON格式的请求体
app.use(express.json());
// 转换函数
function jsonToXml(jsonData) {
const builder = new Builder({
xmldec: { version: '1.0', encoding: 'UTF-8' },
cdata: true
});
return builder.buildObject(jsonData);
}
// 定义返回XML的接口
app.get('/api/user/xml', (req, res) => {
// 模拟需要返回的JSON数据
const userJson = {
user: {
id: 1001,
username: 'lisi',
role: 'admin'
}
};
// 转换为XML
const xmlData = jsonToXml(userJson);
// 设置响应头为XML格式
res.set('Content-Type', 'application/xml; charset=utf-8');
// 返回XML数据
res.send(xmlData);
});
// 启动服务,监听3000端口
app.listen(3000, () => {
console.log('服务运行在 http://127.0.0.1:3000');
});
处理复杂JSON结构
如果JSON数据中包含数组结构,xml2js也会自动处理为对应的XML节点,示例如下:
const complexJson = {
order: {
orderId: '20240501001',
items: {
item: [
{ name: '商品A', price: 100 },
{ name: '商品B', price: 200 }
]
}
}
};
const xmlResult = jsonToXml(complexJson);
console.log(xmlResult);
转换后的XML结构如下:
<?xml version="1.0" encoding="UTF-8"?>
<order>
<orderId>20240501001</orderId>
<items>
<item>
<name>商品A</name>
<price>100</price>
</item>
<item>
<name>商品B</name>
<price>200</price>
</item>
</items>
</order>
常见问题说明
- 如果JSON数据中包含特殊字符,
xml2js会自动进行转义,不需要手动处理 - 如果需要返回纯XML不带声明头,可以把
xmldec配置去掉,或者设置xmldec: false - 如果客户端请求时指定了返回格式,可以通过
req.headers.accept判断,动态返回JSON或者XML格式数据
通过以上步骤,我们就可以在Node.js的Express项目中轻松实现JSON数据到XML的转换并返回给客户端,根据实际需求调整转换配置和接口逻辑即可。
Node.jsExpressJSON_to_XMLXMLAPI修改时间:2026-06-14 06:09:43