Flutter大型XML文件处理插件large_xml的使用

large_xml 是一个纯 Dart 库，用于读取和写入大型 XML 文件。本文将通过示例展示如何使用该库来处理 XML 文件。

使用步骤

示例XML

所有示例代码都将使用以下 XML 字符串：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE root>
<root 
  xmlns:r="http://schemas.openxmlformats.org/package/2006/relationships"
  xmlns:x="http://schemas.openxmlformats.org/package/2006/x"
>
    <!-- comment here -->
    <person age="1" r:id="2" x:id="3" />
    <!-- comment here -->
    <x:script>
      <![CDATA[function matchwo(a,b){if (a < b && a < 0) then{return 1;}else{return 0;}}]]>
    </x:script>
    <info>
      <child x:name="child name"/>
    </info>
</root>

创建XML文档对象

首先，您需要创建一个 XmlDocument 对象。此对象存储 XML 字符串，并动态更新挂载的 XmlNode。

然后，您可以访问 XML 的根节点。如果要缓存某个节点，必须调用 node.mount() 将其挂载到 XmlDocument 中，以便在 XML 原始字符串更改时动态更新该节点的指针。当节点不再需要时，应调用 node.unmount() 释放它。

import 'package:large_xml/large_xml.dart';

void main() {
  var xmlstr = """
  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <!DOCTYPE root>
  <root 
    xmlns:r="http://schemas.openxmlformats.org/package/2006/relationships"
    xmlns:x="http://schemas.openxmlformats.org/package/2006/x"
  >
      <!-- comment here -->
      <person age="1" r:id="2" x:id="3" />
      <!-- comment here -->
      <x:script>
        <![CDATA[function matchwo(a,b){if (a < b && a < 0) then{return 1;}else{return 0;}}]]>
      </x:script>
      <info>
        <child x:name="child name"/>
      </info>
  </root>
  """;

  var doc = XmlDocument.fromString(xmlstr);
  var root = doc.root;
}

查找节点

查找子节点

如果您想获取子节点引用，可以调用 node.into() 方法。

var person = doc.root.into(type: XmlElementType.start); // 获取第一个 <person/> 节点
if (person == null) {
  print("node not found");
}

var info = doc.root.into(selector: (n) => n.type == XmlElementType.start && n.name == "info"); // 获取名为 "info" 的节点
if (info == null) {
  print("node not found");
}

查找平行节点

如果您想获取平行节点引用，可以调用 node.next() 方法。

var script = person?.next(type: XmlElementType.start); // 获取下一个 <start> 类型的节点
if (script == null) {
  print("node not found");
}

var info = doc.root.next(selector: (n) => n.type == XmlElementType.start && n.name == "info"); // 获取名为 "info" 的节点
if (info == null) {
  print("node not found");
}

var scriptIgnoreNs = doc.root.next(selector: (n) => n.type == XmlElementType.start && n.name.removeNamespace() == "script"); // 忽略命名空间
if (scriptIgnoreNs == null) {
  print("node not found");
}

查找祖先节点

如果需要查找祖先节点，可以调用 node.findAncestor() 方法。

var root = child?.findAncestor(selector: (n) => n.type == XmlElementType.start && n.name == "root");
if (root == null) {
  print("ancestor not found");
}

访问节点属性

您可以使用以下方法访问节点的属性：

node.containsAttribute
node.getAttribute
node.getAttributes
node.getAttributeNode
node.addAttribute

直接获取属性值：

var rid = person?.getAttribute(":id"); // 获取命名空间为 "x" 的属性
if (rid != null) {
  print(rid); // 输出 "2"
}

更新属性值：

var ridNode = person?.getAttributeNode("r:id");
if (ridNode != null) {
  ridNode.setAttribute("new value");
  ridNode.remove(); // 删除属性
}

添加新属性：

var newNodeAttr = person?.addAttribute("newAttr", "value");
if (newNodeAttr != null) {
  print(newNodeAttr.value); // 输出 "value"
}

缓存节点

如果需要长期持有节点引用，必须确保正确挂载和释放节点。

正确用法：

var person = doc.root.into(type: XmlElementType.start)?.mount();
var info = doc.root
    .into(selector: (n) => n.type == XmlElementType.start && n.name == "info")?
    .mount();

person?.addAttribute("nattr");
info?.addAttribute("nattr");

person?.unmount(); // 释放节点
info?.unmount();

错误用法：

var person = doc.root.into(type: XmlElementType.start)?.mount();
var info = doc.root
    .into(selector: (n) => n.type == XmlElementType.start && n.name == "info")?;

person?.addAttribute("nattr");
info?.addAttribute("nattr"); // 错误：info 节点未挂载，指向可能不正确

person?.unmount();

节点写操作

您可以使用以下方法添加、删除或复制节点：

XmlNode.create
node.remove
node.copy

所有写操作都依赖于 XmlNodeInstance 对象，它提供了以下方法：

inst.pasteBefore
inst.pasteAfter
inst.pasteInner

创建新节点并插入：

