Flutter XML数据转换插件xml_map_converter的使用

Flutter XML 数据转换插件 xml_map_converter 的使用

XML to Dart map 转换器及反向转换。

受 Stefan Goessner 工作的启发。

该包包含两个类，第一个用于将 XML 文本转换为 Dart Map 结构，第二个用于将 Dart Map 转换回 XML 文本。

Xml2Map

将 XML 文本转换为 Dart Map 结构。

标签名被转换为 Map 中的键，标签值和属性被转换为 Map 中的值。

例如，以下 XML：

<users>
  <user id="1">
    <name>John</name>
    <surname>Doe</surname>
  </user>
  <user id="2">
    <name>Richard</name>
    <surname>Roe</surname>
  </users>
</users>

将被转换为结构：

{
  "users": {
    "user": [
      {
        "@id": "1",
        "name": "John",
        "surname": "Doe"
      },
      {
        "@id": "2",
        "name": "Richard",
        "surname": "Roe"
      }
    ]
  }
}

属性

XML 属性被转换为以 @ 开头的键，例如：

<record id="1"/>

转换后为：

{
  "record": {
    "@id": "1"
  }
}

节点内容

XML 节点的文本内容被转换为 Map 中的值：

<record>Record 1</record>

转换后为：

{
  "record": "Record 1"
}

如果 Map 已经有属性或嵌套值，则文本内容将写入 #text 键：

<record id="1">Record 1</record>

转换后为：

{
  "record": {
    "@id": "1",
    "#text": "Record 1"
  }
}

CDATA

CDATA 节点的内容将写入 #cdata 键：

<record id="1">
  <![CDATA
    Record 1
  ]]>
</record>

转换后为：

{
  "record": {
    "@id": "1",
    "#cdata": "
    Record 1
  "
  }
}

标签列表

多个同名标签将被组合成一个列表：

<records>
  <record id="1">Record 1</record>
  <record id="1">Record 1</record>
  <total>2 records</total>
</records>

转换后为：

{
  "records": {
    "record": [
      {
        "@id": "1",
        "#text": "Record 1"
      },
      {
        "@id": "1",
        "#text": "Record 1"
      }
    ],
    "total": "2 records"
  }
}

Map2Xml

将 Dart Map 结构转换为 XML 文本。

将 Dart Map 转换为 XML 文本，键变为标签，值变为标签内容和子标签，以 @ 开头的键变为标签属性。

完整示例

以下是一个完整的示例，展示了如何使用 xml_map_converter 插件进行 XML 和 Map 之间的转换：

import 'package:xml_map_converter/xml_map_converter.dart';

void main() async {
  // 定义 XML 字符串
  final xml = '''<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items>
    <text>Plain text</text>
    <letter>A</letter>
    <letter>B</letter>
    <empty/>
    <group>
      <item name="caption">Caption 1</item>
      <item name="url">https://www.google.com</item>
    </group>
    <item type="text">
      Text
    </item>
    <data name="test">
      <![CDATA[
        cdata
      ]]>
    </data>
    <item type="sample">
      Item 2
    </item>
  </items>
</root>''';

  // 使用 Xml2Map 进行 XML 到 Map 的转换
  final converter1 = Xml2Map(xml);
  final data = await converter1.transform();

  // 使用 Map2Xml 进行 Map 到 XML 的转换
  final converter2 = Map2Xml(data!);
  final newXml = converter2.transform();

  // 打印结果
  print('原始 XML:');
  print(xml);
  print('\n转换后的 Map:');
  print(data);
  print('\n转换回的 XML:');
  print(newXml);
}