轉(zhuǎn)貼 java對(duì)xml操作- -
文檔對(duì)象模型 (DOM) 是一個(gè)文檔標(biāo)準(zhǔn),對(duì)于完備的文檔和復(fù)雜的應(yīng)用程序,DOM 提供了大量靈活性。DOM標(biāo)準(zhǔn)是標(biāo)準(zhǔn)的。它很強(qiáng)壯且完整,并且有許多實(shí)現(xiàn)。這是許多大型安裝的決定因素--特別是對(duì)產(chǎn)品應(yīng)用程序,以避免在API發(fā)生改變時(shí)進(jìn)行大量的改寫(xiě)。
以上是我在選擇處理XML數(shù)據(jù)時(shí)之所以沒(méi)有選擇JDOM或者dom4j等其它面向?qū)ο蟮臉?biāo)準(zhǔn)的原因,不過(guò)也由于DOM從一開(kāi)始就是一種與語(yǔ)言無(wú)關(guān)的模型,而且它更趨向用于像C或Perl這類(lèi)語(yǔ)言,沒(méi)有利用Java的面向?qū)ο蟮男阅?,所以在使用的過(guò)程中也遇到了不少的麻煩,今天這里做一個(gè)小結(jié)。另外,我目前使用XML主要是作為數(shù)據(jù)傳輸?shù)慕y(tǒng)一格式,并統(tǒng)一用戶界面展示的接口,應(yīng)用的面并不是很廣,所以使用到的DOM的內(nèi)容其實(shí)不多。
在準(zhǔn)備使用它的時(shí)候,是做了充足的準(zhǔn)備的,也有遇到困難的準(zhǔn)備,所以一開(kāi)始就有了一個(gè)簡(jiǎn)單的工具類(lèi)來(lái)封裝DOM對(duì)象使用時(shí)必要的公共方法,實(shí)際證明這樣做是很明智的,一個(gè)簡(jiǎn)單的創(chuàng)建Document對(duì)象的操作,要是每次都需要寫(xiě)上5行以上代碼,并且還要處理那些煩人的Exception,實(shí)在是會(huì)打擊大家的積極性,所以在最初,做了一個(gè)XMLTool類(lèi),專(zhuān)門(mén)封裝了如下的公共方法:
1、 Document對(duì)象創(chuàng)建(包括空的Document對(duì)象創(chuàng)建,以一個(gè)給定Node節(jié)點(diǎn)作為根節(jié)點(diǎn)創(chuàng)建。
2、 將一個(gè)規(guī)范的XML字符串轉(zhuǎn)換成一個(gè)Document對(duì)象。
3、 從物理硬盤(pán)讀取一個(gè)XML文件并返回一個(gè)Document對(duì)象。
4、 將一個(gè)Node對(duì)象轉(zhuǎn)換成字符串。
其中每個(gè)方法都截獲相關(guān)的DOM操作所拋出的異常,轉(zhuǎn)換成一個(gè)RuntimeException拋出,這些異常在實(shí)際使用過(guò)程中,一般狀況下其實(shí)都不會(huì)拋出,特別是象生成一個(gè)Document對(duì)象時(shí)的ParserConfigurationException、轉(zhuǎn)換Node節(jié)點(diǎn)成字符串時(shí)要生成一個(gè)Transformer對(duì)象時(shí)的TransformerConfigurationException等等,沒(méi)有必要在它們身上花時(shí)間精力。而且真就出了相關(guān)的異常的話,其實(shí)根本沒(méi)有辦法處理,這樣的狀況通常是系統(tǒng)環(huán)境配置有問(wèn)題(比如必要的DOM實(shí)現(xiàn)解析器等包沒(méi)有加入環(huán)境),所以包裝該異常時(shí)只是很簡(jiǎn)要的獲取其Message拋出。
代碼如下:
/**
* 初始化一個(gè)空Document對(duì)象返回。
* @return a Document
*/
public static Document newXMLDocument() {
try {
return newDocumentBuilder().newDocument();
} catch (ParserConfigurationException e) {
throw new RuntimeException(e.getMessage());
}
}
/**
* 初始化一個(gè)DocumentBuilder
* @return a DocumentBuilder
* @throws ParserConfigurationException
*/
public static DocumentBuilder newDocumentBuilder()
throws ParserConfigurationException {
return newDocumentBuilderFactory().newDocumentBuilder();
}
/**
* 初始化一個(gè)DocumentBuilderFactory
* @return a DocumentBuilderFactory
*/
public static DocumentBuilderFactory newDocumentBuilderFactory() {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
return dbf;
}
/**
* 將傳入的一個(gè)XML String轉(zhuǎn)換成一個(gè)org.w3c.dom.Document對(duì)象返回。
* @param xmlString 一個(gè)符合XML規(guī)范的字符串表達(dá)。
* @return a Document
*/
public static Document parseXMLDocument(String xmlString) {
if (xmlString == null) {
throw new IllegalArgumentException();
}
try {
return newDocumentBuilder().parse(
new InputSource(new StringReader(xmlString)));
} catch (Exception e) {
throw new RuntimeException(e.getMessage());
}
}
/**
* 給定一個(gè)輸入流,解析為一個(gè)org.w3c.dom.Document對(duì)象返回。
* @param input
* @return a org.w3c.dom.Document
*/
public static Document parseXMLDocument(InputStream input) {
if (input == null) {
throw new IllegalArgumentException("參數(shù)為null!");
}
try {
return newDocumentBuilder().parse(input);
} catch (Exception e) {
throw new RuntimeException(e.getMessage());
}
}
/**
* 給定一個(gè)文件名,獲取該文件并解析為一個(gè)org.w3c.dom.Document對(duì)象返回。
* @param fileName 待解析文件的文件名
* @return a org.w3c.dom.Document
*/
public static Document loadXMLDocumentFromFile(String fileName) {
if (fileName == null) {
throw new IllegalArgumentException("未指定文件名及其物理路徑!");
}
try {
return newDocumentBuilder().parse(new File(fileName));
} catch (SAXException e) {
throw new IllegalArgumentException(
"目標(biāo)文件(" + fileName + ")不能被正確解析為XML!\n" + e.getMessage());
} catch (IOException e) {
throw new IllegalArgumentException(
"不能獲取目標(biāo)文件(" + fileName + ")!\n" + e.getMessage());
} catch (ParserConfigurationException e) {
throw new RuntimeException(e.getMessage());
}
}
/**
* 給定一個(gè)節(jié)點(diǎn),將該節(jié)點(diǎn)加入新構(gòu)造的Document中。
* @param node a Document node
* @return a new Document
*/
public static Document newXMLDocument(Node node) {
Document doc = newXMLDocument();
doc.appendChild(doc.importNode(node, true));
return doc;
}
/**
* 將傳入的一個(gè)DOM Node對(duì)象輸出成字符串。如果失敗則返回一個(gè)空字符串""。
* @param node DOM Node 對(duì)象。
* @return a XML String from node
*/
public static String toString(Node node) {
if (node == null) {
throw new IllegalArgumentException();
}
Transformer transformer = newTransformer();
if (transformer != null) {
try {
StringWriter sw = new StringWriter();
transformer.transform(
new DOMSource(node),
new StreamResult(sw));
return sw.toString();
} catch (TransformerException te) {
throw new RuntimeException(te.getMessage());
}
}
return errXMLString("不能生成XML信息!");
}
/**
* 將傳入的一個(gè)DOM Node對(duì)象輸出成字符串。如果失敗則返回一個(gè)空字符串""。
* @param node DOM Node 對(duì)象。
* @return a XML String from node
*/
public static String toString(Node node) {
if (node == null) {
throw new IllegalArgumentException();
}
Transformer transformer = newTransformer();
if (transformer != null) {
try {
StringWriter sw = new StringWriter();
transformer.transform(
new DOMSource(node),
new StreamResult(sw));
return sw.toString();
} catch (TransformerException te) {
throw new RuntimeException(te.getMessage());
}
}
return errXMLString("不能生成XML信息!");
}
/**
* 獲取一個(gè)Transformer對(duì)象,由于使用時(shí)都做相同的初始化,所以提取出來(lái)作為公共方法。
* @return a Transformer encoding gb2312
*/
public static Transformer newTransformer() {
try {
Transformer transformer =
TransformerFactory.newInstance().newTransformer();
Properties properties = transformer.getOutputProperties();
properties.setProperty(OutputKeys.ENCODING, "gb2312");
properties.setProperty(OutputKeys.METHOD, "xml");
properties.setProperty(OutputKeys.VERSION, "1.0");
properties.setProperty(OutputKeys.INDENT, "no");
transformer.setOutputProperties(properties);
return transformer;
} catch (TransformerConfigurationException tce) {
throw new RuntimeException(tce.getMessage());
}
}
/**
* 返回一段XML表述的錯(cuò)誤信息。提示信息的TITLE為:系統(tǒng)錯(cuò)誤。之所以使用字符串拼裝,主要是這樣做一般
* 不會(huì)有異常出現(xiàn)。
* @param errMsg 提示錯(cuò)誤信息
* @return a XML String show err msg
*/
public static String errXMLString(String errMsg) {
StringBuffer msg = new StringBuffer(100);
msg.append("<?xml version=\"1.0\" encoding=\"gb2312\" ?>");
msg.append("<errNode title=\"系統(tǒng)錯(cuò)誤\" errMsg=\"" + errMsg + "\"/>");
return msg.toString();
}
/**
* 返回一段XML表述的錯(cuò)誤信息。提示信息的TITLE為:系統(tǒng)錯(cuò)誤
* @param errMsg 提示錯(cuò)誤信息
* @param errClass 拋出該錯(cuò)誤的類(lèi),用于提取錯(cuò)誤來(lái)源信息。
* @return a XML String show err msg
*/
public static String errXMLString(String errMsg, Class errClass) {
StringBuffer msg = new StringBuffer(100);
msg.append("<?xml version=\"1.0\" encoding=\"gb2312\" ?>");
msg.append(
"<errNode title=\"系統(tǒng)錯(cuò)誤\" errMsg=\""
+ errMsg
+ "\" errSource=\""
+ errClass.getName()
+ "\"/>");
return msg.toString();
}
/**
* 返回一段XML表述的錯(cuò)誤信息。
* @param title 提示的title
* @param errMsg 提示錯(cuò)誤信息
* @param errClass 拋出該錯(cuò)誤的類(lèi),用于提取錯(cuò)誤來(lái)源信息。
* @return a XML String show err msg
*/
public static String errXMLString(
String title,
String errMsg,
Class errClass) {
StringBuffer msg = new StringBuffer(100);
msg.append("<?xml version=\"1.0\" encoding=\"gb2312\" ?>");
msg.append(
"<errNode title=\""
+ title
+ "\" errMsg=\""
+ errMsg
+ "\" errSource=\""
+ errClass.getName()
+ "\"/>");
return msg.toString();
}
以上都是DOM的基本應(yīng)用,所以就不一一詳細(xì)說(shuō)明了。
在實(shí)際使用過(guò)程中,有幾種狀況使用很頻繁,但是DOM的接口的設(shè)計(jì)卻使該操作很麻煩,所以分別添加了相應(yīng)的處理方法。
其中最麻煩的要數(shù)獲取一個(gè)節(jié)點(diǎn)的Text子節(jié)點(diǎn)文本信息了,如下的XML節(jié)點(diǎn):
<element>
text
</element>
在擁有element節(jié)點(diǎn)對(duì)象時(shí),要獲取其中的文本信息"text",首先要獲取element節(jié)點(diǎn)的子節(jié)點(diǎn)列表,要判斷其是否存在子節(jié)點(diǎn),如果存在,那么遍歷其子節(jié)點(diǎn)找到一個(gè)TextNode節(jié)點(diǎn),通過(guò)getNodeValue()方法來(lái)獲取該文本信息,由于這里element節(jié)點(diǎn)沒(méi)有信息時(shí)沒(méi)有子節(jié)點(diǎn),所以必須判斷element節(jié)點(diǎn)是否存在子節(jié)點(diǎn)才能去訪問(wèn)真正包含了文本信息的TextNode節(jié)點(diǎn),那么如果要處理的數(shù)據(jù)都是以這種形式給出的,就會(huì)增加大量的開(kāi)發(fā)代碼同時(shí)讓開(kāi)發(fā)工作枯燥無(wú)味,因此這里使用了一個(gè)默認(rèn)的約定實(shí)現(xiàn),就是,給出了一個(gè)公共方法,該方法取給定Node下的直接子節(jié)點(diǎn)的Text節(jié)點(diǎn)文本信息,如果不存在Text節(jié)點(diǎn)則返回null,這個(gè)約定雖然使該方法的使用有所限制,也可能導(dǎo)致錯(cuò)誤使用該方法,但是,按實(shí)際使用的狀況來(lái)看,這樣的約定和使用方式是沒(méi)有問(wèn)題的,因?yàn)閷?shí)際用到的都是上面舉的例子的狀況,代碼:
/**
* 這個(gè)方法獲取給定Node下的Text節(jié)點(diǎn)文本信息,如果不存在Text節(jié)點(diǎn)則返回null。
* 注意:是直接子節(jié)點(diǎn),相差2層或2層以上不會(huì)被考慮。
* @param node a Node 一個(gè)Node。
* @return a String 如果給定節(jié)點(diǎn)存在Text子節(jié)點(diǎn),則返回第一個(gè)訪問(wèn)到的Text子節(jié)點(diǎn)文本信息,如果不存在則返回null。
*/
public static String getNodeValue(Node node) {
if (node == null) {
return null;
}
Text text = getTextNode(node);
if (text != null) {
return text.getNodeValue();
}
return null;
}
/**
* 這個(gè)方法獲取給定Node下的Text節(jié)點(diǎn),如果不存在Text節(jié)點(diǎn)則返回null。
* 注意:是直接子節(jié)點(diǎn),相差2層或2層以上不會(huì)被考慮。
* @param node a Node 一個(gè)Node。
* @return a Text 如果給定節(jié)點(diǎn)存在Text子節(jié)點(diǎn),則返回第一個(gè)訪問(wèn)到的Text子節(jié)點(diǎn),如果不存在則返回null。
*/
public static Text getTextNode(Node node) {
if (node == null) {
return null;
}
if (node.hasChildNodes()) {
NodeList list = node.getChildNodes();
for (int i = 0; i < list.getLength(); i++) {
if (list.item(i).getNodeType() == Node.TEXT_NODE) {
return (Text) list.item(i);
}
}
}
return null;
}
上面代碼將獲取給定Node節(jié)點(diǎn)的直接Text子節(jié)點(diǎn)分開(kāi)包裝。
另一個(gè)很經(jīng)常碰到的狀況是,我希望直接定位到目標(biāo)節(jié)點(diǎn),獲取該節(jié)點(diǎn)對(duì)象,而不需要通過(guò)一層一層的節(jié)點(diǎn)遍歷來(lái)找到目標(biāo)節(jié)點(diǎn),DOM2接口中至少提供了如下的方式來(lái)定位節(jié)點(diǎn):
1、 對(duì)于Document對(duì)象:
1) getDocumentElement()――獲取根節(jié)點(diǎn)對(duì)象,實(shí)際很少使用的,因?yàn)楦?jié)點(diǎn)基本也就只是根節(jié)點(diǎn)而已,實(shí)際的數(shù)據(jù)節(jié)點(diǎn)都是根節(jié)點(diǎn)下的直接子節(jié)點(diǎn)開(kāi)始的。
2) getElementById(String elementId)――這個(gè)方法本來(lái)應(yīng)該是一個(gè)最佳的定位方法,但是在實(shí)際使用過(guò)程中沒(méi)有被我使用,其主要原因就是,這里的"ID"不同于一個(gè)節(jié)點(diǎn)的屬性"ID",這在org.w3c.dom.Document的API說(shuō)明中是明確指出,而我找了不少的資料也沒(méi)有看到有關(guān)的使用方式,所以只好放棄了。
3) getElementsByTagName(String tagname)――這個(gè)方法其實(shí)是沒(méi)有辦法的選擇,只好用它了,不過(guò)實(shí)際倒也很合用,雖然該方法返回的是一個(gè)NodeList,但是實(shí)際使用時(shí),將節(jié)點(diǎn)的tagName設(shè)計(jì)成特殊字符串,那么就可以直接獲取了,而實(shí)際使用時(shí),其實(shí)也差不多,很多時(shí)候會(huì)直接拿數(shù)據(jù)庫(kù)中的字段名來(lái)作為tagName,以方便得獲取該字段得值,在一個(gè)簡(jiǎn)單得約定下,使用了如下方法:
/**
* 這個(gè)方法檢索參數(shù)element下所有TagName為:tagName的節(jié)點(diǎn),并返回節(jié)點(diǎn)列表的第一個(gè)節(jié)點(diǎn)。
* 如果不存在該tagName的節(jié)點(diǎn),則返回null。
* @param element 待搜索節(jié)點(diǎn)
* @param tagName 待搜索標(biāo)簽名
* @return a Element 獲得以tagName為標(biāo)簽名的節(jié)點(diǎn)列表的第一個(gè)節(jié)點(diǎn)。
*/
public static Element getFirstElementByName(
Element element,
String tagName) {
return (Element) getFirstElement(element.getElementsByTagName(tagName));
}
/**
* 從給定節(jié)點(diǎn)列表中獲取第一個(gè)節(jié)點(diǎn)返回,如果節(jié)點(diǎn)集合為null/空,則返回null。
* @param nodeList a NodeList
* @return a Node
*/
private static Node getFirstElement(NodeList nodeList) {
if (nodeList == null || nodeList.getLength() == 0) {
return null;
}
return nodeList.item(0);
}
這個(gè)約定看似限制很大,其實(shí)實(shí)際使用時(shí)基本都是這樣的,只要獲取第一個(gè)給定tagName的Element節(jié)點(diǎn)就可以了的。
4)getElementsByTagNameNS(String namespaceURI, String localName)――這個(gè)方法基本沒(méi)有使用,因?yàn)檫€沒(méi)有碰到需要使用命名空間的狀況。
2、 對(duì)于Element對(duì)象――――Element對(duì)象和Document對(duì)象雷同,少了getDocumentElement()方法,不過(guò)和Document一樣也都是主要使用getElementsByTagName()方法。
3、 其它的節(jié)點(diǎn)對(duì)象基本沒(méi)有直接定位的訪問(wèn)方法
還有一種,是由于DOM2的限制導(dǎo)致的,DOM2規(guī)范中,不能將一個(gè)Document docA的節(jié)點(diǎn)直接加入到另一個(gè)Document docB對(duì)象的節(jié)點(diǎn)的子節(jié)點(diǎn)列表中,要這么做必須首先將docA的節(jié)點(diǎn)通過(guò)docB的importNode方法轉(zhuǎn)換后在添加到目標(biāo)節(jié)點(diǎn)的子節(jié)點(diǎn)列表中,所以也有一個(gè)方法來(lái)統(tǒng)一處理:
/**
* 這個(gè)方法將參數(shù)appendedDoc的根節(jié)點(diǎn)及其以下節(jié)點(diǎn)附加到doc的跟節(jié)點(diǎn)下面。
* 作為doc的跟節(jié)點(diǎn)的作后一個(gè)子節(jié)點(diǎn)。
* 相當(dāng)于:doc.appendDoc(appendedDoc);
* @param doc a Document
* @param appendedDoc a Document
*/
public static void appendXMLDocument(Document doc, Document appendedDoc) {
if (appendedDoc != null) {
doc.getFirstChild().appendChild(
doc.importNode(appendedDoc.getFirstChild(), true));
}
}
/**
* 這個(gè)方法將參數(shù)appendedDoc的根節(jié)點(diǎn)及其以下節(jié)點(diǎn)附加到node節(jié)點(diǎn)下面。
* 作為node節(jié)點(diǎn)的作后一個(gè)子節(jié)點(diǎn)。
* 相當(dāng)于:node.appendDoc(appendedNode);
* @param node 待添加的節(jié)點(diǎn)將被添加到該節(jié)點(diǎn)的最后。
* @param appendedNode a Node 這個(gè)節(jié)點(diǎn)將被添加作為node節(jié)點(diǎn)的最后一個(gè)子節(jié)點(diǎn)。
*/
public static void appendXMLDocument(Node node, Node appendedNode) {
if (appendedNode == null) {
return;
}
if (appendedNode instanceof Document) {
appendedNode = ((Document) appendedNode).getDocumentElement();
}
node.appendChild(
node.getOwnerDocument().importNode(appendedNode, true));
}
本站僅提供存儲(chǔ)服務(wù),所有內(nèi)容均由用戶發(fā)布,如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容,請(qǐng)
點(diǎn)擊舉報(bào)。