Java文件操作①——XML文件的读取

一、邂逅XML

文件种类是丰富多彩的，XML作为众多文件类型的一种，经常被用于数据存储和传输。所以XML在现今应用程序中是非常流行的。本文主要讲Java解析和生成XML。用于不同平台、不同设备间的数据共享通信。

XML文件的表现：以“.xml”为文件扩展名的文件；

　　　存储结构：树形结构；

节点名称区分大小写。

1、<book id="1"></book> id为属性， <book><id>1</id></book> id为节点
2、xml文件开头要加上版本信息和编码方式<?xml version="1.0" encoding="UTF-8"?>

比如：

❤ 为什么要使用XML？

思考1：不同应用程序之间的通信？

思考2：不同平台间的通信？

思考3：不同平台间的数据共享？

答案就是我们要学习的XML文件。我们可以使用相同的xml把不同的文件联系起来

二、应用 DOM 方式解析 XML

❤ 在Java程序中如何获取XML文件的内容

解析的目的：获取节点名、节点值、属性名、属性值；

四种解析方式：DOM、SAX、DOM4J、JDOM 

DOM、SAX ：java 官方方式，不需要下载jar包
DOM4J、JDOM ：第三方，需要网上下载jar包

示例：解析XML文件，目标是解析XML文件后，Java程序能够得到xml文件的所有数据

思考：如何在Java程序中保留xml数据的结构？

如何保留节点之间的层级关系？

注意常用的节点类型：

下面介绍DOM方式解析XML：

功能说明：