var newNode = XmlNode.create("new");
newNode.pasteBefore(person!); // 插入到 person 节点之前
newNode.pasteAfter(person); // 插入到 person 节点之后
newNode.pasteInner(person); // 插入到 person 节点内部

复制节点并插入：

var infoCopy = info?.copy();
infoCopy?.pasteInner(person); // 将 info 节点复制到 person 节点内部

完整示例代码

以下是一个完整的示例代码，展示了如何使用 large_xml 处理 XML 文件：

import 'package:large_xml/large_xml.dart';

void main() {
  var xmlstr = """
  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <!DOCTYPE root>
  <root 
    xmlns:r="http://schemas.openxmlformats.org/package/2006/relationships"
    xmlns:x="http://schemas.openxmlformats.org/package/2006/x"
  >
      <!-- comment here -->
      <person age="1" r:id="2" x:id="3" />
      <!-- comment here -->
      <x:script>
        <![CDATA[function matchwo(a,b){if (a < b && a < 0) then{return 1;}else{return 0;}}]]>
      </x:script>
      <info>
        <child x:name="child name"/>
      </info>
  </root>
  """;

  var doc = XmlDocument.fromString(xmlstr);

  var person = doc.root.into(type: XmlElementType.start)?.mount();
  var info = doc.root
      .into(selector: (n) => n.type == XmlElementType.start && n.name == "info")?
      .mount();
  var script = person?.next(type: XmlElementType.start)?.mount();
  var comment = person?.next()?.mount();
  var child = info?.into(type: XmlElementType.start)?.mount();
  var root = child?.findAncestor(selector: (n) => n.type == XmlElementType.start && n.name == "root");
  root!.name == "name";

  var attributes = person?.getAttributes();
  attributes!.length == 3;
  var rid = person?.getAttribute("r:id");
  rid == "2";
  var age = person?.getAttribute("age");
  age == "3";
  rid = person?.getAttribute(":id");

  var ridNode = person?.getAttributeNode("r:id");
  var xmlnsr = ridNode?.namespace;
  xmlnsr!.value == "http://schemas.openxmlformats.org/package/2006/relationships";
  var ridKey = ridNode?.key;
  ridKey == "r:id";
  var ridValue = ridNode?.value;
  ridValue == "2";
  ridNode?.setAttribute("new value").remove();

  ridNode = person?.addAttribute("r:id", "new rid");
  ridNode?.remove();

  var newNode = XmlNode.create("new");
  newNode.pasteBefore(person!);
  newNode.pasteAfter(person);
  newNode.pasteInner(person);

  var infoCopy = info?.copy();
  infoCopy?.pasteInner(person);

  person?.remove();

  var decoded = child!.value.decode();
  decoded == "<n k=\"v\" t='v'/>";

  person?.unmount();
  info?.unmount();
  script?.unmount();
  comment?.unmount();
  child.unmount();
}

gougou168 1楼

更多关于Flutter大型XML文件处理插件large_xml的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

在处理大型XML文件时，Flutter开发者可以使用large_xml插件。这个插件专门设计用于高效地解析和处理大型XML文件，而不会导致内存溢出或性能问题。以下是如何使用large_xml插件的基本指南。

1. 添加依赖

首先，在pubspec.yaml文件中添加large_xml插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  large_xml: ^1.0.0  # 请检查最新版本

然后运行flutter pub get来安装依赖。

2. 导入插件

在需要使用large_xml的Dart文件中导入插件：

import 'package:large_xml/large_xml.dart';

3. 解析XML文件

large_xml插件提供了流式解析XML文件的功能，这意味着它可以逐步读取和解析文件，而不需要一次性将整个文件加载到内存中。

以下是一个简单的示例，展示如何使用large_xml解析一个大型XML文件：

import 'package:flutter/material.dart';
import 'package:large_xml/large_xml.dart';
import 'dart:io';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Large XML Parser Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              await parseLargeXml();
            },
            child: Text('Parse Large XML'),
          ),
        ),
      ),
    );
  }

  Future<void> parseLargeXml() async {
    final file = File('path/to/your/large.xml');
    final stream = file.openRead();

    final parser = LargeXmlParser();
    parser.parse(stream, (event) {
      if (event is XmlStartElementEvent) {
        print('Start Element: ${event.name}');
      } else if (event is XmlEndElementEvent) {
        print('End Element: ${event.name}');
      } else if (event is XmlTextEvent) {
        print('Text: ${event.text}');
      } else if (event is XmlCDataEvent) {
        print('CDATA: ${event.text}');
      }
    });
  }
}

4. 处理解析事件

large_xml插件通过回调函数来处理XML解析事件。你可以根据不同的XML事件类型（如开始标签、结束标签、文本内容等）来执行相应的操作。

在上面的示例中，parse方法接受一个Stream<List<int>>作为输入，并通过回调函数处理解析事件。

5. 处理错误

在解析过程中，可能会遇到错误。你可以通过捕获异常来处理这些错误：

try {
  await parser.parse(stream, (event) {
    // 处理事件
  });
} catch (e) {
  print('Error parsing XML: $e');
}