在Dart生态中,xml包是处理XML数据的标准工具,支持XML的解析、遍历、修改和生成等全场景操作,适用于接口数据交互、配置文件读取等多种开发场景。

xml包的安装与导入
首先需要在Dart项目的pubspec.yaml文件中添加xml包的依赖,当前稳定版本为6.3.0,添加完成后执行依赖安装命令即可。
dependencies: xml: ^6.3.0
安装完成后,在Dart文件中导入xml包即可使用相关功能:
import 'package:xml/xml.dart' as xml;
使用xml包解析XML数据
基础解析流程
解析XML字符串的核心是使用xml.XmlDocument.parse方法,该方法会将XML字符串转换为可操作的文档对象,之后可以通过文档对象的方法获取根节点、子节点等信息。
void parseXmlDemo() {
// 待解析的XML字符串
String xmlStr = '''<?xml version="1.0" encoding="UTF-8"?>
<user>
<id>1001</id>
<name>张三</name>
<age>25</age>
<hobbies>
<hobby>篮球</hobby>
<hobby>阅读</hobby>
</hobbies>
</user>''';
// 解析XML字符串为文档对象
final document = xml.XmlDocument.parse(xmlStr);
// 获取根节点
final root = document.rootElement;
print('根节点名称:${root.name}'); // 输出:根节点名称:user
}
节点与属性读取
可以通过节点的getAttribute方法获取属性值,通过findElements方法查找指定名称的子节点,通过text属性获取节点的文本内容。
void readNodeAndAttribute() {
String xmlStr = '''<book id="b001" category="编程">
<title>Dart开发实战</title>
<author>李四</author>
<price>89.9</price>
</book>''';
final document = xml.XmlDocument.parse(xmlStr);
final bookNode = document.rootElement;
// 读取节点属性
final bookId = bookNode.getAttribute('id');
final category = bookNode.getAttribute('category');
print('图书ID:$bookId,分类:$category'); // 输出:图书ID:b001,分类:编程
// 读取子节点文本内容
final title = bookNode.findElements('title').first.text;
final author = bookNode.findElements('author').first.text;
final price = bookNode.findElements('price').first.text;
print('书名:$title,作者:$author,价格:$price'); // 输出:书名:Dart开发实战,作者:李四,价格:89.9
}
遍历子节点
如果需要遍历某个节点的所有子节点,可以使用children属性,该属性返回所有直接子节点的列表,也可以结合条件判断筛选需要的节点。
void traverseChildren() {
String xmlStr = '''<students>
<student>
<name>王五</name>
<score>92</score>
</student>
<student>
<name>赵六</name>
<score>88</score>
</student>
</students>''';
final document = xml.XmlDocument.parse(xmlStr);
final studentsNode = document.rootElement;
// 遍历所有student子节点
for (final student in studentsNode.findElements('student')) {
final name = student.findElements('name').first.text;
final score = student.findElements('score').first.text;
print('学生姓名:$name,成绩:$score');
}
}
使用xml包生成XML数据
基础生成流程
生成XML数据需要先创建文档对象,再依次构建根节点、子节点、属性等内容,最后通过toXmlString方法将文档对象转换为XML字符串。
void generateXmlDemo() {
// 创建XML文档构建器
final builder = xml.XmlBuilder();
// 构建XML声明
builder.processing('xml', 'version="1.0" encoding="UTF-8"');
// 构建根节点
builder.element('product', nest: () {
// 添加根节点属性
builder.attribute('id', 'p001');
builder.attribute('type', '电子');
// 添加子节点
builder.element('name', nest: '无线耳机');
builder.element('brand', nest: '某品牌');
builder.element('price', nest: '299.9');
});
// 生成XML字符串
final xmlStr = builder.buildDocument().toXmlString(pretty: true);
print(xmlStr);
}
生成复杂层级结构
对于多层级嵌套的XML结构,可以在element方法的nest回调中继续嵌套构建子节点,实现复杂的层级关系。
void generateComplexXml() {
final builder = xml.XmlBuilder();
builder.processing('xml', 'version="1.0" encoding="UTF-8"');
builder.element('order', nest: () {
builder.attribute('order_no', '20240501001');
builder.element('buyer', nest: () {
builder.element('name', nest: '张三');
builder.element('phone', nest: '13800138000');
});
builder.element('items', nest: () {
builder.element('item', nest: () {
builder.attribute('goods_id', 'g001');
builder.element('goods_name', nest: '鼠标');
builder.element('quantity', nest: '2');
});
builder.element('item', nest: () {
builder.attribute('goods_id', 'g002');
builder.element('goods_name', nest: '键盘');
builder.element('quantity', nest: '1');
});
});
});
final xmlStr = builder.buildDocument().toXmlString(pretty: true);
print(xmlStr);
}
常见问题与注意事项
- 解析XML时如果字符串格式不符合XML规范,会抛出
xml.XmlParserException异常,建议解析时添加异常处理逻辑。 - 生成XML时如果需要输出格式化后的字符串,可以在
toXmlString方法中设置pretty: true,默认生成的字符串是压缩格式。 - 读取节点文本时,如果节点不存在,直接调用
first会抛出异常,建议先判断节点是否存在再读取内容。
xml包还支持XML的修改、删除等操作,开发者可以根据实际需求查阅官方文档了解更多高级用法。