代码示例：

 package com.study.domtest;

 import java.io.IOException;

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

 import org.w3c.dom.Document;
 import org.w3c.dom.NamedNodeMap;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 import org.xml.sax.SAXException;

 /**
  * DOM方式解析xml
  */
 public class DOMTest {

     public static void main(String[] args) {
         //1、创建一个DocumentBuilderFactory的对象
         DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
         //2、创建一个DocumentBuilder的对象
         try {
             //创建DocumentBuilder对象
             DocumentBuilder db = dbf.newDocumentBuilder();
             //3、通过DocumentBuilder对象的parser方法加载books.xml文件到当前项目下
             /*注意导入Document对象时，要导入org.w3c.dom.Document包下的*/
             Document document = db.parse("books.xml");//传入文件名可以是相对路径也可以是绝对路径
             //获取所有book节点的集合
             NodeList bookList = document.getElementsByTagName("book");
             //通过nodelist的getLength()方法可以获取bookList的长度
             System.out.println("一共有" + bookList.getLength() + "本书");
             //遍历每一个book节点
             for (int i = 0; i < bookList.getLength(); i++) {
                 System.out.println("=================下面开始遍历第" + (i + 1) + "本书的内容=================");
         //❤未知节点属性的个数和属性名时:
                 //通过 item(i)方法 获取一个book节点，nodelist的索引值从0开始
                 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(index)方法获取book节点的某一个属性
                     Node attr = attrs.item(j);
                     //获取属性名
                     System.out.print("属性名：" + attr.getNodeName());
                     //获取属性值
                     System.out.println("--属性值" + attr.getNodeValue());
                 }
           //❤已知book节点有且只有1个id属性:
              /*
               //前提：已经知道book节点有且只能有1个id属性
               //将book节点进行强制类型转换，转换成Element类型
               Element book1 = (Element) bookList.item(i);
               //通过getAttribute("id")方法获取属性值
               String attrValue = book1.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("第" + (k + 1) + "个节点的节点名：" + childNodes.item(k).getNodeName());
                       //获取了element类型节点的节点值
                         System.out.println("--节点值是：" + childNodes.item(k).getFirstChild().getNodeValue());
 //                        System.out.println("--节点值是：" + childNodes.item(k).getTextContent());
                     }
                 }
                 System.out.println("======================结束遍历第" + (i + 1) + "本书的内容=================");
             }

         } catch (ParserConfigurationException e) {
             e.printStackTrace();
         } catch (SAXException e) {
             e.printStackTrace();
         } catch (IOException e) {
             e.printStackTrace();
         }
     }

 }

三、应用 SAX 方式解析 XML

SAX是SIMPLE API FOR XML的缩写，与DOM比较而言，SAX是一种轻量型的方法。

Dom解析会将整个xml文件加载到内存中，然后再逐个解析
Sax解析是通过Handler处理类逐个依次解析每个节点

在处理DOM的时候，我们需要读入整个的XML文档，然后在内存中创建DOM树，生成DOM树上的每个NODE对象。当文档比较小的时候，这不会造成什么问题，但是一旦文档大起来，处理DOM就会变得相当费时费力。特别是其对于内存的需求，也将是成倍的增长，以至于在某些应用中使用DOM是一件很不划算的事。这时候，一个较好的替代解决方法就是SAX。
SAX在概念上与DOM完全不同。首先，不同于DOM的文档驱动，它是事件驱动的，也就是说，它并不需要读入整个文档，而文档的读入过程也就是SAX的解析过程。所谓事件驱动，是指一种基于回调（callback）机制的程序运行方法。在XMLReader接受XML文档，在读入XML文档的过程中就进行解析，也就是说读入文档的过程和解析的过程是同时进行的，这和DOM区别很大。

❤

代码示例：Book实体类

 package com.study.saxtest.entity;

 /**
  * 用Book实体类代表XML文件中的"<book>...</book>"中整个元素
  * 在遇到<book>标签，证明我们要存储新的book时需要创建Book对象
  */
 public class Book {
     private String id;
     private String name;
     private String author;
     private String year;
     private String price;
     private String language;
     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;
     }
     public String getLanguage() {
      return language;
     }
     public void setLanguage(String language) {
      this.language = language;
     }
 }

SAXParserHandler类：

 package com.study.saxtest.handler;

 import java.util.ArrayList;

 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
 import org.xml.sax.helpers.DefaultHandler;

 import com.study.saxtest.entity.Book;

 public class SAXParserHandler extends DefaultHandler{
     /*注意DefaultHandler是org.xml.sax.helpers包下的*/

     int bookIndex = 0;//设置全局变量，用来记录是第几本书

     String value = null;
     Book book = null;
     private ArrayList<Book> bookList = new ArrayList<Book>();//保存book对象

     public ArrayList<Book> getBookList() {
         return bookList;
     }

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

     }

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

     /**
      * 用来遍历xml文件的开始标签
      * 解析xml元素
      */
     @Override
     public void startElement(String uri, String localName, String qName,Attributes attributes) throws SAXException {
         //调用DefaultHandler类的startElement方法
         super.startElement(uri, localName, qName, attributes);
         if (qName.equals("book")) {
             bookIndex++;
             //创建一个book对象
             /*Book*/ book = new Book();
             //开始解析book元素的属性
             System.out.println("======================开始遍历第"+bookIndex+"本书的内容=================");
            /* //❤已知节点的属性名时：比如已知id属性，根据属性名称获取属性值
             String value = attributes.getValue("id");
             System.out.print("book的属性值是："+value);*/
           //❤未知节点的属性名时，获取属性名和属性值
             int num=attributes.getLength();
             for(int i=0;i<num;i++){
                 System.out.print("book元素的第"+(i+1)+"个属性名是："+attributes.getQName(i));
                 System.out.println("---属性值是："+attributes.getValue(i));
                 if (attributes.getQName(i).equals("id")) {//往book对象中塞值
                     book.setId(attributes.getValue(i));
                 }
             }
         }else if (!qName.equals("book") && !qName.equals("bookstore")) {
             System.out.print("节点名是：" + qName + "---");//此时qName获取的是节点名（标签）
         }
     }

     /**
      * 用来遍历xml文件的结束标签
      */
     @Override
     public void endElement(String uri, String localName, String qName) throws SAXException {
         //调用DefaultHandler类的endElement方法
         super.endElement(uri, localName, qName);
         //判断是否针对一本书已经遍历结束
         if (qName.equals("book")) {
             bookList.add(book);//在清空book对象之前先保存
             book = null;//把book清空，方便解析下一个book节点
             System.out.println("======================结束遍历第"+bookIndex+"本书的内容=================");
         }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);
         }
         else if (qName.equals("language")) {
          book.setLanguage(value);
         }
     }

     /**
      * 获取文本
      * 重写charaters()方法时，
      * String(byte[] bytes,int offset,int length)的构造方法进行数组的传递
      * 去除解析时多余空格
      */
     @Override
     public void characters(char[] ch, int start, int length)throws SAXException {
         /**
          * ch 代表节点中的所有内容，即每次遇到一个标签调用characters方法时，数组ch实际都是整个XML文档的内容
          * 如何每次去调用characters方法时我们都可以获取不同的节点属性？这时就必须结合start（开始节点）和length（长度）
          */
         super.characters(ch, start, length);
         /*String */value = new String(ch, start, length);//value获取的是文本（开始和结束标签之间的文本）
 //        System.out.println(value);//输出时会多出两个空格，是因为xml文件中空格与换行字符被看成为一个文本节点
         if(!value.trim().equals("")){//如果value去掉空格后不是空字符串
             System.out.println("节点值是：" + value);
         }
     }

     /**
      * qName获取的是节点名（标签）
      * value获取的是文本（开始和结束标签之间的文本）
      * 思考：qName和value分别在两个方法中，如何将这两个方法中的参数整合到一起？
      * 分析：要在两个方法中用同一个变量，就设置成全局变量，可以赋初值为null。
      *     可以把characters()方法中的value作成一个全局变量
      *
      * 然后在endElement()方法中对book对象进行塞值。记得要把Book对象设置为全局变量，变量共享
      */
 }

