鸿蒙开发ArkTS语言-XML解析

XML概述

XML（可扩展标记语言）是一种用于描述数据的标记语言，旨在提供一种通用的方式来传输和存储数据，特别是Web应用程序中经常使用的数据。XML并不预定义标记。因此，XML更加灵活，并且可以适用于广泛的应用领域。

XML文档由元素（element）、属性（attribute）和内容（content）组成。

元素指的是标记对，包含文本、属性或其他元素。
属性提供了有关元素的其他信息。
内容则是元素包含的数据或子元素。

XML还可以通过使用XML Schema或DTD（文档类型定义）来定义文档结构。这些机制允许开发人员创建自定义规则以验证XML文档是否符合其预期的格式。

XML还支持命名空间、实体引用、注释、处理指令等特性，使其能够灵活地适应各种数据需求。

语言基础类库提供了XML相关的基础能力，包括：XML的生成、XML的解析和XML的转换。

XML生成

XML可以作为数据交换格式，被各种系统和应用程序所支持。例如Web服务，可以将结构化数据以XML格式进行传递。

XML还可以作为消息传递格式，在分布式系统中用于不同节点之间的通信与交互。

注意事项

XML标签必须成对出现，生成开始标签就要生成结束标签。
XML标签对大小写敏感，开始标签与结束标签大小写要一致。

开发步骤

XML模块提供XmlSerializer类来生成XML文件，输入为固定长度的Arraybuffer或DataView对象，该对象用于存放输出的XML数据。通过调用不同的方法来写入不同的内容，如startElement(name: string)写入元素开始标记，setText(text: string)写入标签值。 XML模块的API接口可以参考@ohos.xml的详细描述，按需求调用对应函数可以生成一份完整的XML文件。

引入模块。

import xml from '@ohos.xml'; 
import util from '@ohos.util';

创建缓冲区，构造XmlSerializer对象（可以基于Arraybuffer构造XmlSerializer对象，也可以基于DataView构造XmlSerializer对象）。

// 1.基于Arraybuffer构造XmlSerializer对象
let arrayBuffer = new ArrayBuffer(2048); // 创建一个2048字节的缓冲区
let thatSer = new xml.XmlSerializer(arrayBuffer); // 基于Arraybuffer构造XmlSerializer对象// 2.基于DataView构造XmlSerializer对象
let arrayBuffer = new ArrayBuffer(2048); // 创建一个2048字节的缓冲区
let dataView = new DataView(arrayBuffer); // 使用DataView对象操作ArrayBuffer对象
let thatSer = new xml.XmlSerializer(dataView); // 基于DataView构造XmlSerializer对象

调用XML元素生成函数。

thatSer.setDeclaration(); // 写入xml的声明
thatSer.startElement('bookstore'); // 写入元素开始标记
thatSer.startElement('book'); // 嵌套元素开始标记
thatSer.setAttributes('category', 'COOKING'); // 写入属性及属性值
thatSer.startElement('title');
thatSer.setAttributes('lang', 'en');
thatSer.setText('Everyday'); // 写入标签值
thatSer.endElement(); // 写入结束标记
thatSer.startElement('author');
thatSer.setText('Giada');
thatSer.endElement();
thatSer.startElement('year');
thatSer.setText('2005');
thatSer.endElement();
thatSer.endElement();
thatSer.endElement();

使用Uint8Array操作Arraybuffer，调用TextDecoder对Uint8Array解码后输出。

let view = new Uint8Array(arrayBuffer); // 使用Uint8Array读取arrayBuffer的数据
let textDecoder = util.TextDecoder.create(); // 调用util模块的TextDecoder类
let res = textDecoder.decodeWithStream(view); // 对view解码
console.info(res);

输出结果如下：

<?xml version="1.0" encoding="utf-8"?><bookstore>\r\n  <book category="COOKING">\r\n    <title lang="en">Everyday

XML解析

对于以XML作为载体传递的数据，实际使用中需要对相关的节点进行解析，一般包括解析XML标签和标签值、解析XML属性和属性值、解析XML事件类型和元素深度三类场景。

XML模块提供XmlPullParser类对XML文件解析，输入为含有XML文本的ArrayBuffer或DataView，输出为解析得到的信息。

表1 XML解析选项

名称	类型	必填	说明
supportDoctype	boolean	否	是否忽略文档类型。默认为false，表示对文档类型进行解析。
ignoreNameSpace	boolean	否	是否忽略命名空间。默认为false，表示对命名空间进行解析。
tagValueCallbackFunction	(name: string, value: string) => boolean	否	获取tagValue回调函数，打印标签及标签值。默认为null，表示不进行XML标签和标签值的解析。
attributeValueCallbackFunction	(name: string, value: string) => boolean	否	获取attributeValue回调函数，打印属性及属性值。默认为null，表示不进行XML属性和属性值的解析。
tokenValueCallbackFunction	(eventType: EventType, value: ParseInfo) => boolean	否	获取tokenValue回调函数，打印标签事件类型及parseInfo对应属性。默认为null，表示不进行XML事件类型解析。

注意事项

XML解析及转换需要确保传入的XML数据符合标准格式。
XML解析目前不支持按指定节点解析对应的节点值。

解析XML标签和标签值引入模块。

import xml from '@ohos.xml';
import util from '@ohos.util'; // 需要使用util模块函数对文件编码

对XML文件编码后调用XmlPullParser。可以基于ArrayBuffer构造XmlPullParser对象，也可以基于DataView构造XmlPullParser对象。

