Java 操作 XML(1)--DOM 方式处理 XML

XML DOM 定义了访问和处理 XML 文档的标准方法，DOM 是 W3C（万维网联盟）的推荐标准。本文主要介绍 Java DOM 方式处理 XML，文中所使用到的软件版本：Java 1.8.0_191、jaxen 1.2.0。

1、DOM简介

       DOM 的全称是 Document Object Model，也即文档对象模型。在应用程序中，基于 DOM 的 XML 分析器将一个 XML 文档转换成一个对象模型的集合（通常称 DOM 树），应用程序正是通过对这个对象模型的操作，来实现对XML文档数据的操作。通过 DOM 接口，应用程序可以在任何时候访问 XML 文档中的任何一部分数据，因此，这种利用DOM接口的机制也被称作随机访问机制。
　　DOM 接口提供了一种通过分层对象模型来访问 XML 文档信息的方式，这些分层对象模型依据 XML 的文档结构形成了一棵节点树。无论 XML 文档中所描述的是什么类型的信息，即便是制表数据、项目列表或一个文档，利用DOM所生成的模型都是节点树的形式。也就是说，DOM 强制使用树模型来访问XML文档中的信息。由于 XML 本质上就是一种分层结构，所以这种描述方法是相当有效的。
　　DOM 树所提供的随机访问方式给应用程序的开发带来了很大的灵活性，它可以任意地控制整个XML文档中的内容。然而，由于 DOM 分析器把整个XML文档转化成DOM树放在了内存中，因此，当文档比较大或者结构比较复杂时，对内存的需求就比较高。而且，对于结构复杂的树的遍历也是一项耗时的操作。所以，DOM 分析器对机器性能的要求比较高，实现效率不十分理想。不过，由于 DOM 分析器所采用的树结构的思想与XML文档的结构相吻合，同时鉴于随机访问所带来的方便，因此，DOM 分析器还是有很广泛的使用价值的。

1.1、DOM 的优点

1、可以随意访问文档树的任何部分，没有次数限制。
2、可以随意修改文档树，从而修改XML文档。
3、易于理解，易于开发。

1.2、DOM 的缺点

1、在内存中创建文档树，不适于处理大型XML文档。

2、Java DOM方式操作XML

2.1、XML 文件

<?xml version="1.0" encoding="utf-8" ?>
<school:grade xmlns:school="http://www.w3.org/TR/html4/school/">
    <school:student rollno="1" school:age="10">
        <school:firstname>cxx1</school:firstname>
        <lastname>Bob1</lastname>
        <nickname>stars1</nickname>
        <marks>85</marks>
    </school:student>
    <student rollno="2">
        <firstname>cxx2</firstname>
        <lastname>Bob2</lastname>
        <nickname>stars2</nickname>
        <marks>85</marks>
    </student>
    <student rollno="3">
        <firstname>cxx3</firstname>
        <lastname>Bob3</lastname>
        <nickname>stars3</nickname>
        <marks>85</marks>
    </student>
</school:grade>

2.2、Java 代码例子

该例子演示了使用DOM方式解析XML、DOM方式下XPath的使用以及使用DOM方式来生成XML。

package com.abc.demo.general.xml;

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import javax.xml.namespace.NamespaceContext;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathFactory;
import java.io.ByteArrayOutputStream;
import java.util.Iterator;

/**
 * dom方式处理xml
 */
public class DomCase {
    private static Logger logger = LoggerFactory.getLogger(DomCase.class);

    /**
     * 解析xml
     * @throws Exception
     */
    @Test
    public void parse() throws Exception {
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        //支持命名空间
        factory.setNamespaceAware(true);
        DocumentBuilder builder = factory.newDocumentBuilder();
        //解析xml文件为文档
        Document document = builder.parse(DomCase.class.getResourceAsStream("student.xml"));
        Element rootElement = document.getDocumentElement();
        NodeList list = rootElement.getChildNodes();//所有学生
//        NodeList list = document.getElementsByTagName("school:student"); //第1个学生
//        NodeList list = document.getElementsByTagName("student"); //第2、3的学生
//        NodeList list = document.getElementsByTagNameNS("http://www.w3.org/TR/html4/school/", "student");//第1个学生
        for (int i = 0; i < list.getLength(); i++) {
            Node node = list.item(i);
            if (node.getNodeType() != Node.ELEMENT_NODE) {
                continue;
            }
            logger.info("学生编号" + node.getAttributes().getNamedItem("rollno").getTextContent());
            if (node.getAttributes().getNamedItem("school:age") != null) {
                logger.info("age=" + node.getAttributes().getNamedItem("school:age").getTextContent());
            }
            NodeList childNodes = node.getChildNodes();
            for (int j = 0; j < childNodes.getLength() ; j++) {
                Node childNode = childNodes.item(j);
                if (childNode.getNodeType() == Node.ELEMENT_NODE) {
                    logger.info(childNode.getNodeName() + ":" + childNode.getFirstChild().getNodeValue());
                }
            }
        }
    }