测试类：SAXTest

 package com.study.saxtest.test;

 import java.io.IOException;

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

 import org.xml.sax.SAXException;

 import com.study.saxtest.entity.Book;
 import com.study.saxtest.handler.SAXParserHandler;

 /**
  * sax方式解析XML
  */
 public class SAXTest {

     public static void main(String[] args) {
         //1.获取一个SAXParserFactory的实例对象
         SAXParserFactory factory = SAXParserFactory.newInstance();
         //2.通过factory的newSAXParser()方法获取一个SAXParser类的对象。
         try {
             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(book.getLanguage());
                 System.out.println("----finish----");
             }
         } catch (ParserConfigurationException e) {
             e.printStackTrace();
         } catch (SAXException e) {
             e.printStackTrace();
         } catch (IOException e) {
             e.printStackTrace();
         }
     }

 }

运行结果：

SAX解析开始
======================开始遍历第1本书的内容=================
book元素的第1个属性名是：id---属性值是：1
节点名是：name---节点值是：冰与火之歌
节点名是：author---节点值是：乔治马丁
节点名是：year---节点值是：2014
节点名是：price---节点值是：89
======================结束遍历第1本书的内容=================
======================开始遍历第2本书的内容=================
book元素的第1个属性名是：id---属性值是：2
节点名是：name---节点值是：安徒生童话
节点名是：year---节点值是：2004
节点名是：price---节点值是：77
节点名是：language---节点值是：English
======================结束遍历第2本书的内容=================
SAX解析结束
~~~~~共有2本书
1
冰与火之歌
乔治马丁
2014
89
null
----finish----
2
安徒生童话
null
2004
77
English
----finish----

四、应用 DOM4J 及 JDOM 方式解析 XML

# JDOM 方式解析 XML

　　JDOM 开始解析前的准备工作：

　　JDOM是第三方提供的解析XML方法，需要jdom-2.0.5.jar包

示例代码：

 package com.study.jdomtest1.test;

 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 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.JDOMException;
 import org.jdom2.input.SAXBuilder;

 import com.study.jdomtest1.entity.Book;

 /**
  *  JDOM 解析XML
  */
 public class JDOMTest {
     private static ArrayList<Book> booksList = new ArrayList<Book>();

     public static void main(String[] args) {
         // 进行对books.xml文件的JDOM解析
         //❤准备工作
         // 1.创建一个SAXBuilder的对象
         SAXBuilder saxBuilder = new SAXBuilder();//注意SAXBuilder是org.jdom2.input包下的
         InputStream in;
         try {
             // 2.创建一个输入流，将xml文件加载到输入流中
             in=new FileInputStream("books.xml");//如果将xml文件放在src/res包下，此时应该输入“src/res/books.xml”
             InputStreamReader isr = new InputStreamReader(in, "UTF-8");//使用包装流InputStreamReader进行读取编码的指定，防止乱码
             // 3.通过saxBuilder的build方法，将输入流加载到saxBuilder中
             Document document = saxBuilder.build(isr);
             // 4.通过document对象获取xml文件的根节点
             Element rootElement = document.getRootElement();
             // 5.获取根节点下的子节点的List集合
             List<Element> bookList = rootElement.getChildren();
             //❤ 继续解析，采用for循环对bookList进行遍历
             for (Element book : bookList) {
                 Book bookEntity = new Book();
                 System.out.println("======开始解析第" + (bookList.indexOf(book) + 1) + "书======");//indexOf()返回的是index的位置，是从0开始
                 // 解析book的属性集合
                 List<Attribute> attrList = book.getAttributes();//适用于未知属性情况下
                 /*//知道节点下属性名称时，获取节点值
                 book.getAttributeValue("id");*/
                 // 遍历attrList(针对不清楚book节点下属性的名字及数量)
                 for (Attribute attr : attrList) {
                     /**注：JDom中，Attribute的getName和getValue方法获取到的都是实际的名称和值，
                      * 不会出现SAX和DOM中的空格和换行的情况*/
                     // 获取属性名
                     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) {
                     System.out.println("节点名：" + child.getName() + "----节点值：" + child.getValue());
                     if (child.getName().equals("name")) {
                         bookEntity.setName(child.getValue());
                        }
                        else if (child.getName().equals("author")) {
                         bookEntity.setAuthor(child.getValue());
                        }
                        else if (child.getName().equals("year")) {
                         bookEntity.setYear(child.getValue());
                        }
                        else if (child.getName().equals("price")) {
                         bookEntity.setPrice(child.getValue());
                        }
                        else if (child.getName().equals("language")) {
                         bookEntity.setLanguage(child.getValue());
                        }

                 }
                 System.out.println("======结束解析第" + (bookList.indexOf(book) + 1) + "书======");
                 booksList.add(bookEntity);
                 bookEntity = null;
                 //测试数据
                 System.out.println(booksList.size());
                 System.out.println(booksList.get(0).getId());
                 System.out.println(booksList.get(0).getName());

             }
         } catch (FileNotFoundException e) {
             e.printStackTrace();
         } catch (JDOMException e) {
             e.printStackTrace();
         } catch (IOException e) {
             e.printStackTrace();
         }
     }

 }

