Flutter跨平台XML处理库xml_test鸿蒙化使用指南

xml_test是一个基于Flutter框架开发的XML处理工具包，专为OpenHarmony平台提供XML解析与构建功能。该插件支持XML文档解析、元素与属性操作、命名空间处理以及CDATA等特殊内容处理。安装时需通过Git方式引入依赖，并配置OpenHarmony开发环境。使用示例包括XML文档构建、解析字符串、转换为自定义对象以及处理命名空间等核心功能。该工具包能够帮助开发者高效处理Open

david

307人浏览 · 2025-12-25 17:52:49

david · 2025-12-25 17:52:49 发布

1. 插件介绍

xml_test是一个基于Flutter框架开发的XML处理工具包，专为OpenHarmony跨平台应用提供强大的XML解析与构建功能。该插件基于xml 6.2.2版本定制，支持在OpenHarmony平台上无缝运行，提供了全面的XML文档处理能力。

核心功能特性

XML解析：支持将XML字符串或文件解析为可操作的文档树结构
XML构建：提供灵活的构建器API，用于创建和修改XML文档
命名空间支持：完整支持XML命名空间，处理复杂的XML文档
元素与属性操作：方便地访问、修改和删除XML元素及其属性
特殊内容处理：支持CDATA、注释、处理指令等XML特殊内容
Unicode支持：完美处理包含Unicode字符的XML文档

2. 环境要求

在开始使用xml_test之前，请确保您的开发环境满足以下要求：

OpenHarmony平台：API版本9及以上
Flutter SDK：3.0.0及以上版本
Dart SDK：2.19.6及以上版本
开发工具：DevEco Studio或VS Code + OpenHarmony插件

3. 安装与配置

3.1 Git依赖引入

由于xml_test是基于xml包的自定义修改版本，需要通过Git方式引入依赖。在您的Flutter项目中，修改pubspec.yaml文件，添加以下配置：

dependencies:
  flutter:
    sdk: flutter
  xml:
    git:
      url: "https://atomgit.com/flutter/packages"
      path: "packages/xml"

3.2 配置本地XML资产（可选）

如果您需要处理本地XML文件，可以将它们添加到项目的assets目录中。在pubspec.yaml文件中添加以下配置：

flutter:
  assets:
    - assets/book.xml

然后在项目根目录创建assets文件夹，并将您的XML文件放入其中。

4. API使用示例

4.1 XML文档构建

使用XmlBuilder可以轻松创建XML文档：

import 'package:xml/xml.dart';

void buildXmlExample() {
  final builder = XmlBuilder();

  // 添加XML声明
  builder.declaration(encoding: 'UTF-8');

  // 添加处理指令
  builder.processing('xml-stylesheet', 'href="/style.css" type="text/css"');

  // 构建根元素和子元素
  builder.element('bookstore', nest: () {
    builder.comment('这是一个书店的XML文档');

    builder.element('book', nest: () {
      builder.element('title', nest: () {
        builder.attribute('lang', 'en');
        builder.text('Harry ');
        builder.cdata('Potter'); // 使用CDATA
      });
      builder.element('author', nest: 'J.K. Rowling');
      builder.element('price', nest: 29.99);
    });
  });

  // 构建完整文档
  final document = builder.buildDocument();

  // 输出XML字符串
  print(document.toString());
}

4.2 XML文档解析

解析XML字符串并访问其内容：

import 'package:xml/xml.dart';

void parseXmlExample() {
  // 要解析的XML字符串
  const xmlString = '''<?xml version="1.0"?>
<catalog>
   <book id="bk101">
      <author>Gambardella, Matthew</author>
      <title>XML Developer's Guide</title>
      <genre>Computer</genre>
      <price>44.95</price>
      <publish_date>2000-10-01</publish_date>
      <description>An in-depth look at creating applications with XML.</description>
   </book>
</catalog>''';

  // 解析XML字符串
  final document = XmlDocument.parse(xmlString);

  // 访问根元素
  final catalog = document.rootElement;

  // 遍历所有book元素
  for (final book in catalog.findElements('book')) {
    // 获取属性值
    final id = book.getAttribute('id');

    // 获取子元素内容
    final title = book.findElements('title').first.innerText;
    final author = book.findElements('author').first.innerText;
    final price = double.parse(book.findElements('price').first.innerText);

    print('Book ID: $id');
    print('Title: $title');
    print('Author: $author');
    print('Price: \$${price.toStringAsFixed(2)}');
    print('-----------------------------------');
  }
}

