xml解析

原创
2016/12/13 09:56
阅读数 16

    XML在不同的语言里解析方式都是一样的,只不过实现的语法不同而已。基本的解析方式有两种,一种叫SAX,另一种叫DOM。SAX是基于事件流的解析,DOM是基于XML文档树结构的解析。
现在解析XML的方法越来越多,但主流的方法也就四种,即:DOM、SAX、JDOM和DOM4J。

一、介绍及优缺点分析

1. DOM(Document Object Model)

      DOM是用与平台和语言无关的方式表示XML文档的官方W3C标准。DOM是以层次结构组织的节点或信息片断的集合。这个层次结构允许开发人员在树中寻找特定信息。分析该结构通常需要加载整个文档和构造层次结构,然后才能做任何工作。由于它是基于信息层次的,因而DOM被认为是基于树或基于对象的。

【优点】
      ①允许应用程序对数据和结构做出更改。
      ②访问是双向的,可以在任何时候在树中上下导航,获取和操作任意部分的数据。
【缺点】
      ①通常需要加载整个XML文档来构造层次结构,消耗资源大。

2. SAX(Simple API for XML)

     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解析器的时候编码工作会比较困难,而且很难同时访问同一个文档中的多处不同数据。

【优势】
     ①不需要等待所有数据都被处理,分析就能立即开始。
     ②只在读取数据时检查数据,不需要保存在内存中。
     ③可以在某个条件得到满足时停止解析,不必解析整个文档。
     ④效率和性能较高,能解析大于系统内存的文档。

【缺点】
     ①需要应用程序自己负责TAG的处理逻辑(例如维护父/子关系等),文档越复杂程序就越复杂。
     ②单向导航,无法定位文档层次,很难同时访问同一文档的不同部分数据,不支持XPath。
  

 3. JDOM(Java-based Document Object Model)

     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许可证变体下发布的开放源码。

【优点】
     ①使用具体类而不是接口,简化了DOM的API。
     ②大量使用了Java集合类,方便了Java开发人员。

【缺点】
     ①没有较好的灵活性。
     ②性能较差。

4. DOM4J(Document Object Model for Java)
      虽然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.

【优点】
     ①大量使用了Java集合类,方便Java开发人员,同时提供一些提高性能的替代方法。
     ②支持XPath。
     ③有很好的性能。

【缺点】
     ①大量使用了接口,API较为复杂。

 

二、比较

     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流被读入时,会有部分文档暂时隐藏在内存中)。

     如果XML文档较大且不考虑移植性问题建议采用DOM4J;如果XML文档较小则建议采用JDOM;如果需要及时处理而不需要保存数据则考虑SAX。但无论如何,还是那句话:适合自己的才是最好的,如果时间允许,建议大家讲这四种方法都尝试一遍然后选择一种适合自己的即可。

DOM示例:

/**
 *  定义XML文档建立与解析的接口
 * Created by zhangchi9 on 2016/12/12.
 */
public interface XmlDocument {
    void parseXml(String xml);
    String assembleXml();
}
package com.zc.demo.xmlparser;

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

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.*;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * Created by zhangchi9 on 2016/12/12.
 */
public class DomParser implements XmlDocument {
    private Document document;//org.w3c.dom.Document  已被JDK内置
    private String fileName;
    private DocumentBuilder documentBuilder;

    public DomParser() {
        try {
            //创建document生成器工厂
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            //创建document生成器
            DocumentBuilder builder = factory.newDocumentBuilder();
            this.documentBuilder = builder;
            //创建document对象不赋值
            this.document = builder.newDocument();
            fileName = "D:\\dom.xml";
        } catch (ParserConfigurationException e) {
            e.printStackTrace();
        }
    }

