Java对xml文件的读取并解析的基本认识

为什么要使用XML？
不同的平台、不同的设备、不同的系统之间需要通信，为了提高通讯效率就需要一种规范的数据格式---XML就是其中一种。

在Java程序中如何获取xml文件的内容：
在Java程序中读取xml文件的过程也称为：解析xml文件
解析的目的：获取节点名、节点值、属性名、属性值

解析的方法有四种：DOM解析、SAX解析、DOM4J解析和JDOM解析。前两种是官方提供的，直接调用API就可以使用。

1.DOM(JAXP Crimson解析器) 
DOM是用与平台和语言无关的方式表示XML文档的官方W3C标准。DOM是以层次结构组织的节点或信息片断的集合。这个层次结构允许开发人员在树中寻找特定信息。分析该结构通常需要加载整个文档和构造层次结构，然后才能做任何工作。由于它是基于信息层次的，因而DOM被认为是基于树或基于对象的。DOM以及广义的基于树的处理具有几个优点。首先，由于树在内存中是持久的，因此可以修改它以便应用程序能对数据和结构作出更改。它还可以在任何时候在树中上下导航，而不是像SAX那样是一次性的处理。DOM使用起来也要简单得多。

2.SAX解析
SAX处理的优点非常类似于流媒体的优点。分析能够立即开始，而不是等待所有的数据被处理。而且，由于应用程序只是在读取数据时检查数据，因此不需要将数据存储在内存中。这对于大型文档来说是个巨大的优点。事实上，应用程序甚至不必解析整个文档；它可以在某个条件得到满足时停止解析。一般来说，SAX还比它的替代者DOM快许多。 
选择DOM还是选择SAX？ 

对于需要自己编写代码来处理XML文档的开发人员来说，选择DOM还是SAX解析模型是一个非常重要的设计决策。DOM采用建立树形结构的方式访问XML文档，而SAX采用的事件模型。 

DOM解析器把XML文档转化为一个包含其内容的树，并可以对树进行遍历。用DOM解析模型的优点是编程容易，开发人员只需要调用建树的指令，然后利用navigation APIs访问所需的树节点来完成任务。可以很容易的添加和修改树中的元素。然而由于使用DOM解析器的时候需要处理整个XML文档，所以对性能和内存的要求比较高，尤其是遇到很大的XML文件的时候。由于它的遍历能力，DOM解析器常用于XML文档需要频繁的改变的服务中。 

SAX解析器采用了基于事件的模型，它在解析XML文档的时候可以触发一系列的事件，当发现给定的tag的时候，它可以激活一个回调方法，告诉该方法制定的标签已经找到。SAX对内存的要求通常会比较低，因为它让开发人员自己来决定所要处理的tag。特别是当开发人员只需要处理文档中所包含的部分数据时，SAX这种扩展能力得到了更好的体现。但用SAX解析器的时候编码工作会比较困难，而且很难同时访问同一个文档中的多处不同数据。

3.JDOM（官网http://www.jdom.org/）
JDOM的目的是成为Java特定文档模型，它简化与XML的交互并且比使用DOM实现更快。由于是第一个Java特定模型，JDOM一直得到大力推广和促进。正在考虑通过“Java规范请求JSR-102”将它最终用作“Java标准扩展”。从2000年初就已经开始了JDOM开发。

JDOM与DOM主要有两方面不同。首先，JDOM仅使用具体类而不使用接口。这在某些方面简化了API，但是也限制了灵活性。第二，API大量使用了Collections类，简化了那些已经熟悉这些类的Java开发者的使用。

JDOM文档声明其目的是“使用20%(或更少)的精力解决80%(或更多)Java/XML问题”(根据学习曲线假定为20%)。JDOM对于大多数Java/XML应用程序来说当然是有用的，并且大多数开发者发现API比DOM容易理解得多。JDOM还包括对程序行为的相当广泛检查以防止用户做任何在XML中无意义的事。然而，它仍需要您充分理解XML以便做一些超出基本的工作(或者甚至理解某些情况下的错误)。这也许是比学习DOM或JDOM接口都更有意义的工作。

