在 NodeJS 中解析 XML

Isaac Tony 2023年10月12日
  1. 在 NodeJS 中使用 XML 解析
  2. 使用解析对象解析文件
在 NodeJS 中解析 XML

XML 代表可扩展标记语言。它是一种简单的基于文本的格式,旨在存储和传输数据。

在 NodeJS 中使用 XML 解析

XML 解析是读取和修改 XML 数据的过程,以便客户端应用程序可以有效地处理数据。

除了读取 XML 文档外,解析器还验证给定的 XML 文档是否符合标准 XML 语法并检查任何文档违规或错误。

解析器通过检查和验证 XML 文档的组件是否符合 文档类型定义 (DTD) 或模式模式来执行此验证。

我们可以用来解析 XML 的常用且直接的库之一是 xml2js。它是一个简单的双向 XML 到 javascript 对象转换器,使用 sax-jsxmlbuilder-js

安装 xml2js 及其所有依赖项的最快和最直接的方法是使用 node package manager(npm) 使用以下命令。

npm install xml2js

我们将首先使用 index.js 文件创建一个骨架节点应用程序服务器来编写我们的代码。

由于我们已将 xml2js 作为单独的模块安装,我们将使用 require() 函数将其包含在主文件 index.js 中,并将其作为 package.json 中登记的依赖项之一文件。

一旦模块到位,我们就可以公开 Parse 对象并解析 XML 文件。下面的代码显示我们可以将它们解析为小的 XML 文件。

var parseString = require('xml2js').parseString;
var xml =
    '<root><railroad><gate>mile</gate><actually><wall>about</wall><whether>whom</whether><generally>choose</generally><alive>-110838449.82186222</alive><dug>1150240574</dug><keep>1763043002.325139</keep></actually><hello>flower</hello><strike>-914757363.3499522</strike><danger>-200144457</danger> <whose>1022707429</whose></railroad><stove>1072975804</stove><row>-1686689624.6101847</row><changing>96738623.18869686</changing><compass>917572500</compass><die>suggest</die></root>'

parseString(xml, function(err, result) {
  console.dir(result);
});

输出:

 root: {
    railroad: [ [Object] ],
    stove: [ '1072975804' ],
    row: [ '-1686689624.6101847' ],
    changing: [ '96738623.18869686' ],
    compass: [ '917572500' ],
    die: [ 'suggest' ]
  }
}

但是,如果我们编写生产标准代码,这可能不是为大文件解析 XML 的理想方法。我们可以使用 fs.readFileSync() 在使用 fs 模块解析 XML 文件之前同步读取它。

fs.readFileSync() 是 fs 模块的内置 API,可同步返回文件的内容。一旦我们有了文件,我们就可以使用解析的对象来解析文件,如下所示。

使用解析对象解析文件

const xml2js = require('xml2js');
const fs = require('fs');
const parser = new xml2js.Parser({attrkey: 'ATTR'});

let xml_file = fs.readFileSync('file.xml', 'utf8');

parser.parseString(xml_file, (error, result) => {
  if (error === null) {
    console.log(result);
  } else {
    console.log(error);
  }
});

输出:

{
  root: {
    railroad: [ [Object] ],
    stove: [ '1072975804' ],
    row: [ '-1686689624.6101847' ],
    changing: [ '96738623.18869686' ],
    compass: [ '917572500' ],
    die: [ 'suggest' ]
  }
}

我们也可以异步读取文件,然后解析,如下面的代码所示。

const xml2js = require('xml2js');
const fs = require('fs');
const parser = new xml2js.Parser({attrkey: 'ATTR'});

fs.readFile('file.xml', (err, data) => {
  if (!err) {
    parser.parseString(data, function(error, result) {
      if (error === null) {
        console.log(result);
      } else {
        console.log(error);
      }
    });
  }
});

输出:

{
  root: {
    railroad: [ [Object] ],
    stove: [ '1072975804' ],
    row: [ '-1686689624.6101847' ],
    changing: [ '96738623.18869686' ],
    compass: [ '917572500' ],
    die: [ 'suggest' ]
  }
}

假设这个 XML 数据的来源是一个特定的端点。然后,在这种情况下,我们首先需要向该特定端点发送一个 HTTP GET 请求。

如下所示,该端点的响应将被传递给 xml2js Parse 对象进行解析。

const https = require('https');
const xml2js = require('xml2js');
const parser = new xml2js.Parser({attrkey: 'ATTR'});

let req = https.get(
    'https://4f567984-6c81-4a85-8b5a-61ab9621f67f.mock.pstmn.io/dishon/file.xml',
    function(res) {
      let xml_data = '';
      res.on('data', (stream) => {
        xml_data = xml_data + stream;
      });
      res.on('end', () => {
        parser.parseString(xml_data, (error, result) => {
          if (error === null) {
            console.log(result);
          } else {
            console.log(error);
          }
        });
      });
    });

输出:

{
  root: {
    railroad: [ [Object] ],
    stove: [ '1072975804' ],
    row: [ '-1686689624.6101847' ],
    changing: [ '96738623.18869686' ],
    compass: [ '917572500' ],
    die: [ 'suggest' ]
  }
}
作者: Isaac Tony
Isaac Tony avatar Isaac Tony avatar

Isaac Tony is a professional software developer and technical writer fascinated by Tech and productivity. He helps large technical organizations communicate their message clearly through writing.

LinkedIn