一、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 =
  '' +
    '' +
    'Play' +
    'Work' +
    '';
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模塊函數對文件編碼

1. 對 XML 文件編碼后調用 XmlPullParser。

let strXml =
  '' +
    '' +
    '    Play' +
    '    Happy' +
    '    Work' +
    '';
let textEncoder = new util.TextEncoder();
let arrBuffer = textEncoder.encodeInto(strXml); // 對數據編碼，防止包含中文字符亂碼
let that = new xml.XmlPullParser(arrBuffer.buffer, 'UTF-8');

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

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

1. 設置解析選項，調用 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 =
  '' +
  '' +
  'Play' +
  '';
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： 對應事件類型START_DOCUMENT值為0  0：起始深度為0
2 1 // 2： 對應事件類型START_TAG值為2       1：深度為1
2 2 // 2：對應事件類型START_TAG值為2                                       2：深度為2
4 2 // 4：Play對應事件類型TEXT值為4                                               2：深度為2
3 2 // 3：對應事件類型END_TAG值為3                                        2：深度為2
3 1 // 3：對應事件類型END_TAG值為3                                         1：深度為1（與）
1 0 // 1：對應事件類型END_DOCUMENT值為1                                           0：深度為0
場景示例

場景示例

此處以調用所有解析選項為例，提供解析 XML 標簽、屬性和事件類型的開發示例。

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

let strXml =
  '' +
    '' +
    'Everyday' +
    'Giada' +
    '';
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 =
  '' +
    '' +
    '    Happy' +
    '    Work' +
    '    Play' +
    '';
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']; // 解析標簽對應的值
let todo = result['_elements'][0]['_elements'][1]['_elements'][0]['_text']; // 解析標簽對應的值
let todo2 = result['_elements'][0]['_elements'][2]['_elements'][0]['_text']; // 解析標簽對應的值
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

審核編輯 黃宇