Java XML解析工具 JDOM

蔚落 2022-08-19 13:29 307阅读 0赞

## JDOM介绍 ##

JDOM是一种使用XML的独特Java工具包，用于快速开发XML应用程序。

它的设计包含Java语言的语法乃至语义。

JDOM是一个开源项目，它基于树形结构，利用纯Java的技术对XML文档实现解析、生成、序列化及多种操作。

## JAXP ##

JAXP（用于XML语法分析的Java API）包含了三个包：

**org.w3c.dom**

W3C推荐的用于XML标准文档对象模型的Java工具。

**org.xml.sax**

用于对XML进行语法分析的事件驱动的简单API。

**javax.xml.parsers**

工厂化工具，允许应用程序开发人员获得并配置特殊的语法分析器工具，JDOM能够替换org.w3c.dom软件包来有计划地操作XML文档。

## **JDOM和DOM及SAX的关系** ##

JDOM主要用来弥补DOM和SAX在实际应用当中的不足。

主要是SAX没有文档修改、随机访问及输出的功能；

而DOM，Java程序员在使用时总觉得不太方便（比如DOM定义了自己的Text类而不是使用Java的String）。

**　　****DOM的局限性：**

DOM的缺点主要是由于DOM是一个接口定义语言（IDL），它的任务是在不同语言实现中的一个最低的通用标准，并不是为Java特别设计的。

DOM API沿袭了XML规范，在XML中，每件东西都是一个结点，因此在DOM中找到的几乎每件东西都基于Node接口。

就多态性来讲，它是优秀的，但鉴于如上解释，它在Java语言中的应用是困难而且不便的，其中从Node向叶类型作显式向下类型转换会导致代码的冗长和难以理解。

JDOM是作为一种轻量级的API被制定的，最主要的是**它是以Java为中心的**。它在遵循DOM主要规则的基础上除去了上述缺点。

JDOM是Java平台专用的，只要有可能，API都使用Java语言的内建String支持。

在JDOM中，XML元素就是**Element**的实例，XML属性就是**Attribute**的实例，XML文档本身就是**Document**的实例。

类驱动：因为JDOM对象就是像Document、Element和Attribute这些类的直接实例，因此创建一个新的JDOM对象就如在Java语言中使用new操作符一样容易。

它还意味着**不需要进行工厂化接口配置**——JDOM的使用是直截了当的。

## JDOM使用程序实例 ##

**实例1，使用JDOM，用Java代码构造一个XML文档：**

**注：使用前需要下载JDOM的jar包（我用的是jdom-2.0.5.jar）并且把它加载在类路径里面（Properties->Java Build Path -> Add External JARs...****）**

Java程序如下，详细说明见代码注释：

![复制代码][copycode.gif]

package com.example.xml.jdom;
    
    import java.io.FileOutputStream;
    
    import org.jdom2.Attribute;
    import org.jdom2.Comment;
    import org.jdom2.Document;
    import org.jdom2.Element;
    import org.jdom2.output.Format;
    import org.jdom2.output.XMLOutputter;
    
    /**
     * 使用JDOM构造一个XML文档，并输出
     * 
     */
    public class JDOMTest1
    {
    
        public static void main(String[] args) throws Exception
        {
            // 文档
            Document document = new Document();
    
            // 生成一个元素
            Element root = new Element("root");
    
            // 将生成的元素加入文档：根元素
            document.addContent(root);
    
            // 给结点加上注释
            Comment comment = new Comment("This is my comments");
            root.addContent(comment);
    
            // 加上子元素1
            Element e = new Element("hello");
            // 加属性
            e.setAttribute("sohu", "www.sohu.com");
            root.addContent(e);
    
            // 加子元素2
            Element e2 = new Element("world");
            Attribute attribute = new Attribute("testAttr", "attr Value");
            e2.setAttribute(attribute);// set方法会返回元素本身（方法链method chain style）
            root.addContent(e2);
    
            e2.addContent(new Element("subElement").setAttribute("a", "aValue")
                    .setAttribute("x", "xValue").setAttribute("y", "yValue")
                    .setText("textContent"));
    
            // 格式化
            Format format = Format.getPrettyFormat();
            // Format.getRawFormat()方法，通常用于XML数据的网络传输，因为这种格式会去掉所有不必要的空白，因此能够减少数据量
    
            // 可以自己设定一些format的属性
            format.setIndent("    ");// 把缩进设为四个空格（默认为两个空格）
    
            // 输出
            XMLOutputter out = new XMLOutputter(format);
            out.output(document, new FileOutputStream("jdom.xml"));// 可在当前项目路径下找到
    
        }
    }

![复制代码][copycode.gif]

刷新后可以看到项目路径下生成了文档jdom.xml：

![复制代码][copycode.gif]

<?xml version="1.0" encoding="UTF-8"?>
    <root>
      
      <hello sohu="www.sohu.com" />
      <world testAttr="attr Value">
        <subElement a="aValue" x="xValue" y="yValue">textContent</subElement>
      </world>
    </root>

![复制代码][copycode.gif]

**实例2，使用JDOM解析并操纵XML文档：**

就读入上面创建的文档，Java代码：

![复制代码][copycode.gif]

package com.example.xml.jdom;
    
    import java.io.File;
    import java.io.FileWriter;
    import java.util.List;
    
    import org.jdom2.Attribute;
    import org.jdom2.Document;
    import org.jdom2.Element;
    import org.jdom2.input.SAXBuilder;
    import org.jdom2.output.Format;
    import org.jdom2.output.XMLOutputter;
    
    /**
     * 读取一个XML文档
     * 
     */
    public class JDOMTest2
    {
        public static void main(String[] args) throws Exception
        {
            // 构造器
            SAXBuilder saxBuilder = new SAXBuilder();
    
            // 获取文档
            Document document = saxBuilder.build(new File("jdom.xml"));
    
            // 得到根元素
            Element element = document.getRootElement();
            System.out.println("Root: " + element.getName());
    
            // 获取子元素
            Element hello = element.getChild("hello");
            System.out.println("child: " + hello.getName());
    
            // 获取属性
            List<Attribute> list = hello.getAttributes();
    
            for (int i = 0; i < list.size(); ++i)
            {
                Attribute attr = (Attribute) list.get(i);
                String attrName = attr.getName();
                String attrValue = attr.getValue();
    
                System.out.println("hello的属性： " + attrName + " = " + attrValue);
            }
    
            // 移除一个元素
            element.removeChild("world");
    
            // 设定格式
            XMLOutputter out = new XMLOutputter(Format.getPrettyFormat().setIndent(
                    "    "));
    
            out.output(document, new FileWriter("jdom2.xml"));
            // FileWriter和FileOutputStream都能用
        }
    
    }

![复制代码][copycode.gif]

另存后的jdom2.xml：

<?xml version="1.0" encoding="UTF-8"?>
    <root>
        
        <hello sohu="www.sohu.com" />
    </root>

## 参考资料 ##

圣思园张龙老师XML教学视频。

JDOM官方网站：

[http://www.jdom.org/][http_www.jdom.org]

JDOM 2.0.5（目前2013.06.02最新版）文档：

[http://www.jdom.org/docs/apidocs/][http_www.jdom.org_docs_apidocs]

[copycode.gif]: /images/20220731/3aa5d4902bc84baa9cd6dc3861d5bc13.png
[http_www.jdom.org]: http://www.jdom.org/
[http_www.jdom.org_docs_apidocs]: http://www.jdom.org/docs/apidocs/