JDOM自身不包含解析器。它通常使用SAX2解析器来解析和验证输入XML文档(尽管它还可以将以前构造的DOM表示作为输入)。它包含一些转换器以将JDOM表示输出成SAX2事件流、DOM模型或XML文本文档。JDOM是在Apache许可证变体下发布的开放源码。

4.DOM4J（http://dom4j.sourceforge.net/）             
虽然DOM4J代表了完全独立的开发结果，但最初，它是JDOM的一种智能分支。它合并了许多超出基本XML文档表示的功能，包括集成的XPath支持、XML Schema支持以及用于大文档或流化文档的基于事件的处理。它还提供了构建文档表示的选项，它通过DOM4J API和标准DOM接口具有并行访问功能。从2000下半年开始，它就一直处于开发之中。

为支持所有这些功能，DOM4J使用接口和抽象基本类方法。DOM4J大量使用了API中的Collections类，但是在许多情况下，它还提供一些替代方法以允许更好的性能或更直接的编码方法。直接好处是，虽然DOM4J付出了更复杂的API的代价，但是它提供了比JDOM大得多的灵活性。

在添加灵活性、XPath集成和对大文档处理的目标时，DOM4J的目标与JDOM是一样的：针对Java开发者的易用性和直观操作。它还致力于成为比JDOM更完整的解决方案，实现在本质上处理所有Java/XML问题的目标。在完成该目标时，它比JDOM更少强调防止不正确的应用程序行为。

DOM4J是一个非常非常优秀的Java XML API，具有性能优异、功能强大和极端易用使用的特点，同时它也是一个开放源代码的软件。如今你可以看到越来越多的Java软件都在使用DOM4J来读写XML，特别值得一提的是连Sun的JAXM也在用DOM4J。

DOM方式解析xml步骤：
1.创建一个DocumentBuilderFactory的对象
2.创建一个DocumentBuilder对象
3.通过DocumentBuilder对象的parse()方法解析xml文件

准备一个xml文件：books.xml

DOM解析代码：

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

public class DOMTest {

	public static void main(String[] args) throws Exception {
		//创建一个DocumentBuilderFactory的对象
		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
		//创建一个DocumentBuilder的对象
		DocumentBuilder db = dbf.newDocumentBuilder();
		//通过DocumentBuilder对象的parser方法加载books.xml文件到当前项目下
		Document document= db.parse("books.xml");
		
		//获取所有book节点的集合
		NodeList bookList = document.getElementsByTagName("book");
		System.out.println(bookList.getLength()+"两本书");
		//遍历每一个book节点
		for (int i = 0; i < bookList.getLength(); i++) {
			//通过item(i)方法获取一个book节点
			Node book = bookList.item(i);
			//获取book节点的所有属性集合
			NamedNodeMap attrs = book.getAttributes();
			System.out.println((i+1)+"本书共有"+attrs.getLength()+"个属性");
			//遍历book的属性
			for (int j = 0; j < attrs.getLength(); j++) {
				//通过item(j)方法获取book节点的某一个属性
				Node attr = attrs.item(j);
				//获取属性名
				System.out.print("属性名："+attr.getNodeName());
				//获取属性值
				System.out.println("属性值："+attr.getNodeValue());
			}
//			//前提：已经执拗book及诶单有且只有一个id属性
//			//将book节点进行强制类型转换，转换成Element类型
//			Element book = (Element) bookList.item(i);
//			//通过getAttribute("id")方法获取属性值
//			String attrValue = book.getAttribute("id");
//			System.out.println("id属性值为："+attrValue);
			
			
			//解析book节点的之节点
			NodeList childNodes = book.getChildNodes();
			//遍历childNodes获取每一个及诶单的节点名和节点值
			System.out.println((i+1)+"本书有"+childNodes.getLength()+"个节点");
			for (int k = 0; k < childNodes.getLength(); k++) {
				//区分出text类型的node以及element类型的node
				if(childNodes.item(k).getNodeType() == Node.ELEMENT_NODE){
					//获取了element类型的节点名
					System.out.print(childNodes.item(k).getNodeName()+":");
//					System.out.println(childNodes.item(k).getNodeValue());//null
					//获取了element类型节点的节点值
					//getFirstChild().getNodeValue()该节点的第一个节点值
					System.out.println(childNodes.item(k).getFirstChild().getNodeValue());
//					//getTextContent()该节点下的所有节点值
//					System.out.println(childNodes.item(k).getTextContent());
				}
			}
			System.out.println("==============================");
		}
	}
}

