java 如何使用org.w3c.dom操作XML文件
本篇介紹在java中，如何使用org.w3c.dom中的相關內容來操作XML文件。包括：
- 如何在內存中構建XML文件並寫入磁盤；
- 如何從磁盤讀取XML文件到內存；
- 如何添加註釋，讀取註釋；
- 如何添加屬性，讀取屬性；
- 如何添加子元素，讀取子元素；
下面直接貼出樣例代碼：
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Scanner;
import java.util.Set;
public class XMLSample{
private static void writeXML(Document document, String filePath) {
TransformerFactory transFactory = TransformerFactory.newInstance();
Transformer transformer = null;
try {
String parent = new File(filePath).getParent();
File pDir = new File(parent);
if (!pDir.exists()) {
pDir.mkdirs();
}
OutputStream os = new FileOutputStream(new File(filePath));
transformer = transFactory.newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
transformer.setOutputProperty(OutputKeys.ENCODING, "utf-8");
DOMSource source = new DOMSource();
source.setNode(document);
StreamResult result = new StreamResult();
result.setOutputStream(os);
transformer.transform(source, result);
os.flush();
} catch (TransformerConfigurationException e) {
e.printStackTrace();
} catch (TransformerException e) {
e.printStackTrace();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
private static Document readXML(String file) {
try {
// 得到DOM解析器的工廠實例
DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
// 從DOM工廠中獲得DOM解析器
DocumentBuilder dbBuilder = dbFactory.newDocumentBuilder();
// 把要解析的xml文檔讀入DOM解析器
Document doc = dbBuilder.parse(file);
return doc;
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
public static void showXMLDetail() {
Document document = readXML(mapperFilePath);
// 獲取標簽名為"dataset"的元素
Node mapper = document.getElementsByTagName("dataset").item(0);
// 下面依次讀取dataset元素的每個子元素，每個子元素的標簽名字為node
for (int i = 0; i < mapper.getChildNodes().getLength(); i++) {
Node node = mapper.getChildNodes().item(i);
String s = item.getNodeName();
if(s.toLowerCase().equals("#comment")){
System.out.println("這是註釋內容: "+node.getTextContent());
}else if(s.toLowerCase().equals("#text")){
System.out.println("吶，這是標簽之外的文本: "+node.getTextContent());
}else if ("node".equals(s)) {
// 獲取元素屬性的值
String column = item.getAttributes().getNamedItem("column").getNodeValue();
String field = item.getAttributes().getNamedItem("property").getNodeValue();
}else{
// 其他的就不要瞭
}
}
}
public static void generateXML(){
try {
Element root;
Set<String> set = new HashSet<>();
set.add("node");
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(true);
DocumentBuilder documentBuilder = null;
documentBuilder = factory.newDocumentBuilder();
Document document = documentBuilder.newDocument();
root = document.createElement("dataset");
document.appendChild(root);
set.forEach(p -> {
Element element = document.createElement(p);
element.setAttribte("column","haha");
element.setAttribte("property","heihei");
root.appendChild(element);
});
writeXML(document, "d:/allTables.xml");
} catch (ParserConfigurationException e) {
e.printStackTrace();
}
}
}
Java操作XML（使用org.w3c.dom）
一、創建DOM
XMLBuilder.java
用於創建ＤＯＭ，Root結點
/********************************************************************
* 項目名稱 ：rochoc <p>
* 包名稱 ：rochoc.xml.oper <p>
* 文件名稱 ：XmlBuilder <p>
* 編寫者 ：luoc <p>
* 編寫日期 ：2005-6-22 <p>
* 程序功能（類）描述 ： 根據傳入的XML文件生成Document和root結點<p>
*
* 程序變更日期 ：
* 變更作者 ：
* 變更說明 ：
********************************************************************/
package rochoc.xml.oper;
import java.io.File;
import java.io.IOException;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.log4j.Logger;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;
/**
* 類名：XmlBuilder <p>
* 類描述：根據傳入的XML文件生成Document和root結點 <p>
* 編寫者 ：luoc<p>
* 編寫日期 ：2005-6-22<p>
* 主要public成員變量：<p>
* 主要public方法： <p>
**/
public class XmlBuilder
{
/**
*構造函數說明： <p>
*參數說明：@param path <p>
**/
public XmlBuilder(String path)
{
this.path=path;
init();
}
/**
* 方法名稱：init<p>
* 方法功能：初始化函數<p>
* 參數說明： <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public void init()
{
buildDocument();
buildRoot();
}
/**
* 方法名稱：buildDocument<p>
* 方法功能：將XML文件生成Document <p>
* 參數說明： <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
private void buildDocument()
{
DocumentBuilderFactory factory=DocumentBuilderFactory.newInstance();
try
{
DocumentBuilder builder=factory.newDocumentBuilder();
logger.debug("Construct document builder success.");
doc=builder.parse(new File(path));
logger.debug("Build xml document success.");
}catch(ParserConfigurationException e)
{
logger.error("Construct document builder error:"+e);
}catch(SAXException e)
{
logger.error("Parse xml file error:"+e);
}catch(IOException e)
{
logger.error("Read xml file error:"+e);
}
}
/**
* 方法名稱：buildRoot<p>
* 方法功能：生成XML的根結點<p>
* 參數說明： <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
private void buildRoot()
{
root=doc.getDocumentElement();
}
/**
* @return 返回 doc。
*/
public Document getDoc()
{
return doc;
}
/**
* @param doc 要設置的 doc。
*/
public void setDoc(Document doc)
{
this.doc = doc;
}
/**
* @return 返回 path。
*/
public String getPath()
{
return path;
}
/**
* @param path 要設置的 path。
*/
public void setPath(String path)
{
this.path = path;
}
/**
* @return 返回 root。
*/
public Element getRoot()
{
return root;
}
/**
* @param root 要設置的 root。
*/
public void setRoot(Element root)
{
this.root = root;
}
/*全局變量*/
private String path=null;//xml文件路徑
private Document doc=null;//xml文件對應的document
private Element root=null;//xml文件的根結點
private Logger logger=Logger.getLogger(getClass().getName());
}
二、查找，插入，刪除，修改
XmlOper.java
用於操作ＸＭＬ文件，包括查找、新增、刪除、修改結點
/********************************************************************
* 項目名稱 ：rochoc <p>
* 包名稱 ：rochoc.xml.oper <p>
* 文件名稱 ：XmlOper <p>
* 編寫者 ：luoc <p>
* 編寫日期 ：2005-6-22 <p>
* 程序功能（類）描述 ： 對XML進行讀寫操作 <p>
*
* 程序變更日期 ：
* 變更作者 ：
* 變更說明 ：
********************************************************************/
package rochoc.xml.oper;
import java.util.ArrayList;
import org.apache.log4j.Logger;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* 類名：XmlOper <p>
* 類描述：對XML文件進行讀寫操作,均為靜態函數 <p>
* 編寫者 ：luoc<p>
* 編寫日期 ：2005-6-22<p>
* 主要public成員變量：<p>
* 主要public方法： <p>
**/
public class XmlOper
{
/**
*構造函數說明： <p>
*參數說明： <p>
**/
private XmlOper()
{
}
/**
* 方法名稱：getNodeList<p>
* 方法功能：獲取父結點parent的所有子結點<p>
* 參數說明：@param parent
* 參數說明：@return <p>
* 返回：NodeList <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static NodeList getNodeList(Element parent)
{
return parent.getChildNodes();
}
/**
* 方法名稱：getElementsByName<p>
* 方法功能：在父結點中查詢指定名稱的結點集 <p>
* 參數說明：@param parent
* 參數說明：@param name
* 參數說明：@return <p>
* 返回：Element[] <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static Element [] getElementsByName(Element parent,String name)
{
ArrayList resList=new ArrayList();
NodeList nl=getNodeList(parent);
for(int i=0;i<nl.getLength();i++)
{
Node nd=nl.item(i);
if(nd.getNodeName().equals(name))
{
resList.add(nd);
}
}
Element [] res=new Element [resList.size()];
for(int i=0;i<resList.size();i++)
{
res[0]=(Element)resList.get(i);
}
logger.debug(parent.getNodeName()+"'s children of "+name+
"'s num:"+res.length);
return res;
}
/**
* 方法名稱：getElementName<p>
* 方法功能：獲取指定Element的名稱 <p>
* 參數說明：@param element
* 參數說明：@return <p>
* 返回：String <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static String getElementName(Element element)
{
return element.getNodeName();
}
/**
* 方法名稱：getElementValue<p>
* 方法功能：獲取指定Element的值<p>
* 參數說明：@param element
* 參數說明：@return <p>
* 返回：String <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static String getElementValue(Element element)
{
NodeList nl=element.getChildNodes();
for(int i=0;i<nl.getLength();i++)
{
if(nl.item(i).getNodeType()==Node.TEXT_NODE)//是一個Text Node
{
logger.debug(element.getNodeName()+" has a Text Node.");
return element.getFirstChild().getNodeValue();
}
}
logger.error(element.getNodeName()+" hasn't a Text Node.");
return null;
}
/**
* 方法名稱：getElementAttr<p>
* 方法功能：獲取指定Element的屬性attr的值 <p>
* 參數說明：@param element
* 參數說明：@param attr
* 參數說明：@return <p>
* 返回：String <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static String getElementAttr(Element element,String attr)
{
return element.getAttribute(attr);
}
/**
* 方法名稱：setElementValue<p>
* 方法功能：設置指定Element的值 <p>
* 參數說明：@param element
* 參數說明：@param val <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static void setElementValue(Element element,String val)
{
Node node=element.getOwnerDocument().createTextNode(val);
NodeList nl=element.getChildNodes();
for(int i=0;i<nl.getLength();i++)
{
Node nd=nl.item(i);
if(nd.getNodeType()==Node.TEXT_NODE)//是一個Text Node
{
nd.setNodeValue(val);
logger.debug("modify "+element.getNodeName()+"'s node value succe.");
return;
}
}
logger.debug("new "+element.getNodeName()+"'s node value succe.");
element.appendChild(node);
}
/**
* 方法名稱：setElementAttr<p>
* 方法功能：設置結點Element的屬性<p>
* 參數說明：@param element
* 參數說明：@param attr
* 參數說明：@param attrVal <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static void setElementAttr(Element element,
String attr,String attrVal)
{
element.setAttribute(attr,attrVal);
}
/**
* 方法名稱：addElement<p>
* 方法功能：在parent下增加結點child<p>
* 參數說明：@param parent
* 參數說明：@param child <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static void addElement(Element parent,Element child)
{
parent.appendChild(child);
}
/**
* 方法名稱：addElement<p>
* 方法功能：在parent下增加字符串tagName生成的結點<p>
* 參數說明：@param parent
* 參數說明：@param tagName <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static void addElement(Element parent,String tagName)
{
Document doc=parent.getOwnerDocument();
Element child=doc.createElement(tagName);
parent.appendChild(child);
}
/**
* 方法名稱：addElement<p>
* 方法功能：在parent下增加tagName的Text結點，且值為text<p>
* 參數說明：@param parent
* 參數說明：@param tagName
* 參數說明：@param text <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static void addElement(Element parent,String tagName,String text)
{
Document doc=parent.getOwnerDocument();
Element child=doc.createElement(tagName);
setElementValue(child,text);
parent.appendChild(child);
}
/**
* 方法名稱：removeElement<p>
* 方法功能：將父結點parent下的名稱為tagName的結點移除<p>
* 參數說明：@param parent
* 參數說明：@param tagName <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public static void removeElement(Element parent,String tagName)
{
logger.debug("remove "+parent.getNodeName()+"'s children by tagName "+tagName+" begin...");
NodeList nl=parent.getChildNodes();
for(int i=0;i<nl.getLength();i++)
{
Node nd=nl.item(i);
if(nd.getNodeName().equals(tagName))
{
parent.removeChild(nd);
logger.debug("remove child '"+nd+"' success.");
}
}
logger.debug("remove "+parent.getNodeName()+"'s children by tagName "+tagName+" end.");
}
/*全局變量*/
static Logger logger=Logger.getLogger("XmlOper");
}
三、新建XML文件
XmlCreater.java
用於創建ＸＭＬ文件
/********************************************************************
* 項目名稱 ：rochoc <p>
* 包名稱 ：rochoc.xml.oper <p>
* 文件名稱 ：XmlCreater <p>
* 編寫者 ：luoc <p>
* 編寫日期 ：2005-6-22 <p>
* 程序功能（類）描述 ： 創建DOM並生成XML文件 <p>
*
* 程序變更日期 ：
* 變更作者 ：
* 變更說明 ：
********************************************************************/
package rochoc.xml.oper;
import java.io.File;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.apache.log4j.Logger;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* 類名：XmlCreater <p>
* 類描述： 創建DOM並生成XML文件<p>
* 編寫者 ：luoc<p>
* 編寫日期 ：2005-6-22<p>
* 主要public成員變量：<p>
* 主要public方法： <p>
**/
public class XmlCreater
{
/**
*構造函數說明： <p>
*參數說明：@param path xml文件路徑 <p>
**/
public XmlCreater(String path)
{
this.path=path;
init();
}
/**
* 方法名稱：init<p>
* 方法功能： 初始化函數 <p>
* 參數說明： <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
private void init()
{
DocumentBuilderFactory factory=DocumentBuilderFactory.newInstance();
try
{
DocumentBuilder builder=factory.newDocumentBuilder();
doc=builder.newDocument();//新建DOM
}catch(ParserConfigurationException e)
{
logger.error("Parse DOM builder error:"+e);
}
}
/**
* 方法名稱：createRootElement<p>
* 方法功能：創建根結點，並返回 <p>
* 參數說明：@param rootTagName <p>
* 返回：Element <p>
* 作者：luoc
* 日期：2005-6-22
**/
public Element createRootElement(String rootTagName)
{
if(doc.getDocumentElement()==null)
{
logger.debug("create root element '"+rootTagName+"' success.");
Element root=doc.createElement(rootTagName);
doc.appendChild(root);
return root;
}
logger.warn("this dom's root element is exist,create fail.");
return doc.getDocumentElement();
}
/**
* 方法名稱：createElement<p>
* 方法功能：在parent結點下增加子結點tagName<p>
* 參數說明：@param parent
* 參數說明：@param tagName <p>
* 返回：Element <p>
* 作者：luoc
* 日期：2005-6-22
**/
public Element createElement(Element parent,String tagName)
{
Document doc=parent.getOwnerDocument();
Element child=doc.createElement(tagName);
parent.appendChild(child);
return child;
}
/**
* 方法名稱：createElement<p>
* 方法功能：在parent結點下增加值為value的子結點tabName<p>
* 參數說明：@param parent
* 參數說明：@param tagName
* 參數說明：@param value <p>
* 返回：Element <p>
* 作者：luoc
* 日期：2005-6-22
**/
public Element createElement(Element parent,String tagName,String value)
{
Document doc=parent.getOwnerDocument();
Element child=doc.createElement(tagName);
XmlOper.setElementValue(child,value);
parent.appendChild(child);
return child;
}
/**
* 方法名稱：createAttribute<p>
* 方法功能：在parent結點下增加屬性 <p>
* 參數說明：@param parent
* 參數說明：@param attrName 屬性名
* 參數說明：@param attrValue 屬性值<p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public void createAttribute(Element parent,String attrName,String attrValue)
{
XmlOper.setElementAttr(parent,attrName,attrValue);
}
/**
* 方法名稱：buildXmlFile<p>
* 方法功能：根據DOM生成XML文件<p>
* 參數說明： <p>
* 返回：void <p>
* 作者：luoc
* 日期：2005-6-22
**/
public void buildXmlFile()
{
TransformerFactory tfactory=TransformerFactory.newInstance();
try
{
Transformer transformer=tfactory.newTransformer();
DOMSource source=new DOMSource(doc);
logger.debug("New DOMSource success.");
StreamResult result=new StreamResult(new File(path));
logger.debug("New StreamResult success.");
transformer.setOutputProperty("encoding","GBK");
transformer.transform(source,result);
logger.debug("Build XML File '"+path+"' success.");
}catch(TransformerConfigurationException e)
{
logger.error("Create Transformer error:"+e);
}catch(TransformerException e)
{
logger.error("Transformer XML file error:"+e);
}
}
/**
* @return 返回 doc。
*/
public Document getDoc()
{
return doc;
}
/**
* @param doc 要設置的 doc。
*/
public void setDoc(Document doc)
{
this.doc = doc;
}
/**
* @return 返回 path。
*/
public String getPath()
{
return path;
}
/**
* @param path 要設置的 path。
*/
public void setPath(String path)
{
this.path = path;
}
/*全局變量*/
private Logger logger = Logger.getLogger(getClass().getName());
private Document doc=null;//新創建的DOM
private String path=null;//生成的XML文件絕對路徑
}
以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。
推薦閱讀：
- Java dom4j生成與解析XML案例詳解
- Java數據結構中堆的向下和向上調整解析
- java爬蟲Jsoup主要類及功能使用詳解
- java數據結構圖論霍夫曼樹及其編碼示例詳解
- Java org.w3c.dom.Document 類方法引用報錯