XML文件解析及其工具制作

XML文档解析工具（DOM解析）

设计目的

• XML文档及其存储的结构化数据，可以为Java编程提供极大的便利;因此XML文档的解析工作会经常进行，为了简化XML文档解析的操作过程，节约编码时间，将编程重点更多的放到要处理的业务及问题上，我们把XML文档的解析过程工具化。

DOM解析原理：

• XML解析器一次性把整个XML文档加载进内存，然后在内存中构建一颗Document的对象树，通过Document对象，得到树上的节点对象，通过节点对象访问（操作）到XML文档的内容。

XML文档

XML文档具有结构化的特点，其书写有一定的规范。在该test.xml文档中，students元素为根元素,在元素student中，可以通过键=”值“的形式定义多个属性，如id，name，sex等，需要注意的是，值必须用双引号括起来。

设计步骤

1.通过抽象工厂类DocumentBuilderFactory类实例化一个DocumentBuilder类的对象(对于不同的XML文档解析，这个对象只需要一个就够了，因此这里使用单例模式来实例化对象);

private static DocumentBuilder db;

static {
		try {
			db = DocumentBuilderFactory.newInstance().newDocumentBuilder();
		} catch (ParserConfigurationException e) {
			e.printStackTrace();
		}
}

2.在得到了DocumentBuilder对象后，需要调用parse（InputStream）方法才能打开要处理的XML文档，得到一个Document类的对象；

public static Document LoadXml(InputStream is) throws SAXException, IOException {
		return db.parse(is);
}

public static Document LoadXml(String xmlPath) throws SAXException, IOException {
		InputStream is = XMLParser.class.getResourceAsStream(xmlPath);
		return LoadXml(is);
}

3.得到XML文档实例化的Document对象后，再根据元素名处理里面的元素，需要注意的是，我们作为XML解析工具的制作者，不知道也无权决定用户对元素的属性及内容的具体处理过程，因此工具里面定义了一个抽象方DealElement(Element element, int index)，具体的实现过程应由使用该工具的用户实现。

public abstract void DealElement(Element element, int index);

public void parseTag(Document document, String tagname) {
		NodeList nodeList = document.getElementsByTagName(tagname);//获取document中的名为tagname的元素名列表
		for (int index = 0; index < nodeList.getLength(); index++) {
			Element element = (Element) nodeList.item(index);
			DealElement(element, index);//怎样处理由用户决定
		}
}

public void parseTag(Element element, String tagname) {//获取element元素里面名为tagname的元素列表
		NodeList nodeList = element.getElementsByTagName(tagname);
		for (int index = 0; index < nodeList.getLength(); index++) {
			Element ele = (Element) nodeList.item(index);
			DealElement(ele, index);
		}
}

XMLParser类完整代码

package com.xmlparsertool.util;
import java.io.IOException;
import java.io.InputStream;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

public abstract class XMLParser {
	private static DocumentBuilder db;
	
	public XMLParser() {
	}
	
	static {
		try {
			db = DocumentBuilderFactory.newInstance().newDocumentBuilder();
		} catch (ParserConfigurationException e) {
			e.printStackTrace();
		}
	}
	
	public static Document LoadXml(InputStream is) throws SAXException, IOException {
		return db.parse(is);
	}
	
	public static Document LoadXml(String xmlPath) throws SAXException, IOException {
		InputStream is = XMLParser.class.getResourceAsStream(xmlPath);
		return LoadXml(is);
	}
	
	
	
	public abstract void DealElement(Element element, int index);
	
	public void parseTag(Document document, String tagname) {
		NodeList nodeList = document.getElementsByTagName(tagname);
		for (int index = 0; index < nodeList.getLength(); index++) {
			Element element = (Element) nodeList.item(index);
			DealElement(element, index);
		}
	}
	
	public void parseTag(Element element, String tagname) {
		NodeList nodeList = element.getElementsByTagName(tagname);
		for (int index = 0; index < nodeList.getLength(); index++) {
			Element ele = (Element) nodeList.item(index);
			DealElement(ele, index);
		}
	}
	
}

需要注意的是，在设计XMLParser解析工具类的时候，不要导错包了。

测试代码

package com.xmlparsetool.test;

import java.io.IOException;

import org.w3c.dom.Element;
import org.xml.sax.SAXException;

import com.xmlparsertool.util.XMLParser;

public class XMLParseTest {

	public static void main(String[] args) {
		try {
			new XMLParser() {
				
				@Override
				public void DealElement(Element element, int index) {//用户实现的处理元素的方法
					String id=element.getAttribute("id");
					String name=element.getAttribute("name");
					String sex=element.getAttribute("sex");
					System.out.println(id+" : "+name+" : "+sex);
					
					new XMLParser() {
						@Override
						public void DealElement(Element element, int index) {
							String hobby=element.getTextContent();
							System.out.println("\t第"+(index+1)+" 个爱好："+hobby);
						}
					}.parseTag(element, "hobby");;
				}
			}.parseTag(XMLParser.LoadXml("/test.xml"), "student");
		} catch (SAXException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		};
	}
}

结果截图

回顾总结

XML文档的解析方式有好几种，这里是用DOM解析原理来设计解析工具的，若读者想设计功能更丰富的XML解析工具，读者可自行查阅其他解析方式。
从DOM解析原理我们可以看出，这种解析方式一次性将XML文档加载到内存来构建层次结构，消耗的资源比较大，甚至当内容比较多时，甚至会影响解析的性能。