运行结果

SAX方式解析xml步骤：
1.通过SAXParserFactory的静态newInstance()方法获取SAXParserFactory实例factory
2.通过SAXParserFactory实例的newSAXParser()方法返回SAXParser实例parser
3.创建一个类继承DefaultHandler，重写其中的一些方法进行业务处理并创建这个类的实例handler

SAX解析代码：(先准备一个book实体类)

public class Book {
	private String id;
	private String name;
	private String author;
	private String year;
	private String price;
	
	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getAuthor() {
		return author;
	}
	public void setAuthor(String author) {
		this.author = author;
	}
	public String getYear() {
		return year;
	}
	public void setYear(String year) {
		this.year = year;
	}
	public String getPrice() {
		return price;
	}
	public void setPrice(String price) {
		this.price = price;
	}
}

而后准备一个SAXParserHandler继承于DefaultHandler：

import java.util.ArrayList;
import java.util.List;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

public class SAXParserHandler extends DefaultHandler {
	private String value = null;
	private Book book = null;
	private List<Book> bookList = new ArrayList<Book>();
	
	public List<Book> getBookList() {
		return bookList;
	}

	/**
	 * 用来遍历xml文件的开始标签
	 */
	@Override
	public void startElement(String uri, String localName, String qName,
			Attributes attributes) throws SAXException {
		// TODO Auto-generated method stub
		super.startElement(uri, localName, qName, attributes);
		// 开始解析book元素的属性
		if (qName.equals("book")) {
			// 创建一个book对象
			book = new Book();
			System.out.println("=================");

			// //已知book元素下属性的名称，根据属性名称获取属性值
			// String value = attributes.getValue("id");
			// System.out.println("book的属性值："+value);

			// 不知道book元素下的属性的名称以及个数，如何获取属性名以及属性值
			int num = attributes.getLength();
			for (int i = 0; i < num; i++) {
				System.out.println((i + 1) + "个属性名是：" + attributes.getQName(i));
				System.out.println("属性值是:" + attributes.getValue(i));
				if (attributes.getQName(i).equals("id")) {
					book.setId(attributes.getValue(i));
				}
			}
		} else if (!qName.equals("book") && !qName.equals("bookstore")) {
			System.out.println("节点名是：" + qName);
		}
	}

	/**
	 * 用来遍历xml文件的结束标签
	 */
	@Override
	public void endElement(String uri, String localName, String qName)
			throws SAXException {
		// TODO Auto-generated method stub
		super.endElement(uri, localName, qName);
		// 判断是否针对一本书已经遍历结束
		if (qName.equals("book")) {
			bookList.add(book);
			book = null;
			System.out.println("=================");
		}else if(qName.equals("name")){
			book.setName(value);
		}else if(qName.equals("author")){
			book.setAuthor(value);
		}else if(qName.equals("year")){
			book.setYear(value);
		}else if(qName.equals("price")){
			book.setPrice(value);
		}
	}

	@Override
	public void characters(char[] ch, int start, int length)
			throws SAXException {
		// TODO Auto-generated method stub
		super.characters(ch, start, length);
		value = new String(ch, start, length);
		if (!value.trim().equals("")) {
			System.out.println(value);
		}

	}

	/**
	 * 用来标识解析开始
	 */
	@Override
	public void startDocument() throws SAXException {
		// TODO Auto-generated method stub
		super.startDocument();
		System.out.println("SAX解析开始");
	}

	/**
	 * 用来标识解析结束
	 */
	@Override
	public void endDocument() throws SAXException {
		// TODO Auto-generated method stub
		super.endDocument();
		System.out.println("SAX解析结束");
	}
}

