HarmonyOS 应用开发之XML生成、解析与转换

Android小贾2024-04-02 10:19

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

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

  • 元素指的是标记对，包含文本、属性或其他元素。

  • 属性提供了有关元素的其他信息。

  • 内容则是元素包含的数据或子元素。

XML还可以通过使用XML Schema或DTD（文档类型定义）来定义文档结构。这些机制允许开发人员创建自定义规则以验证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文件。

  1. 引入模块。

    ts 复制代码 
    import xml from '@ohos.xml';
import util from '@ohos.util';

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

    ts 复制代码 
    // 1.基于Arraybuffer构造XmlSerializer对象
let arrayBuffer: ArrayBuffer = new ArrayBuffer(2048); // 创建一个2048字节的缓冲区
let thatSer: xml.XmlSerializer = new xml.XmlSerializer(arrayBuffer); // 基于Arraybuffer构造XmlSerializer对象

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

  3. 调用XML元素生成函数。

    ts 复制代码 
    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();

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

    ts 复制代码 
    let view: Uint8Array = new Uint8Array(arrayBuffer); // 使用Uint8Array读取arrayBuffer的数据
let textDecoder: util.TextDecoder = util.TextDecoder.create(); // 调用util模块的TextDecoder类
let res: string = 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</title>\r\n    <author>Giada</author>\r\n    <year>2005</year>\r\n  </book>\r\n</bookstore>

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标签和标签值

  1. 引入模块。

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

  2. 对XML文件编码后调用XmlPullParser。

    可以基于ArrayBuffer构造XmlPullParser对象， 也可以基于DataView构造XmlPullParser对象。

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

// 2.基于DataView构造XmlPullParser对象
// let dataView: DataView = new DataView(arrBuffer.buffer as object as ArrayBuffer);
// let that: xml.XmlPullParser = new xml.XmlPullParser(dataView, 'UTF-8');

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

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

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

    ts 复制代码 
    let options: xml.ParseOptions = {supportDoctype:true, ignoreNameSpace:true, tagValueCallbackFunction:func};
that.parse(options);

    输出结果如下所示：

    note
title
Play
title
lens
Work
lens
note

解析XML属性和属性值

  1. 引入模块。

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

  2. 对XML文件编码后调用XmlPullParser。

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

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

    ts 复制代码 
    let str: string = '';
function func(name: string, value: string): boolean {
  str += name + ' ' + value + ' ';
  return true; // true:继续解析 false:停止解析
}

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

    ts 复制代码 
    let options: xml.ParseOptions = {supportDoctype:true, ignoreNameSpace:true, attributeValueCallbackFunction:func};
that.parse(options);
console.info(str); // 一次打印出所有的属性及其值

    输出结果如下所示：

    importance high logged true // note节点的属性及属性值

解析XML事件类型和元素深度

  1. 引入模块。

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

  2. 对XML文件编码后调用XmlPullParser。

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

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

    ts 复制代码 
    let str: string  = '';
function func(name: xml.EventType, value: xml.ParseInfo): boolean {
  str = name + ' ' + value.getDepth(); // getDepth 获取元素的当前深度
  console.info(str)
  return true; //true:继续解析 false:停止解析
}

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

    ts 复制代码 
    let options: xml.ParseOptions = {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标签、属性和事件类型的开发示例。

ts 复制代码 
import xml from '@ohos.xml';
import util from '@ohos.util';

let strXml: string =
  '<?xml version="1.0" encoding="UTF-8"?>' +
    '<book category="COOKING">' +
    '<title lang="en">Everyday</title>' +
    '<author>Giada</author>' +
    '</book>';
let textEncoder: util.TextEncoder = new util.TextEncoder();
let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml);
let that: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8');
let str: string = '';

function tagFunc(name: string, value: string): boolean {
  str = name + value;
  console.info('tag-' + str);
  return true;
}

function attFunc(name: string, value: string): boolean {
  str = name + ' ' + value;
  console.info('attri-' + str);
  return true;
}

function tokenFunc(name: xml.EventType, value: xml.ParseInfo): boolean {
  str = name + ' ' + value.getDepth();
  console.info('token-' + str);
  return true;
}