4.3 XML解析为自定义对象

将XML数据解析为自定义Dart对象：

首先定义Book类（可以在lib/pages/book.dart中找到）：

class Book {
  String title;
  String author;

  Book(this.title, this.author);

  @override
  String toString() {
    return 'Book{title: $title, author: $author}';
  }
}

然后解析XML到Book对象：

import 'package:xml/xml.dart';
import 'book.dart';

void parseToObjectExample() {
  const xmlString = '''<?xml version="1.0"?>
<bookstore>
  <book>
    <title lang="eng">Harry Potter</title>
    <author>J.K. Rowling</author>
    <price>29.99</price>
  </book>
</bookstore>''';

  final document = XmlDocument.parse(xmlString);
  final bookElements = document.rootElement.findElements('book');

  List<Book> books = [];

  for (final bookElement in bookElements) {
    final title = bookElement.findElements('title').first.innerText;
    final author = bookElement.findElements('author').first.innerText;

    books.add(Book(title, author));
  }

  // 输出解析结果
  books.forEach(print);
}

4.4 处理命名空间

处理带有命名空间的XML文档：

import 'package:xml/xml.dart';

void namespaceExample() {
  const xmlString = '''<?xml version="1.0" encoding="UTF-8"?>
<app:service xmlns:app="http://example.com/app">
  <app:workspace>
    <cmisra:repositoryInfo xmlns:cmisra="http://docs.oasis-open.org/ns/cmis/restatom/200908/">
      <cmisra:repositoryId>repo1</cmisra:repositoryId>
      <cmisra:repositoryName>My Repository</cmisra:repositoryName>
    </cmisra:repositoryInfo>
  </app:workspace>
</app:service>''';

  final document = XmlDocument.parse(xmlString);

  // 定义命名空间
  const appNs = 'http://example.com/app';
  const cmisraNs = 'http://docs.oasis-open.org/ns/cmis/restatom/200908/';

  // 使用命名空间查找元素
  final repositoryInfo = document
      .findAllElements('repositoryInfo', namespace: cmisraNs)
      .first;

  final repositoryId = repositoryInfo
      .findElements('repositoryId', namespace: cmisraNs)
      .first
      .innerText;

  final repositoryName = repositoryInfo
      .findElements('repositoryName', namespace: cmisraNs)
      .first
      .innerText;

  print('Repository ID: $repositoryId');
  print('Repository Name: $repositoryName');
}

4.5 处理本地XML文件

加载并处理本地XML资产文件：

import 'package:flutter/services.dart' show rootBundle;
import 'package:xml/xml.dart';

Future<void> loadLocalXmlExample() async {
  try {
    // 从assets加载XML文件
    final xmlString = await rootBundle.loadString('assets/book.xml');

    // 解析XML
    final document = XmlDocument.parse(xmlString);

    // 处理XML内容
    final books = document.findAllElements('book');

    for (final book in books) {
      final title = book.findElements('title').first.innerText;
      final author = book.findElements('author').first.innerText;

      print('Book: $title by $author');
    }
  } catch (e) {
    print('Error loading XML: $e');
  }
}

5. 高级功能

5.1 构建复杂XML文档

使用XmlBuilder构建包含多种元素的复杂XML文档：

import 'package:xml/xml.dart';

void buildComplexXml() {
  final builder = XmlBuilder();

  builder.declaration();
  builder.doctype('note', systemId: 'Note.dtd');

  builder.element('element1', attributes: {'attribute1': 'value1'}, nest: () {
    builder.attribute('attribute2', 'value2');
    builder.element('element2');
    builder.comment('这是一个注释');
    builder.cdata('<This is CDATA content>');
    builder.text('普通文本内容');
  });

  final document = builder.buildDocument();
  print(document.toString());
}

5.2 处理特殊字符

xml_test能够自动处理XML中的特殊字符：

import 'package:xml/xml.dart';

void specialCharactersExample() {
  const xmlString = '<?xml version="1.0"?><name attr="bell\u0007">del\u007f</name>';

  final document = XmlDocument.parse(xmlString);

  final nameElement = document.rootElement;
  print('Element name: ${nameElement.name}');
  print('Attribute value: ${nameElement.getAttribute('attr')}');
  print('Element text: ${nameElement.innerText}');
}