注意：

❤关于 JDOM 使用过程中 JAR 包的引用 ：

方式1：通过右击项目-->build path-->add external archives...-->然后选择本地文件的jar包
这种方式并不能将jar包真正导入到项目源码中，当把项目导出放在另外的机器上，这个jar包并不会随着project一同被导出。

如图：

方式2：项目根目录下新建lib文件夹——复制、粘帖jar包——右击jar包选择“build path构建路径”——“add to build path添加至构建路径”即可

如图：

 # DOM4J 方式解析 XML 

　　DOM4J 是第三方提供的解析XML方法，需要dom4j-1.6.1.jar包

示例：

 package com.study.dom4jtest;

 import java.io.File;
 import java.util.Iterator;
 import java.util.List;

 import org.dom4j.Attribute;
 import org.dom4j.Document;
 import org.dom4j.DocumentException;
 import org.dom4j.Element;
 import org.dom4j.io.SAXReader;

 /**
  * DOM4J 方式解析XML
  */
 public class DOM4JTest {

     public static void main(String[] args) {
         // 解析books.xml文件
         // 创建SAXReader的对象reader
         SAXReader reader = new SAXReader();
         try {
             // 通过reader对象的read方法加载books.xml文件,获取docuemnt对象。
             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) {
               System.out.println("属性名：" + attr.getName() + "--属性值：" + attr.getValue());
              }
              //解析子节点的信息
              Iterator itt = book.elementIterator();
              while (itt.hasNext()) {
               Element bookChild = (Element) itt.next();
               System.out.println("节点名：" + bookChild.getName() + "--节点值：" + bookChild.getStringValue());
              }
              System.out.println("=====结束遍历某一本书=====");
             }

         } catch (DocumentException e) {
             e.printStackTrace();
         }
     }

 }

五、四种解析方式比较分析

基础方法：DOM（平台无关的官方解析方式）、SAX（基于事件驱动的解析方式）
扩展方法：JDOM、DOM4J（在基础的方法上扩展出的，只有在java中能够使用的解析方法）

##解析速度的分析 

XML四种解析方式性能测试：
SAX>DOM>DOM4J>JDOM

JUnit是Java提供的一种进行单元测试的自动化工具。测试方法可以写在任意类中的任意位置。使用JUnit可以没有main()入口进行测试。
DOM4J在灵活性和对复杂xml的支持上都要强于DOM
DOM4J的应用范围非常的广，例如在三大框架的Hibernate中是使用DOM4J的方式解析文件的。
DOM是w3c组织提供的一个官方解析方式，在一定程度上是有所应用的。
当XML文件比较大的时候，会发现DOM4J比较好用
1.JUnit：Java提供的单元测试；@Test注解；采用JUnit不需要程序入口main方法
2.性能测试结果：几kB的xml文件；建议使用DOM4J解析
　　DOM-33ms
　　SAX-6ms
　　JDOM-69ms
　　DOM4J-45ms
工程右键build path --Add library--JUnit单元测试 --version:JUnit4
　　DOM:33,SAX:6
　　JDOM:69;DOM4J:45
　　DOM 有可能溢出
多使用DOM4J