    @Override
    public String assembleXml() {
        String xml = null;

        //创建一个xml文件根节点
        Element root = document.createElement("employees");
        //把根节点加到xml文档结构下面
        document.appendChild(root);
        //创建employee节点
        Element employee = document.createElement("employee");

        //创建name节点
        Element name = document.createElement("name");
        //创建一个内容,并把内容加到name节点下面
        name.appendChild(document.createTextNode("张驰"));
        //把name加到employee下面
        employee.appendChild(name);

        //同理 创建一个sex和age节点 放到employee
        Element sex = this.document.createElement("sex");
        sex.appendChild(this.document.createTextNode("m"));
        employee.appendChild(sex);

        Element age = this.document.createElement("age");
        age.appendChild(this.document.createTextNode("30"));
        employee.appendChild(age);

        //把employee放到跟节点下
        root.appendChild(employee);

        TransformerFactory tf = TransformerFactory.newInstance();
        try {
            //把DOM写回XML文件
            Transformer transformer = tf.newTransformer();
            transformer.setOutputProperty(OutputKeys.ENCODING, "utf-8");
            transformer.setOutputProperty(OutputKeys.INDENT, "yes");
            DOMSource source = new DOMSource(document);

            PrintWriter pw = new PrintWriter(new FileOutputStream(fileName));
            StreamResult result = new StreamResult(pw);
            transformer.transform(source, result);

            System.out.println("生成XML文件成功!");
        } catch (TransformerConfigurationException e) {
            e.printStackTrace();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (TransformerException e) {
            e.printStackTrace();
        }
        return xml;
    }

    @Override
    public void parseXml(String xml) {
        try {
            // 读取xml文件
            Document document = documentBuilder.parse(fileName);
            //获取节点集合
            NodeList employees = document.getChildNodes();

            for (int i = 0; i < employees.getLength(); i++) {
                Node node = employees.item(i);
                NodeList employeeMeta = node.getChildNodes();
                for (int j = 0; j < employeeMeta.getLength(); j++) {
                    System.out.println(employeeMeta.item(j).getNodeName()
                            + ":" + employeeMeta.item(j).getTextContent());
                }
            }
            System.out.println("Xml:解析完毕!");
        } catch (SAXException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

最终xml

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<employees>
<employee>
<name>张驰</name>
<sex>m</sex>
<age>30</age>
</employee>
</employees>

SAX示例:

package com.zc.demo.xmlparser;

import org.aspectj.lang.annotation.AdviceName;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
import org.xml.sax.helpers.DefaultHandler;

import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Result;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stream.StreamResult;
import java.io.*;

/**
 * sax解析xml
 * Created by zhangchi9 on 2016/12/12.
 */
public class SaxParser implements XmlDocument {
    private String fileName;
    private StringBuffer buffer = new StringBuffer();
    private String key;

    public SaxParser() {
        this.fileName = "D:\\sax.xml";
    }

    @Override
    public void parseXml(String xml) {
        SAXParserFactory saxfac = SAXParserFactory.newInstance();
        try {
            SAXParser saxparser = saxfac.newSAXParser();
            InputStream is = new FileInputStream(fileName);
            saxparser.parse(is, new MySAXHandler());
        } catch (ParserConfigurationException e) {
            e.printStackTrace();
        } catch (SAXException e) {
            e.printStackTrace();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    class MySAXHandler extends DefaultHandler {
        boolean hasAttribute = false;
        Attributes attributes = null;

        public void startDocument() throws SAXException {
            System.out.println("文档开始打印了");
            System.out.println("<xml version=\"1.0\" encoding=\"utf-8\"?>");
        }

        public void endDocument() throws SAXException {
            System.out.println("文档打印结束了");
        }

        public void startElement(String uri, String localName, String qName,
                                 Attributes attributes) throws SAXException {
            buffer.delete(0, buffer.length());
            //key = localName;
            key = qName;

            System.out.print("<" + key);
            for (int i = 0; i < attributes.getLength(); i++) {
                String attrName = attributes.getLocalName(i);
                String attrValue = attributes.getValue(i);
                System.out.println(" " + attrName + "=" + attrValue);
            }
            System.out.println(">");
        }

        public void endElement(String uri, String localName, String qName)
                throws SAXException {
            if (key.equals(qName)) {
                System.out.println(buffer); // 输出标记中间的内容
            }
            System.out.println("</" + qName + ">");
        }

        public void characters(char[] ch, int start, int length)
                throws SAXException {
            buffer.append(ch, start, length); // 添加标记中间的内容
        }
    }


    @Override
    public String assembleXml() {
        String xmlStr = null;
        try {
            Result resultXml = new StreamResult(new FileOutputStream(fileName));
            StringWriter writerStr = new StringWriter();
            //SAXTransformerFactory类扩展了 TransformerFactory 以提供特定于 SAX 的工厂方法
            SAXTransformerFactory sff = (SAXTransformerFactory) SAXTransformerFactory.newInstance();
            TransformerHandler th = sff.newTransformerHandler();
            Transformer transformer = th.getTransformer();
            transformer.setOutputProperty(OutputKeys.INDENT, "yes");
            transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
            //设置与用于转换的此 TransformerHandler 关联的 Result。
            th.setResult(resultXml);
            //接收文档的开始的通知。在其他任何事件回调(不包括 setDocumentLocator)之前,SAX 解析器仅调用此方法一次。
            th.startDocument();
            String four = "\n    ";
            String eight = "\n        ";

            AttributesImpl attr = new AttributesImpl();
            //接收元素开始的通知。
            th.startElement("", "country", "country", attr);
            /**
             * 接收字符数据的通知。析器将调用此方法来报告字符数据的每个存储块。SAX 解析器能够用单个存储块返回所有的连续字符数据,
             * 或者可以将该数据拆分成几个存储块;但是,任何单个事件中的全部字符都必须来自同一个外部实体,以便定位器能够提供有用的信息。
             */
            th.characters(four.toCharArray(), 0, four.length());
            th.startElement("", "china", "china", attr);

            th.characters(eight.toCharArray(), 0, eight.length());
            th.startElement("", "city", "city", attr);

            String bj = "Beijing";
            th.characters(bj.toCharArray(), 0, bj.length());
            //接收元素结束的通知。
            th.endElement("", "city", "city");

            th.characters(eight.toCharArray(), 0, eight.length());

            th.startElement("", "city", "city", attr);
            String sh = "Shanghai";
            th.characters(sh.toCharArray(), 0, sh.length());
            th.endElement("", "city", "city");

            th.characters(four.toCharArray(), 0, four.length());

            th.endElement("", "china", "china");
            th.endElement("", "country", "country");
            th.endDocument();
            xmlStr = writerStr.getBuffer().toString();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (TransformerConfigurationException e) {
            e.printStackTrace();
        } catch (SAXException e) {
            e.printStackTrace();
        }
        return xmlStr;
    }

}

xml:

<?xml version="1.0" encoding="UTF-8"?><country>
    <china>
        <city>Beijing</city>
        <city>Shanghai</city>
    </china>
</country>

DOM4J示例:

依赖dom4j的jar

<dependency>
  <groupId>dom4j</groupId>
  <artifactId>dom4j</artifactId>
  <version>1.6</version>
</dependency>
package com.zc.demo.xmlparser;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.Iterator;

/**
 * dom4j组装与解析xml示例
 * Created by zhangchi9 on 2016/12/13.
 */
public class Dom4jParser implements XmlDocument{
    private String fileName;
    public Dom4jParser(){
        this.fileName = "D:\\dom4j.xml";
    }
    @Override
    public void parseXml(String xml) {
        File inputXml = new File(fileName);
        SAXReader saxReader = new SAXReader();
        try {
            Document document = saxReader.read(inputXml);
            Element employees = document.getRootElement();
            for (Iterator i = employees.elementIterator(); i.hasNext();) {
                Element employee = (Element) i.next();
                for (Iterator j = employee.elementIterator(); j.hasNext();) {
                    Element node = (Element) j.next();
                    System.out.println(node.getName() + ":" + node.getText());
                }
            }
        } catch (DocumentException e) {
            System.out.println(e.getMessage());
        }
        System.out.println("dom4j parserXml");
    }

    @Override
    public String assembleXml() {
        // 创建一个文档对象
        Document document = DocumentHelper.createDocument();
        // 在根节点添加元素
        Element employees = document.addElement("employees");
        // 在employees下添加子节点
        Element employee = employees.addElement("employee");
        // 在employee下添加子节点
        Element name = employee.addElement("name");
        // 给name节点添加内容
        name.setText("ddvip");
        Element sex = employee.addElement("sex");
        sex.setText("m");
        Element age = employee.addElement("age");
        age.setText("29");
        try {
            Writer fileWriter = new FileWriter(fileName);
            XMLWriter xmlWriter = new XMLWriter(fileWriter);
            xmlWriter.write(document);
            xmlWriter.close();
        } catch (IOException e) {

            System.out.println(e.getMessage());
        }
        return null;
    }
}

xml

<?xml version="1.0" encoding="UTF-8"?>
<employees><employee><name>ddvip</name><sex>m</sex><age>29</age></employee></employees>

JDOM示例:

依赖jdom2的jar

        <dependency>
            <groupId>org.jdom</groupId>
            <artifactId>jdom</artifactId>
            <version>2.0.2</version>
        </dependency>
package com.zc.demo.xmlparser;

import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMException;
import org.jdom2.input.SAXBuilder;
import org.jdom2.output.XMLOutputter;

import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;

/**
 * Created by zhangchi9 on 2016/12/13.
 */
public class JdomParser implements XmlDocument{

    private String fileName;
    public JdomParser(){
        this.fileName = "D:\\jdom.xml";
    }
    @Override
    public void parseXml(String xml) {
        SAXBuilder builder = new SAXBuilder(false);
        try {
            Document document = builder.build(fileName);
            Element employees = document.getRootElement();
            List employeeList = employees.getChildren();
            // 获取employee节点
            for (int i = 0; i < employeeList.size(); i++) {
                Element employee = (Element) employeeList.get(i);
                List employeeInfo = employee.getChildren();
                // 获取employee节点下面的所有子节点
                for(int j = 0; j < employeeInfo.size(); j++) {
                    Element info = (Element)employeeInfo.get(j);
                    System.out.println(info.getName() + ":" + info.getValue());
                }
            }
        } catch (JDOMException e) {
            System.out.println(e.getMessage());
        } catch (IOException e) {
            System.out.println(e.getMessage());
        }
    }

    @Override
    public String assembleXml() {
        Document document;
        Element root;
        root = new Element("employees");
        document = new Document(root);
        Element employee = new Element("employee");
        root.addContent(employee);
        Element name = new Element("name");
        name.setText("ddvip");
        employee.addContent(name);
        Element sex = new Element("sex");
        sex.setText("m");
        employee.addContent(sex);
        Element age = new Element("age");
        age.setText("23");
        employee.addContent(age);
        XMLOutputter XMLOut = new XMLOutputter();
        try {
            XMLOut.output(document, new FileOutputStream(fileName));
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }
}

xml:

<?xml version="1.0" encoding="UTF-8"?>
<employees><employee><name>ddvip</name><sex>m</sex><age>23</age></employee></employees>

测试类:

package com.zc.demo.xmlparser;

/**
 * Created by zhangchi9 on 2016/12/12.
 */
public class TestMain {

    public static void main(String[] args) {
        /*XmlDocument xmlDocument = new DomParser();
        xmlDocument.assembleXml();
        xmlDocument.parseXml(null);*/

        /*XmlDocument xmlDocument = new SaxParser();
        xmlDocument.assembleXml();
        xmlDocument.parseXml(null);*/

        /*XmlDocument xmlDocument = new Dom4jParser();
        xmlDocument.assembleXml();
        xmlDocument.parseXml(null);*/

        XmlDocument xmlDocument = new JdomParser();
        xmlDocument.assembleXml();
        xmlDocument.parseXml(null);
    }
}

 三、使用JAXB解析XML   

    JAXB(Java Architecture for XML Binding简称JAXB)允许Java开发人员将Java类映射为XML表示方式。JAXB提供两种主要特性:将一个Java对象序列化为XML,以及反向操作,将XML解析成Java对象。换句话说,JAXB允许以XML格式存储和读取数据,而不需要程序的类结构实现特定的读取XML和保存XML的代码!JAXB 已经是 Java SE平台的一部分,Java EE平台API之一,也是Java Web服务开发包(JWSDP)的一部分(已被JDK内置)。

    JAXB中包含“xjc”工具和一个“schemagen”工具。 “xjc”工具可以用来将XML模式或其他类型模式文件(Java 1.6试验性地支持RELAX NG,DTD以及WSDL)转换为Java类。Java类使用javax.xml.bind.annotation包下的Java 标注,例如@XmlRootElement和@XmlElement。XML列表序列表示为java.util.List类型的属性, 通过JAXBContext可以创建Marshallers(将Java对象转换成XML)和Unmarshallers(将XML解析为Java对象)。另外的“schemagen”工具,能够执行“xjc”的反向操作,通过一组标注的Java类创建一个XML模式。

    JAXB不能直接拿来和Dom/SAX/Dom4j进行比较。他们的设计理念不同。后者提供的API都是解析XML的底层API,而前者设计的目的是将XML文件中的元素及属性和JAVA对象建立绑定关系,可以自动相互转换。JAXB没有提供解析XML的新方法,它是调用后者(Dom/SAX/JDOM/Dom4J)来解析XML的。(JAXB默认是调用SAX来实现XML解析的)如果,你仅仅是想把XML的内容转换成Java对象,那么JAXB比起后者更容易实现,它可以让你少些一些代码。特别是,当XML的结构非常复杂时,他的代码量比后者要少很多。

eg:例子中分别介绍了单个实体和实体集合的编组和反编组操作,列出了一些常用的annotation。

创建person实体类

package com.zc.demo.xmlparser.jaxb;

import javax.xml.bind.annotation.*;
import java.time.LocalDate;

/**
 * 定义根节点对象,默认类名为根节点名称
 * Created by zhangchi9 on 2016/12/13.
 */
//用于类级别的注解,对应xml的跟元素
@XmlRootElement(name = "Person")
//java对象生成的xml元素进行排序。它有两个属性值:UNDEFINED:不排序 ALPHABETICAL:对生成的xml元素按字母书序排序
@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
/*
表示一个元素是否可以被序列化,即指定由java对象生成xml文件时对java对象属性的访问方式。
XmlAccessType.FIELD:java对象中的所有成员变量
XmlAccessType.PROPERTY:java对象中所有通过getter/setter方式访问的成员变量
XmlAccessType.PUBLIC_MEMBER:java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量。为缺省值。
XmlAccessType.NONE:java对象的所有属性都不映射为xml的元素
*/
@XmlAccessorType(value = XmlAccessType.FIELD)
/*
将类或枚举类型映射到XML模式类型
默认情况下,Jaxb编组出来的xml中的字段顺序是随机的,可以使用@XmlType的propOrder属性
来指定序列化的顺序。当使用propOrder时将覆盖@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
必须列出JavaBean对象中的所有属性,否则会报错。
 */
@XmlType(propOrder = {"city","postalCode","firstName","lastName","birthday","alias"})
public class Person {

    private String firstName;
    private String lastName;
    private Integer postalCode;
    //@XmlElement将java对象的属性映射为xml的节点,在使用@XmlElement时,可通过name属性改变java对象属性在xml中显示的名称。
    @XmlElement(name = "城市")
    private String city;
    private LocalDate birthday;
    //@XmlAttribute用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名
    @XmlAttribute(name = "Alias")
    private String alias;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getPostalCode() {
        return postalCode;
    }

    public void setPostalCode(Integer postalCode) {
        this.postalCode = postalCode;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public LocalDate getBirthday() {
        return birthday;
    }

    public void setBirthday(LocalDate birthday) {
        this.birthday = birthday;
    }

    public String getAlias() {
        return alias;
    }

    public void setAlias(String alias) {
        this.alias = alias;
    }
}

创建PersonChildNote对象

package com.zc.demo.xmlparser.jaxb;

import java.time.LocalDate;

/**
 * Created by zhangchi9 on 2016/12/13.
 */
public class PersonChildNote {
    private String firstName;
    private String lastName;
    private Integer postalCode;
    private String city;
    private LocalDate birthday;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getPostalCode() {
        return postalCode;
    }

    public void setPostalCode(Integer postalCode) {
        this.postalCode = postalCode;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public LocalDate getBirthday() {
        return birthday;
    }

    public void setBirthday(LocalDate birthday) {
        this.birthday = birthday;
    }
}

创建PersonChildNote集合对象persons

package com.zc.demo.xmlparser.jaxb;

import javax.xml.bind.annotation.XmlRootElement;
import java.util.List;

/**
 * Created by zhangchi9 on 2016/12/13.
 */
@XmlRootElement(name = "Persons")
public class Persons {
    private List<PersonChildNote> personChildNote;

    public List<PersonChildNote> getPersonChildNote() {
        return personChildNote;
    }

    public void setPersonChildNote(List<PersonChildNote> personChildNote) {
        this.personChildNote = personChildNote;
    }

    @Override
    public String toString() {
        StringBuffer str = new StringBuffer();
        for (PersonChildNote person : this.personChildNote) {
            str.append(person.toString());
            str.append("\n");
        }
        return str.toString();
    }
}

执行类

package com.zc.demo.xmlparser.jaxb;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import java.io.File;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;

/**
 * Created by zhangchi9 on 2016/12/13.
 */
public class PersonHandler {
    public static void main(String[] args) throws JAXBException {
        //组编单个实例
        PersonHandler ph = new PersonHandler();
        ph.marshalPerson();
        //组编集合实例
        List<PersonChildNote> list = new ArrayList<PersonChildNote>();
        PersonChildNote personChildNote = new PersonChildNote();
        personChildNote.setFirstName("Li");
        personChildNote.setLastName("si");
        personChildNote.setCity("NanJing");
        personChildNote.setPostalCode(200000);
        personChildNote.setBirthday(LocalDate.of(2016, 12, 13));
        PersonChildNote personChildNote1 = new PersonChildNote();
        personChildNote1.setFirstName("Zhang");
        personChildNote1.setLastName("San");
        personChildNote1.setCity("NanJing");
        personChildNote1.setPostalCode(200000);
        personChildNote1.setBirthday(LocalDate.of(2016, 12, 13));
        Persons persons = new Persons();
        list.add(personChildNote);
        list.add(personChildNote1);
        persons.setPersonChildNote(list);
        ph.marshalPerson(persons);
    }

    /**
     * 编组-即将java对象转换成xml
     *
     * @throws JAXBException
     */
    public void marshalPerson() throws JAXBException {
        /* 初始化java对象 */
        Person person = new Person();
        person.setFirstName("net");
        person.setLastName("blogways");
        person.setCity("NanJing");
        person.setPostalCode(210000);
        person.setBirthday(LocalDate.of(2013, 10, 11));
        person.setAlias("别名");

         /* 初始化 jaxb marshaler */
        JAXBContext jaxbContext = JAXBContext.newInstance(Person.class);
        Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
        /* 设置为格式化输出 */
        jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        /* 将java对象 编组 为xml (输出到文件或标准输出) */
        jaxbMarshaller.marshal(person, new File("D:\\person.xml"));
        jaxbMarshaller.marshal(person, System.out);
    }

    public void marshalPerson(Persons persons) throws JAXBException {

        JAXBContext jaxbContext = JAXBContext.newInstance(Persons.class);
        Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
        /* 设置为格式化输出 */
        jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        /* 将java对象 编组 为xml (输出到文件或标准输出) */
        jaxbMarshaller.marshal(persons, new File("D:\\persons.xml"));
        jaxbMarshaller.marshal(persons, System.out);

    }
}

最终控制台打印xml和xml文件

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Person Alias="别名">
    <城市>NanJing</城市>
    <postalCode>210000</postalCode>
    <firstName>net</firstName>
    <lastName>blogways</lastName>
    <birthday/>
</Person>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Persons>
    <personChildNote>
        <birthday/>
        <city>NanJing</city>
        <firstName>Li</firstName>
        <lastName>si</lastName>
        <postalCode>200000</postalCode>
    </personChildNote>
    <personChildNote>
        <birthday/>
        <city>NanJing</city>
        <firstName>Zhang</firstName>
        <lastName>San</lastName>
        <postalCode>200000</postalCode>
    </personChildNote>
</Persons>

大家可能已经发现在前面编组的例子中,birthdayLocalDate类型,作为复杂类型,不能很好地被编组和反编组。这时需要一个适配器。

适配器(Adapters)

package com.zc.demo.xmlparser.jaxb;

import javax.xml.bind.annotation.adapters.XmlAdapter;
import java.time.LocalDate;

/**
 * Created by zhangchi9 on 2016/12/14.
 */
public class DateAdapter extends XmlAdapter<String, LocalDate> {
    @Override
    public LocalDate unmarshal(String v) throws Exception {
        return LocalDate.parse(v);
    }

    @Override
    public String marshal(LocalDate v) throws Exception {
        return v.toString();
    }
}

展开阅读全文
打赏
0
1 收藏
分享
加载中
更多评论
打赏
0 评论
1 收藏
0
分享
返回顶部
顶部