1# XML解析 2<!--Kit: ArkTS--> 3<!--Subsystem: CommonLibrary--> 4<!--Owner: @xliu-huanwei; @shilei123; @huanghello--> 5<!--Designer: @yuanyao14--> 6<!--Tester: @kirl75; @zsw_zhushiwei--> 7<!--Adviser: @ge-yafang--> 8 9 10对于以XML作为载体传递的数据，实际使用中需要对相关的元素进行解析，一般包括[解析XML标签和标签值](#解析xml标签和标签值)、[解析XML属性和属性值](#解析xml属性和属性值)、[解析XML事件类型和元素信息](#解析xml事件类型和元素信息)三类操作。如在Web服务中，XML是SOAP（Simple Object Access Protocol）协议的基础，SOAP消息通常以XML格式封装，包含请求和响应参数，通过解析这些XML消息，Web服务可以处理来自客户端的请求并生成相应的响应。 11 12 13XML模块提供XmlPullParser类用于解析XML文本，输入为包含XML数据的ArrayBuffer或DataView，输出为结构化的解析结果。 14 15 16 **表1** XML解析选项，其详细介绍请参见[ParseOptions](../reference/apis-arkts/js-apis-xml.md#parseoptions)。 17 18| 名称 | 类型 | 必填 | 说明 | 19| -------- | -------- | -------- | -------- | 20| supportDoctype | boolean | 否 | 是否解析文档类型，false表示不解析文档类型，true表示解析文档类型，默认false。 | 21| ignoreNameSpace | boolean | 否 | 是否忽略命名空间，忽略命名空间后，将不会对其进行解析。true表示忽略命名空间，false表示不忽略命名空间，默认false。| 22| tagValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取tagValue回调函数，打印XML标签及标签值。默认为undefined，表示不解析XML标签和标签值。 | 23| attributeValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取attributeValue回调函数，打印XML属性及属性值。默认为undefined，表示不解析XML属性和属性值。 | 24| tokenValueCallbackFunction | (eventType: EventType, value: ParseInfo) => boolean | 否 | 获取tokenValue回调函数，打印XML事件类型及parseInfo对应属性。默认为undefined，表示不解析XML事件类型。 | 25 26 27## 注意事项 28 29- 确保传入的XML数据符合标准格式。 30 31- 目前不支持解析指定节点的值。 32 33 34## 解析XML标签和标签值 35 361. 引入模块。 37 38 ```ts 39 import { xml, util } from '@kit.ArkTS'; // 需要使用util模块函数对文本编码 40 ``` 41 422. 对XML文本编码后调用XmlPullParser。 43 44 可以基于ArrayBuffer创建XmlPullParser对象，也可以基于DataView创建XmlPullParser对象（两种创建方式返回结果无区别可任选一种）。 45 46 ```ts 47 let strXml: string = 48 '<?xml version="1.0" encoding="utf-8"?>' + 49 '<note importance="high" logged="true">' + 50 '<title>Play</title>' + 51 '<lens>Work</lens>' + 52 '</note>'; 53 let textEncoder: util.TextEncoder = new util.TextEncoder(); 54 let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据进行编码，防止中文字符乱码 55 // 方式1：基于ArrayBuffer构造XmlPullParser对象 56 let xmlParser: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8'); 57 58 // 方式2：基于DataView构造XmlPullParser对象 59 // let dataView: DataView = new DataView(arrBuffer.buffer as object as ArrayBuffer); 60 // let xmlParser: xml.XmlPullParser = new xml.XmlPullParser(dataView, 'UTF-8'); 61 ``` 62 633. 自定义回调函数，本例直接打印出标签及标签值。 64 65 ```ts 66 function func(name: string, value: string): boolean { 67 if (name == 'note') { 68 console.info(name); 69 } 70 if (value == 'Play' || value == 'Work') { 71 console.info(' ' + value); 72 } 73 if (name == 'title' || name == 'lens') { 74 console.info(' ' + name); 75 } 76 return true; //true:继续解析 false:停止解析 77 } 78 ``` 79 804. 设置解析选项，调用parseXml函数。 81 82 ```ts 83 let options: xml.ParseOptions = {supportDoctype:true, ignoreNameSpace:true, tagValueCallbackFunction:func}; 84 xmlParser.parseXml(options); 85 ``` 86 87 输出结果如下所示： 88 89 ``` 90 note 91 title 92 Play 93 title 94 lens 95 Work 96 lens 97 note 98 ``` 99 100 101 102 103## 解析XML属性和属性值 104 1051. 引入模块。 106 107 ```ts 108 import { xml, util } from '@kit.ArkTS'; // 使用util模块对文本编码 109 ``` 110 1112. 对XML文本编码后调用XmlPullParser。 112 113 ```ts 114 let strXml: string = 115 '<?xml version="1.0" encoding="utf-8"?>' + 116 '<note importance="high" logged="true">' + 117 ' <title>Play</title>' + 118 ' <title>Happy</title>' + 119 ' <lens>Work</lens>' + 120 '</note>'; 121 let textEncoder: util.TextEncoder = new util.TextEncoder(); 122 let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据进行编码，防止中文字符乱码 123 let xmlParser: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8'); 124 ``` 125 1263. 自定义回调函数，示例直接打印出属性及属性值。 127 128 ```ts 129 let str: string = ''; 130 function func(name: string, value: string): boolean { 131 str += name + ' ' + value + ' '; 132 return true; // true:继续解析 false:停止解析 133 } 134 ``` 135 1364. 设置解析选项，调用parseXml函数。 137 138 ```ts 139 let options: xml.ParseOptions = {supportDoctype:true, ignoreNameSpace:true, attributeValueCallbackFunction:func}; 140 xmlParser.parseXml(options); 141 console.info(str); // 打印所有属性及其值 142 ``` 143 144 输出结果如下所示： 145 ``` 146 importance high logged true // note节点的属性及属性值 147 ``` 148 149 150## 解析XML事件类型和元素信息 151 1521. 引入模块。 153 154 ```ts 155 import { xml, util } from '@kit.ArkTS'; // 使用util模块函数对文本编码 156 ``` 157 1582. 对XML文本编码后调用XmlPullParser。 159 160 ```ts 161 let strXml: string = 162 '<?xml version="1.0" encoding="utf-8"?>' + 163 '<note importance="high" logged="true">' + 164 '<title>Play</title>' + 165 '</note>'; 166 let textEncoder: util.TextEncoder = new util.TextEncoder(); 167 let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据进行编码，防止中文字符乱码 168 let xmlParser: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8'); 169 ``` 170 1713. 自定义回调函数，示例直接打印元素事件类型及元素深度。 172 173 ```ts 174 let str: string = ''; 175 function func(name: xml.EventType, value: xml.ParseInfo): boolean { 176 str = name + ' ' + value.getDepth(); // getDepth 获取元素在XML文档中的当前深度 177 console.info(str); 178 return true; // true:继续解析 false:停止解析 179 } 180 ``` 181 1824. 设置解析选项，调用parseXml函数。 183 184 ```ts 185 let options: xml.ParseOptions = {supportDoctype:true, ignoreNameSpace:true, tokenValueCallbackFunction:func}; 186 xmlParser.parseXml(options); 187 ``` 188 189 输出结果如下所示： 190 191 ``` 192 0 0 // 0：<?xml version="1.0" encoding="utf-8"?> 对应事件类型START_DOCUMENT值为0 0：起始深度为0 193 2 1 // 2：<note importance="high" logged="true"> 对应事件类型START_TAG值为2 1：深度为1 194 2 2 // 2：<title>对应事件类型START_TAG值为2 2：深度为2 195 4 2 // 4：Play对应事件类型TEXT值为4 2：深度为2 196 3 2 // 3：</title>对应事件类型END_TAG值为3 2：深度为2 197 3 1 // 3：</note>对应事件类型END_TAG值为3 1：深度为1（与<note对应>） 198 1 0 // 1：对应事件类型END_DOCUMENT值为1 0：深度为0 199 ``` 200 201 202 203 204## 场景示例 205 206此处以调用所有解析选项为例，提供解析XML标签、属性和事件类型的开发示例。 207 208 209```ts 210import { xml, util } from '@kit.ArkTS'; 211 212let strXml: string = 213 '<?xml version="1.0" encoding="UTF-8"?>' + 214 '<book category="COOKING">' + 215 '<title lang="en">Everyday</title>' + 216 '<author>Giana</author>' + 217 '</book>'; 218let textEncoder: util.TextEncoder = new util.TextEncoder(); 219let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); 220let xmlParser: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8'); 221let str: string = ''; 222 223function tagFunc(name: string, value: string): boolean { 224 str = name + value; 225 console.info('tag-' + str); 226 return true; 227} 228 229function attFunc(name: string, value: string): boolean { 230 str = name + ' ' + value; 231 console.info('attri-' + str); 232 return true; 233} 234 235function tokenFunc(name: xml.EventType, value: xml.ParseInfo): boolean { 236 str = name + ' ' + value.getDepth(); 237 console.info('token-' + str); 238 return true; 239} 240 241let options: xml.ParseOptions = { 242 supportDoctype: true, 243 ignoreNameSpace: true, 244 tagValueCallbackFunction: tagFunc, 245 attributeValueCallbackFunction: attFunc, 246 tokenValueCallbackFunction: tokenFunc 247}; 248xmlParser.parseXml(options); 249``` 250 251输出结果如下所示： 252 253``` 254tag- 255token-0 0 256tag-book 257token-2 1 258attri-category COOKING 259tag-title 260token-2 2 261attri-lang en 262tag-Everyday 263token-4 2 264tag-title 265token-3 2 266tag-author 267token-2 2 268tag-Giana 269token-4 2 270tag-author 271token-3 2 272tag-book 273token-3 1 274tag- 275token-1 0 276``` 277