最后测试类：

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

public class SAXTest {

	public static void main(String[] args) throws Exception {
		//获取一个SAXParserFactory的实例
		SAXParserFactory factory = SAXParserFactory.newInstance();
		//通过factory获取SAXParser的实例
		SAXParser parser = factory.newSAXParser();
		//创建SAXParserHandler对象
		SAXParserHandler handler = new SAXParserHandler();
		parser.parse("books.xml", handler);
		
		System.out.println("共有"+handler.getBookList().size()+"本书");
		for (Book book : handler.getBookList()) {
			System.out.println(book.getId());
			System.out.println(book.getName());
			System.out.println(book.getAuthor());
			System.out.println(book.getYear());
			System.out.println(book.getPrice());
			System.out.println("-------------------------");
		}
	}
}

运行结果：（没有截全）

接下来是DOM4J的解析代码：（项目需要先导入dom4j的jar包，这个可以从网上down下来）

import java.io.File;
import java.util.Iterator;
import java.util.List;
import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

public class DOM4JTest {
	public static void main(String[] args) throws Exception {
		//解析book.xml文件
		//创建SAXReader的对象reader
		SAXReader reader = new SAXReader();
		//通过reader对象的read方法加载book.xml文件,获取document对象
		Document document =  reader.read(new File("books.xml"));
		//通过document对象获取跟及诶点bookstore
		Element bookStore = document.getRootElement();
		//通过element对象的elementIterator方法获取迭代器
		Iterator it = bookStore.elementIterator();
		//遍历迭代器，获取节点中的信息（书籍）
		while(it.hasNext()){
			System.out.println("==================");
			Element book = (Element) it.next();
			//获取book的属性名以及属性值
			List<Attribute> bookAttrs = book.attributes();
			for (Attribute attr : bookAttrs) {
				//获取节点名
				String name = attr.getName();
				//获取节点值
				String value = attr.getValue();
				
				System.out.println("节点名："+name+";   节点值："+value);
			}
			Iterator itt = book.elementIterator();
			while(itt.hasNext()){
				Element bookChild = (Element) itt.next();
				//获取节点名
				String nameChild = bookChild.getName();
				//获取节点值
				String valueChild = bookChild.getStringValue();
				
				System.out.println("节点名："+nameChild+";   节点值："+valueChild);
			}
			System.out.println("==================");
		}
		
	}
}

运行结果：

最后是JDOM解析方式：（项目需要先导入jdom的jar包，也是可以从网上down下来）

一样的book实体类：

public class Book {
	private String id;
	private String name;
	private String author;
	private String year;
	private String price;
	
	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getAuthor() {
		return author;
	}
	public void setAuthor(String author) {
		this.author = author;
	}
	public String getYear() {
		return year;
	}
	public void setYear(String year) {
		this.year = year;
	}
	public String getPrice() {
		return price;
	}
	public void setPrice(String price) {
		this.price = price;
	}
}

JDOMTest：

import java.io.FileInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.List;
import org.jdom2.Attribute;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.input.SAXBuilder;

public class JDOMTest {
	private static List<Book> booksList = new ArrayList<Book>();

