一、XML解析對於以XML作為載體傳遞的數據，實際使用中需要對相關的節點進行解析，一般包括解析XML標簽和標簽值、解析XML屬性和屬性值、解析XML事件類型和元素深度三類場景。 XML模塊提供XmlPullParser類對XML文件解析，輸入為含有XML文本的ArrayBuffer或DataVie ...

一、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. 引入模塊。

import xml from '@ohos.xml';
import util from '@ohos.util'; // 需要使用util模塊函數對文件編碼

2.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');

3. 自定義回調函數，本例直接列印出標簽及標簽值。

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

4. 設置解析選項，調用parse函數。

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

輸出結果如下所示：

note
title
Play
title
lens
Work
lens
note

解析XML屬性和屬性值

1.引入模塊。

import xml from '@ohos.xml';
import util from '@ohos.util'; // 需要使用util模塊函數對文件編碼

2.對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');

3.自定義回調函數，本例直接列印出屬性及屬性值。

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

4.設置解析選項，調用parse函數。

let options = {supportDoctype:true, ignoreNameSpace:true, attributeValueCallbackFunction:func};
that.parse(options);
console.info(str); // 一次列印出所有的屬性及其值

輸出結果如下所示：

importance high logged true // note節點的屬性及屬性值

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

1. 引入模塊。

import xml from '@ohos.xml';
import util from '@ohos.util'; // 需要使用util模塊函數對文件編碼

2. 對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');

3. 自定義回調函數，本例直接列印元素事件類型及元素深度。

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

4. 設置解析選項，調用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

二、 XML轉換

將XML文本轉換為JavaScript對象可以更輕鬆地處理和操作數據，並且更適合在JavaScript應用程式中使用。

語言基礎類庫提供ConvertXML類將XML文本轉換為JavaScript對象，輸入為待轉換的XML字元串及轉換選項，輸出為轉換後的JavaScript對象。具體轉換選項可見@ohos.convertxml。

註意事項

XML解析及轉換需要確保傳入的XML數據符合標準格式。

開發步驟

此處以XML轉為JavaScript對象後獲取其標簽值為例，說明轉換效果。

1. 引入模塊。

import convertxml from '@ohos.convertxml';

2. 輸入待轉換的XML，設置轉換選項。

let xml =
  '<?xml version="1.0" encoding="utf-8"?>' +
    '<note importance="high" logged="true">' +
    '    <title>Happy</title>' +
    '    <todo>Work</todo>' +
    '    <todo>Play</todo>' +
    '</note>';
let options = {
  // 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. 調用轉換函數，列印結果。

let conv = new convertxml.ConvertXML();
let result = conv.convertToJSObject(xml, options);
let strRes = JSON.stringify(result); // 將js對象轉換為json字元串，用於顯式輸出
console.info(strRes);
// 也可以直接處理轉換後的JS對象，獲取標簽值
let title = result['_elements'][0]['_elements'][0]['_elements'][0]['_text']; // 解析<title>標簽對應的值
let todo = result['_elements'][0]['_elements'][1]['_elements'][0]['_text']; // 解析<todo>標簽對應的值
let todo2 = result['_elements'][0]['_elements'][2]['_elements'][0]['_text']; // 解析<todo>標簽對應的值
console.info(title); // Happy
console.info(todo); // Work
console.info(todo2); // Play

輸出結果如下所示：

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"}]}]}]}
title:Happy
todo:Work
todo2:Play

本文由博客一文多發平臺 OpenWrite 發佈！

【中秋國慶不斷更】XML在HarmonyOS中的生成，解析與轉換（下）

一、XML解析

註意事項

解析XML標簽和標簽值

解析XML屬性和屬性值

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

場景示例

二、 XML轉換

註意事項

開發步驟