    /**
     * xpath使用
     * @throws Exception
     */
    @Test
    public void xpath() throws Exception {
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        //支持命名空间
        factory.setNamespaceAware(true);
        DocumentBuilder builder = factory.newDocumentBuilder();
        //解析xml文件为文档
        Document document = builder.parse(DomCase.class.getResourceAsStream("student.xml"));

        XPathFactory xPathFactory = XPathFactory.newInstance();
        XPath xpath = xPathFactory.newXPath();
        xpath.setNamespaceContext(new NamespaceContext() {
            @Override
            public String getNamespaceURI(String prefix) {
                if ("school".equals(prefix)) {
                    return "http://www.w3.org/TR/html4/school/";
                }
                return null;
            }

            @Override
            public String getPrefix(String namespaceURI) {
                return null;
            }

            @Override
            public Iterator getPrefixes(String namespaceURI) {
                return null;
            }
        });

        logger.info("查找所有的存在rollno属性的student节点，取出lastname的值");
        XPathExpression expr = xpath.compile("//student[@rollno]/lastname/text()");//第2、3位学生
//        XPathExpression expr = xpath.compile("//student[@rollno]/child::lastname/text()");//效果同上
//        XPathExpression expr = xpath.compile("//school:student[@rollno]/lastname/text()");//第1位学生
        Object result = expr.evaluate(document, XPathConstants.NODESET);
        NodeList nodes = (NodeList) result;
        for (int i = 0; i < nodes.getLength(); i++) {
            logger.info(nodes.item(i).getNodeValue());
        }
    }

    /**
     * 生成xml
     */
    @Test
    public void toXml() throws Exception {
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        DocumentBuilder builder = factory.newDocumentBuilder();
        //新建一个文档对象
        Document document = builder.newDocument();
        Element elementClass = document.createElementNS("http://www.w3.org/TR/html4/school/", "school:class");

        //第一个学生
        Element elementStudent1 = document.createElement("student");
        elementStudent1.setAttribute("rollno", "1");
        elementStudent1.setAttributeNS("http://www.w3.org/TR/html4/school/", "school:age", "10");

        Element elementFirstname1 = document.createElement("school:firstname");
        elementFirstname1.setTextContent("cxx1");
        Element elementLastname1 = document.createElement("lastname");
        elementLastname1.setTextContent("Bob1");
        Element elementNickname1 = document.createElement("nickname");
        elementNickname1.setTextContent("stars1");
        Element elementMarks1 = document.createElement("marks");
        elementMarks1.setTextContent("85");

        elementStudent1.appendChild(elementFirstname1);
        elementStudent1.appendChild(elementLastname1);
        elementStudent1.appendChild(elementNickname1);
        elementStudent1.appendChild(elementMarks1);
        elementClass.appendChild(elementStudent1);

        //第二个学生
        Element elementStudent2 = document.createElement("student");
        elementStudent2.setAttribute("rollno", "2");

        Element elementFirstname2 = document.createElement("firstname");
        elementFirstname2.setTextContent("cxx2");
        Element elementLastname2 = document.createElement("lastname");
        elementLastname2.setTextContent("Bob2");
        Element elementNickname2 = document.createElement("nickname");
        elementNickname2.setTextContent("stars2");
        Element elementMarks2 = document.createElement("marks");
        elementMarks2.setTextContent("85");

        elementStudent2.appendChild(elementFirstname2);
        elementStudent2.appendChild(elementLastname2);
        elementStudent2.appendChild(elementNickname2);
        elementStudent2.appendChild(elementMarks2);
        elementClass.appendChild(elementStudent2);

        //第三个学生
        Element elementStudent3 = document.createElement("student");
        elementStudent3.setAttribute("rollno", "3");

        Element elementFirstname3 = document.createElement("firstname");
        elementFirstname3.setTextContent("cxx3");
        Element elementLastname3 = document.createElement("lastname");
        elementLastname3.setTextContent("Bob3");
        Element elementNickname3 = document.createElement("nickname");
        elementNickname3.setTextContent("stars3");
        Element elementMarks3 = document.createElement("marks");
        elementMarks3.setTextContent("85");

        elementStudent3.appendChild(elementFirstname3);
        elementStudent3.appendChild(elementLastname3);
        elementStudent3.appendChild(elementNickname3);
        elementStudent3.appendChild(elementMarks3);
        elementClass.appendChild(elementStudent3);

        document.appendChild(elementClass);

        TransformerFactory transformerFactory = TransformerFactory.newInstance();
        Transformer transformer = transformerFactory.newTransformer();
        transformer.setOutputProperty(OutputKeys.ENCODING,"utf-8");
        //换行
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
        DOMSource domSource = new DOMSource(document);

        //xml输出到的地方
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        StreamResult streamResult = new StreamResult(out);
        transformer.transform(domSource, streamResult);
        logger.info(out.toString());
    }
}