	public static void main(String[] args) throws Exception {
		// 进行对books.xml文件的JDOM解析

		// 1、创建一个SAXBuilder的对象
		SAXBuilder saxBuilder = new SAXBuilder();
		// 2、创建一个输入流，将xml文件加载到输入流中
		InputStream in = new FileInputStream("books.xml");
		// 防止乱码的出现
		InputStreamReader isr = new InputStreamReader(in, "UTF-8");
		// 3、通过saxBuilder的build方法，将输入流加载到saxBuilder中
		Document document = saxBuilder.build(isr);
		// 通过document对象获取xml文件的根节点
		Element rootElement = document.getRootElement();
		// 获取根节点下的子节点的List集合
		List<Element> bookList = rootElement.getChildren();
		// 继续进行接续
		for (Element book : bookList) {
			Book bookEntity = new Book();

			System.out.println("=========================");
			// 解析book的属性
			List<Attribute> attrList = book.getAttributes();

			// //知道节点下属性名称是，获取节点值
			// book.getAttributeValue("id");

			// 遍历attrList（针对不清楚book节点下属性的名字及数量）
			for (Attribute attr : attrList) {
				// 获取属性名
				String attrName = attr.getName();
				// 获取属性值
				String attrValue = attr.getValue();
				System.out.println("属性名：" + attrName + "属性值：" + attrValue);

				if (attrName.equals("id")) {
					bookEntity.setId(attrValue);
				}
			}
			// 对book节点的子节点的节点名以及节点值的遍历
			List<Element> bookChilds = book.getChildren();
			for (Element child : bookChilds) {
				// 获取节点名
				String name = child.getName();
				// 获取节点值
				String value = child.getValue();
				System.out.println("节点名：" + name + " ;   节点值：" + value);

				if (name.equals("name")) {
					bookEntity.setName(value);
					
				} else if (name.equals("author")) {
					bookEntity.setAuthor(value);
					
				} else if (name.equals("year")) {
					bookEntity.setYear(value);
					
				} else if (name.equals("price")) {
					bookEntity.setPrice(value);
					
				}
			}
			System.out.println("=========================");
			booksList.add(bookEntity);
			bookEntity = null;
		}
		
		//直接输出对象中的值
		for (Book book : booksList) {
			System.out.println("---------------------------------------------");
			System.out.println(book.getId());
			System.out.println(book.getName());
			System.out.println(book.getAuthor());
			System.out.println(book.getYear());
			System.out.println(book.getPrice());
			System.out.println("---------------------------------------------");
		}	
	}
}

运行结果：

4种解析方式的总结：
基础方法：DOM、SAX（无需导入jar包）
DOM：与平台无关的官方解析方式
SAX：基于事件驱动的解析方式
扩展的JDOM和DOM4J，在基础的方法上扩展出的，只有Java中能够使用的解析方法

DOM的优点：
1.形成了树的结构，直观好理解，代码更易编写；
2.解析过程中树结构保留在内存中，方便修改。
缺点：
1.当 xml 文件较大时，对内存耗费比较大，容易影响解析性能并造成内存溢出

SAX的优点：
1.采用事件驱动，对内存耗费比较小
2.适用于只需要处理 xml 中数据时
缺点：
1.不易编码，编码太繁琐了
2.很难同时访问同一个 xml 中的多处不同数据

JDOM、DOM 和 DOM4J：
JDOM：
1.仅使用具体类而不使用接口
2.API 大量使用了 Collections 类

DOM4J：
1.JDOM的一种智能分支，它合并了许多超出基本XML文档表示的功能
2.DOM4J使用接口和抽象基本类方法，是一个优秀的Java XMl API
3.具有性能优异、灵活性好，功能强大和极端易用使用的特点
4.是一个开放源代码的软件

需要使用哪个，就得根据具体需求来决定了：

1.DOM4J 性能最好，连 Sun 的 JAXM 也在用 DOM4J 。目前许多开源项目中大量采用 DOM4J，例如 Hibernate 大型框架也用 DOM4J 来读取 XML 配置文件。如果不考虑可移植性，那就采用 DOM4J.

2. JDOM 和DOM 在性能测试时表现不佳，在测试 10M 文档时内存溢出。在小文档情况下还值得考虑使用 DOM 和JDOM 。虽然 JDOM 的开发者已经说明他们期望在正式发行版前专注性能问题，但是从性能观点来看，它确实没有值得推荐之处。另外， DOM 仍是一个非常好的选择。DOM 实现广泛应用于多种编程语言。它还是许多其它与 XML相关的标准的基础，因为它正式获得 W3C 推荐(与基于非标准的 Java 模型相对)，所以在某些类型的项目中可能也需要它(如在 JavaScript 中使用 DOM )。

3. SAX 表现较好，这要依赖于它特定的解析方式－事件驱动。一个 SAX 检测即将到来的 XML 流，但并没有载入到内存(当然当 XML 流被读入时，会有部分文档暂时隐藏在内存中)。