xml解析與生成

說明： 本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import xml from '@ohos.xml';

XmlSerializer

constructor

constructor(buffer: ArrayBuffer | DataView, encoding?: string)

XmlSerializer的構造函數。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);

setAttributes

setAttributes(name: string, value: string): void

設置Attributes方法。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setAttributes("importance", "high");

addEmptyElement

addEmptyElement(name: string): void

寫入一個空元素。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);
thatSer.addEmptyElement("b"); // = >

setDeclaration

setDeclaration(): void

設置Declaration方法。

系統能力： SystemCapability.Utils.Lang

示例：

var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setDeclaration() // = > < ?xml version="1.0" encoding="utf-8"? >;

startElement

startElement(name: string): void

根據給定名稱寫入元素開始標記。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("notel");
thatSer.endElement();// = > '< notel/ >';

endElement

endElement(): void

寫入元素結束標記。

系統能力： SystemCapability.Utils.Lang

示例：

var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("table");
thatSer.setAttributes("importance", "high");
thatSer.setText("Happy");
endElement(); // = > < h:table importance="high" xmlns:h="http://www.w3.org/TR/html4/" >Happy< /h:table >

setNamespace

setNamespace(prefix: string, namespace: string): void

寫入當前元素標記的命名空間。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDeclaration();
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("note");
thatSer.endElement();// = >'< ?xml version="1.0" encoding="utf-8"? >rn< h:note xmlns:h="http://www.w3.org/TR/html4/"/ >';

setComment

setComment(text: string): void

寫入comment屬性。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
thatSer.setComment("Hi!");
thatSer.endElement(); // = > '< note >rn  < !--Hi!-- >rn< /note >';

setCDATA

setCDATA(text: string): void

寫入CDATA屬性。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1028);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setCDATA('root SYSTEM') // = > '< ![CDATA[root SYSTEM]] >';

setText

setText(text: string): void

設置Text方法。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
thatSer.setAttributes("importance", "high");
thatSer.setText("Happy1");
thatSer.endElement(); // = > '< note importance="high" >Happy1< /note >';

setDocType

setDocType(text: string): void

寫入DocType屬性。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDocType('root SYSTEM'); // = > '< !DOCTYPE root SYSTEM >';

XmlPullParser

XmlPullParser

constructor(buffer: ArrayBuffer | DataView, encoding?: string)

創建并返回一個XmlPullParser對象，該XmlPullParser對象傳參兩個, 第一參數是ArrayBuffer或DataView類型的一段內存，第二個參數為文件格式（默認為UTF-8）

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var strXml =
            '< ?xml version="1.0" encoding="utf-8"? >' +
            '< note importance="high" logged="true" >' +
            '    < title >Happy< /title >' +
            '    < todo >Work< /todo >' +
            '    < todo >Play< /todo >' +
            '< /note >';
var arrayBuffer = new ArrayBuffer(strXml.length*2);
var bufView = new Uint8Array(arrayBuffer);
var strLen = strXml.length;
for (var i = 0; i < strLen; ++i) {
    bufView[i] = strXml.charCodeAt(i);//設置arraybuffer方式
}
var that = new xml.XmlPullParser(arrayBuffer);

parse

parse(option: ParseOptions): void

該接口用于解析xml。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var strXml =
            '< ?xml version="1.0" encoding="utf-8"? >' +
            '< note importance="high" logged="true" >' +
            '    < title >Happy< /title >' +
            '    < todo >Work< /todo >' +
            '    < todo >Play< /todo >' +
            '< /note >';
var arrayBuffer = new ArrayBuffer(strXml.length*2);
var bufView = new Uint8Array(arrayBuffer);
var strLen = strXml.length;
for (var i = 0; i < strLen; ++i) {
    bufView[i] = strXml.charCodeAt(i);
}
var that = new xml.XmlPullParser(arrayBuffer);
var arrTag = {};
arrTag[0] = '132';
var i = 1;
function func(key, value){
    arrTag[i] = 'key:'+key+' value:'+ value.getDepth();
    i++;
    return true;
}
var options = {supportDoctype:true, ignoreNameSpace:true, tokenValueCallbackFunction:func}
that.parse(options);

ParseOptions

xml解析選項。

系統能力： 以下各項對應的系統能力均為SystemCapability.Utils.Lang

ParseInfo

當前xml解析信息。

getColumnNumber

getColumnNumber(): number

獲取當前列號，從1開始。

系統能力： SystemCapability.Utils.Lang

返回值：

getDepth

getDepth(): number

獲取元素的當前深度。

系統能力： SystemCapability.Utils.Lang

返回值：

getLineNumber

getLineNumber(): number

獲取當前行號，從1開始。

系統能力： SystemCapability.Utils.Lang

返回值：

getName

getName(): string

獲取當前元素名稱。

系統能力： SystemCapability.Utils.Lang

返回值：

getNamespace

getNamespace(): string

獲取當前元素的命名空間。

系統能力： SystemCapability.Utils.Lang

返回值：

getPrefix

getPrefix(): string

獲取當前元素前綴。

系統能力： SystemCapability.Utils.Lang

返回值：

getText

getText(): string

獲取當前事件的文本內容。

系統能力： SystemCapability.Utils.Lang

返回值：

isEmptyElementTag

isEmptyElementTag(): boolean

判斷當前元素是否為空元素。

系統能力： SystemCapability.Utils.Lang

返回值：

isWhitespace

isWhitespace(): boolean

判斷當前文本事件是否僅包含空格字符。

系統能力： SystemCapability.Utils.Lang

返回值：

getAttributeCount

getAttributeCount(): number

獲取當前開始標記的屬性數。

系統能力： SystemCapability.Utils.Lang

返回值：

EventType

事件枚舉。

系統能力： 以下各項對應的系統能力均為SystemCapability.Utils.Lang

審核編輯 黃宇