let strXml ='<?xml version="1.0" encoding="utf-8"?>' +'<note importance="high" logged="true">' +'<title>Play</title>' +'<lens>Work</lens>' +'</note>';
let textEncoder = new util.TextEncoder();
let arrBuffer = textEncoder.encodeInto(strXml); // 对数据编码，防止包含中文字符乱码
// 1.基于ArrayBuffer构造XmlPullParser对象
let that = new xml.XmlPullParser(arrBuffer.buffer, 'UTF-8');// 2.基于DataView构造XmlPullParser对象
let dataView = new DataView(arrBuffer.buffer);
let that = new xml.XmlPullParser(dataView, 'UTF-8');

自定义回调函数，本例直接打印出标签及标签值。

let str = '';
function func(name, value){str = name + value;console.info(str);return true; //true:继续解析 false:停止解析
}

设置解析选项，调用parse函数。

let options = {supportDoctype:true, ignoreNameSpace:true, tagValueCallbackFunction:func};
that.parse(options);

输出结果如下所示：

note
title
Play
title
lens
Work
lens
note

解析XML属性和属性值引入模块。

import xml from '@ohos.xml';
import util from '@ohos.util'; // 需要使用util模块函数对文件编码

对XML文件编码后调用XmlPullParser。

let strXml ='<?xml version="1.0" encoding="utf-8"?>' +'<note importance="high" logged="true">' +'    <title>Play</title>' +'    <title>Happy</title>' +'    <lens>Work</lens>' +'</note>';
let textEncoder = new util.TextEncoder();
let arrBuffer = textEncoder.encodeInto(strXml); // 对数据编码，防止包含中文字符乱码
let that = new xml.XmlPullParser(arrBuffer.buffer, 'UTF-8');

自定义回调函数，本例直接打印出属性及属性值。

let str = '';
function func(name, value){str += name + ' ' + value + ' ';return true; // true:继续解析 false:停止解析
}

设置解析选项，调用parse函数。

let options = {supportDoctype:true, ignoreNameSpace:true, attributeValueCallbackFunction:func};
that.parse(options);
console.info(str); // 一次打印出所有的属性及其值输出结果如下所示：importance high logged true // note节点的属性及属性值

解析XML事件类型和元素深度引入模块。

import xml from '@ohos.xml';
import util from '@ohos.util'; // 需要使用util模块函数对文件编码

对XML文件编码后调用XmlPullParser。

let strXml ='<?xml version="1.0" encoding="utf-8"?>' +'<note importance="high" logged="true">' +'<title>Play</title>' +'</note>';
let textEncoder = new util.TextEncoder();
let arrBuffer = textEncoder.encodeInto(strXml); // 对数据编码，防止包含中文字符乱码
let that = new xml.XmlPullParser(arrBuffer.buffer, 'UTF-8');

自定义回调函数，本例直接打印元素事件类型及元素深度。

let str = '';
function func(name, value){str = name + ' ' + value.getDepth(); // getDepth 获取元素的当前深度console.info(str)return true; //true:继续解析 false:停止解析
}

设置解析选项，调用parse函数。

let options = {supportDoctype:true, ignoreNameSpace:true, tokenValueCallbackFunction:func};
that.parse(options);

输出结果如下所示：

0 0 // 0：<?xml version="1.0" encoding="utf-8"?> 对应事件类型START_DOCUMENT值为0  0：起始深度为0
2 1 // 2：<note importance="high" logged="true"> 对应事件类型START_TAG值为2       1：深度为1
2 2 // 2：<title>对应事件类型START_TAG值为2                                       2：深度为2
4 2 // 4：Play对应事件类型TEXT值为4                                               2：深度为2
3 2 // 3：</title>对应事件类型END_TAG值为3                                        2：深度为2
3 1 // 3：</note>对应事件类型END_TAG值为3                                         1：深度为1（与<note对应>）
1 0 // 1：对应事件类型END_DOCUMENT值为1                                           0：深度为0

场景示例

此处以调用所有解析选项为例，提供解析XML标签、属性和事件类型的开发示例。

import xml from '@ohos.xml';
import util from '@ohos.util';let strXml ='<?xml version="1.0" encoding="UTF-8"?>' +'<book category="COOKING">' +'<title lang="en">Everyday</title>' +'<author>Giada</author>' +'</book>';
let textEncoder = new util.TextEncoder();
let arrBuffer = textEncoder.encodeInto(strXml);
let that = new xml.XmlPullParser(arrBuffer.buffer, 'UTF-8');
let str = '';function tagFunc(name, value) {str = name + value;console.info('tag-' + str);return true;
}function attFunc(name, value) {str = name + ' ' + value;console.info('attri-' + str);return true;
}function tokenFunc(name, value) {str = name + ' ' + value.getDepth();console.info('token-' + str);return true;
}let options = {supportDocType: true,ignoreNameSpace: true,tagValueCallbackFunction: tagFunc,attributeValueCallbackFunction: attFunc,tokenValueCallbackFunction: tokenFunc
};
that.parse(options);

输出结果如下所示：

tag-
token-0 0
tag-book
attri-category COOKING
token-2 1
tag-title
attri-lang en
token-2 2
tag-Everyday
token-4 2
tag-title
token-3 2
tag-author
token-2 2
tag-Giada
token-4 2
tag-author
token-3 2
tag-book
token-3 1
tag-
token-1 0

本文主要介绍了在鸿蒙开发中，ArkTS语言中对XML全面解析，更多的Open Harmony4.0技术学习，可以看简介或主页寻找。下面分享一张鸿蒙4.0学习路线略缩图，完整版请找我拿。