使用xml2js库解析含嵌套元素的XML时出现“Invalid character in name”错误的原因及解决方法

嘿，我来帮你排查这个问题！你遇到的这个错误，大概率是xml-stream和xml2js的对象结构不兼容导致的，或者是xml-stream在流式解析嵌套元素时，生成的对象格式不符合xml2js.Builder的预期。

错误原因分析 #

1. 流式解析的结构差异：xml-stream是流式XML解析库，它解析后生成的对象结构，和xml2js自身解析生成的结构有细微差异。尤其是嵌套元素（比如你的<customs>和<custom>）的属性处理，可能出现xml2js无法识别的格式，导致Builder在生成XML时误判属性名里的字符无效。
2. 旧版本兼容性问题：如果你的xml2js版本较旧，它对属性名的字符校验可能更严格，或者xml-stream的解析逻辑没有正确保留属性名的连字符格式，也会触发这个错误。

解决方法 #

方法一：替换xml-stream，直接用xml2js处理（适合中小文件）

如果你的XML文件不是特别大，不需要流式处理，直接用xml2js的parseFile或者parseString来解析，这样能保证结构完全兼容，代码也更简洁：

const fs = require('fs');
const xml2js = require('xml2js');

const builder = new xml2js.Builder();
const MAX_ITEMS = 1;

// 读取XML文件并解析
xml2js.parseFile('./test.xml', (err, result) => {
  if (err) {
    console.error('解析XML出错:', err);
    return;
  }
  // 取前MAX_ITEMS个list元素
  const filteredLists = result.lists.list.slice(0, MAX_ITEMS);
  // 构建新XML
  const outputXml = builder.buildObject({ lists: { list: filteredLists } });
  console.log(outputXml);
});

方法二：调整xml-stream的解析配置（适合大文件流式处理）

如果必须用流式处理，需要让xml-stream正确收集嵌套元素，确保生成的对象结构和xml2js兼容。你可以添加collect方法来指定需要收集的嵌套元素，避免流式解析时丢失结构：

const fs = require('fs');
const xml2js = require('xml2js');
const XmlStream = require('xml-stream');

const stream = fs.createReadStream('./test.xml');
const xmlStream = new XmlStream(stream);
const builder = new xml2js.Builder();

const MAX_ITEMS = 1;
let lists = [];
let listCount = 0;

// 告诉xml-stream收集customs和custom元素，保留嵌套结构
xmlStream.collect('customs');
xmlStream.collect('custom');

xmlStream.on('endElement: list', function (item) {
  if (listCount < MAX_ITEMS) {
    lists.push(item);
    listCount++;
  } else {
    stream.destroy();
  }
});

stream.on('close', function () {
  try {
    const outputXml = builder.buildObject({ lists: { list: lists } });
    console.log(outputXml);
  } catch (err) {
    console.error('构建XML出错:', err);
  }
});

另外，也可以尝试升级xml2js到最新版本，新版本对属性名的兼容性更好，能更好地处理带连字符的属性名。

备注：内容来源于stack exchange，提问作者I'll-Be-Back