Fast-XML-Parser中XMLBuilder构建XML时属性值丢失问题解析

在使用Fast-XML-Parser库的XMLBuilder功能时，开发者可能会遇到一个常见问题：当尝试构建包含布尔类型属性的XML时，属性值可能会丢失。本文将深入分析这个问题及其解决方案。

问题现象

当开发者尝试构建如下结构的XML时：

<internal-name tokenized="true">test test &gt; 14</internal-name>

使用以下JSON作为输入：

{
  component: {
    "internal-name": {
      "#text": "test test > 14",
      "@_tokenized": true
    }
  }
}

实际输出却是：

<internal-name tokenized>test test &gt; 14</internal-name>

可以看到，属性tokenized的值"true"丢失了，这不符合预期。

问题原因

这个问题源于Fast-XML-Parser的默认配置行为。在XML规范中，布尔属性有一种简写形式，即只写属性名而不写属性值（如<input disabled>），这在HTML中很常见。Fast-XML-Parser默认启用了suppressBooleanAttributes选项，当属性值为布尔类型时，会自动采用这种简写形式。

解决方案

有两种方法可以解决这个问题：

方法一：将属性值设为字符串

最简单的方法是将布尔值改为字符串形式：

{
  component: {
    "internal-name": {
      "#text": "test test > 14",
      "@_tokenized": "true"  // 注意这里改为字符串
    }
  }
}

方法二：修改配置选项

更彻底的解决方案是在XMLBuilder的配置中明确禁用布尔属性简写：

{
  ignoreAttributes: false,
  attributeNamePrefix: "@_",
  indentBy: "  ",
  textNodeName: "#text",
  format: true,
  suppressBooleanAttributes: false  // 添加这一行
}

最佳实践

1. 明确数据类型：在构建XML时，明确属性的数据类型是字符串还是布尔值
2. 配置一致性：在整个项目中保持XML解析和构建的配置一致
3. 版本兼容性：注意不同版本Fast-XML-Parser的行为可能有所不同

总结

Fast-XML-Parser作为一款高效的XML处理工具，提供了灵活的配置选项来满足不同场景的需求。理解其默认行为和配置选项对于正确使用该库至关重要。通过合理配置suppressBooleanAttributes选项，开发者可以精确控制布尔属性在输出XML中的表现形式，确保生成的XML文档符合预期格式。