let options: xml.ParseOptions = {
  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

XML转换

将XML文本转换为JavaScript对象可以更轻松地处理和操作数据，并且更适合在JavaScript应用程序中使用。

语言基础类库提供ConvertXML类将XML文本转换为JavaScript对象，输入为待转换的XML字符串及转换选项，输出为转换后的JavaScript对象。

注意事项

XML解析及转换需要确保传入的XML数据符合标准格式。

开发步骤

此处以XML转为JavaScript对象后获取其标签值为例，说明转换效果。

  1. 引入模块。

    ts 复制代码 
    import convertxml from '@ohos.convertxml';

  2. 输入待转换的XML，设置转换选项。

    ts 复制代码 
    let xml: string =
 '<?xml version="1.0" encoding="utf-8"?>' +
 '<note importance="high" logged="true">' +
 '    <title>Happy</title>' +
 '    <todo>Work</todo>' +
 '    <todo>Play</todo>' +
 '</note>';
let options: convertxml.ConvertOptions = {
  // trim: false 转换后是否删除文本前后的空格，否
  // declarationKey: "_declaration" 转换后文件声明使用_declaration来标识
  // instructionKey: "_instruction" 转换后指令使用_instruction标识
  // attributesKey: "_attributes" 转换后属性使用_attributes标识
  // textKey: "_text" 转换后标签值使用_text标识
  // cdataKey: "_cdata" 转换后未解析数据使用_cdata标识
  // docTypeKey: "_doctype" 转换后文档类型使用_doctype标识
  // commentKey: "_comment" 转换后注释使用_comment标识
  // parentKey: "_parent" 转换后父类使用_parent标识
  // typeKey: "_type" 转换后元素类型使用_type标识
  // nameKey: "_name" 转换后标签名称使用_name标识
  // elementsKey: "_elements" 转换后元素使用_elements标识
  trim: false,
  declarationKey: "_declaration",
  instructionKey: "_instruction",
  attributesKey: "_attributes",
  textKey: "_text",
  cdataKey: "_cdata",
  doctypeKey: "_doctype",
  commentKey: "_comment",
  parentKey: "_parent",
  typeKey: "_type",
  nameKey: "_name",
  elementsKey: "_elements"
}

  3. 调用转换函数，打印结果。

    ts 复制代码 
    let conv: convertxml.ConvertXML = new convertxml.ConvertXML();
let result: object = conv.convertToJSObject(xml, options);
let strRes: string = JSON.stringify(result); // 将js对象转换为json字符串，用于显式输出
console.info(strRes);

    输出结果如下所示：

    json 复制代码 
    strRes:
{"_declaration":{"_attributes":{"version":"1.0","encoding":"utf-8"}},"_elements":[{"_type":"element","_name":"note",
 "_attributes":{"importance":"high","logged":"true"},"_elements":[{"_type":"element","_name":"title",
 "_elements":[{"_type":"text","_text":"Happy"}]},{"_type":"element","_name":"todo",
 "_elements":[{"_type":"text","_text":"Work"}]},{"_type":"element","_name":"todo",
 "_elements":[{"_type":"text","_text":"Play"}]}]}]}
相关推荐
Ares码农人生5 分钟前
React 前端框架简介
前端·react.js·前端框架
小汤猿人类6 分钟前
nacos-gateway动态路由
java·前端·gateway
GISer_Jing7 分钟前
前端经典面试合集（二）——Vue/React/Node/工程化工具/计算机网络
前端·vue.js·react.js·node.js
轻口味9 分钟前
【每日学点鸿蒙知识】Json字典问题、高度变化问题、开放测试版本问题、动态库单架构选择、WebView和H5交互
架构·json·harmonyos
迷迭所归处12 分钟前
Linux系统 —— 进程控制系列 - 进程的等待：wait 与 waitpid
linux·运维·服务器
周先森的怣忈13 分钟前
RHCE(第二部分)-----第三章：shell条件测试
linux·rhce
AIGCnn23 分钟前
jetson 无显示器配置WIFI
linux·jetson
yulingfeng5923 分钟前
Centos7 yum 报错“Could not resolve host: mirrorlist.centos.org； Unknown error“
linux·运维·centos
GesLuck1 小时前
C#控件开发4—仪表盘
前端·经验分享·c#
费曼乐园1 小时前
Zookeeper下面的conf目录下面的zoo.cfg
linux·分布式·zookeeper
热门推荐
01新手学习VR全景需要知道的几个问题02组基轨迹建模 GBTM的介绍与实现（Stata 或 R）03玄机平台应急响应—webshell查杀04docker安装启动问题解决排查05【一文读懂】NTN（非地面网络）技术介绍06HCIA-datacom数通题库和录播视频资料07Gitlab ci/cd08RAG 实践- Ollama+RagFlow 部署本地知识库09优化手机性能，解决卡顿问题：关闭这3个微信开关，释放内存空间10分布式训练原理总结（DP、PP、TP 、ZeRO）