java 解析XML文件

ゝ一纸荒年。 2022-11-17 10:18 242阅读 0赞

### 介绍 ###

**XML是一种通用的数据交换格式,它的平台无关性、语言无关性、系统无关性、给数据集成与交互带来了极大的方便。XML在不同的语言环境中解析方式都是一样的,只不过实现的语法不同而已。**

**XML的解析方式分为四种：**

**`1、DOM解析`；`2、SAX解析`；`3、JDOM解析`；`4、DOM4J解析`。**

**其中前两种属于基础方法，是官方提供的平台无关的解析方式；**

**后两种属于扩展方法，它们是在基础的方法上扩展出来的，只适用于java平台**

### 四种解析方法对比 ###

*  **DOM解析，文档对象模型解析**

**优点：**

**1、形成了树结构，有助于更好的理解、掌握，且代码容易编写。**

**2、解析过程中，树结构保存在内存中，方便修改。**

**缺点：**

**1、由于文件是一次性读取，所以对内存的耗费比较大。**

**2、如果XML文件比较大，容易影响解析性能且可能会造成内存溢出。**

*  **SAX解析**，XML简单应用程序接口

**优点：**

**1、采用事件驱动模式，对内存耗费比较小。**

**2、适用于只处理XML文件中的数据时。**

**缺点：**

**1、编码比较麻烦。**

**2、很难同时访问XML文件中的多处不同数据。**

*  **JDOM解析**
    
    **特征：**

**1、仅使用具体类，而不使用接口。**

**2、API大量使用了Collections类。**

*  **DOM4J解析**

**特征：**

**1、JDOM的一种智能分支，它合并了许多超出基本XML文档表示的功能。**

**2、它使用接口和抽象基本类方法。**

**3、具有性能优异、灵活性好、功能强大和极端易用的特点。**

**4、是一个开放源码的文件**

### 实践 ###

下面，介绍java使用DOM4J解析XML文件

#### 相关函数介绍 ####

１． 读取并解析XML文档

SAXReader reader = new SAXReader();
    Document document = reader.read(new File(fileName));

reader的read方法是重载的，可以从InputStream, File, Url等多种不同的源来读取。得到的Document对象就带表了整个XML。

读取的字符编码是按照XML文件头定义的编码来转换。如果遇到乱码问题，注意要把各处的编码名称保持一致即可。

２． 取得Root节点

Element root=document.getRootElement();  
root元素是xml文档的根节点。一切XML分析都是从Root元素开始的。

３． 遍历XML树  
DOM4J提供至少3种遍历节点的方法：

// 枚举所有子节点
    for ( Iterator i = root.elementIterator(); i.hasNext(); ) { 
        Element element = (Element) i.next();
        // do something
    }
    // 枚举名称为foo的节点
    for ( Iterator i = root.elementIterator(foo); i.hasNext();) { 
        Element foo = (Element) i.next();
        // do something
    }
    // 枚举属性
    for ( Iterator i = root.attributeIterator(); i.hasNext(); ) { 
        Attribute attribute = (Attribute) i.next();
        // do something
    }

4．其他相关函数

List<Element> elementList=root.elements();   //获得根元素下的所有子节点。
    String elementName=element.getName();       //获得element节点的名字
    String elementValue=element.getText();      //获得element节点的文本节点值
    Attribute attribute=element.attribute();    //获得element节点的属性
    String attrValue=element.attributeValue("attrValue"); //获得属性值

#### 示例代码 ####

将XML文件直接转化为Bean对象

XML样例文件,解析属性到Bean对象

代码：

package com.example.demo.common;
    
    import lombok.extern.slf4j.Slf4j;
    import org.dom4j.Document;
    import org.dom4j.DocumentException;
    import org.dom4j.Element;
    import org.dom4j.io.SAXReader;
    
    import java.io.File;
    import java.lang.reflect.Field;
    import java.util.ArrayList;
    import java.util.Date;
    import java.util.Iterator;
    import java.util.List;
    
    /** * 本示例只是针对xml特定字段读取并转化为对象，其他需求可以参考具体函数作相应调整即可。 * * 使用说明 */
    
    /* 1.pom.xml 依赖 JDK >= 1.8  <dependency> <groupId>org.dom4j</groupId> <artifactId>dom4j</artifactId> <version>2.1.3</version> </dependency> 2.使用方法直接参考main方法 */
    
    
    /** * @projectName demo_cluster * @class: XmlUtil * @description: TODO * @date 2021/4/6 */
    @Slf4j
    public class XmlUtil { 
        public static void main(String[] args) { 
            String filepath = "D:\\workspace\\code\\keydata.xml";
            List<XmlObject> list =  XmlUtil.XmlToBean(filepath, XmlObject.class);
            System.out.println(list);
        }
    
        public static <T> List<T> XmlToBean(String filepath, Class<T> z){ 
            List<T> list = new ArrayList<>();
            try { 
                if (filepath == null || filepath.isEmpty() || z == null){ 
                    log.error("传入参数为空");
                    return null;
                }
                SAXReader reader = new SAXReader();
                Document document = reader.read(new File(filepath));
                //获取根节点
                Element root=document.getRootElement();
                // 枚举名称为key的节点
                for (Iterator i = root.elementIterator("key"); i.hasNext();) { 
                    Element foo = (Element) i.next();
                    //读取root，转换为bean，并添加到list
                    T object = fromXmlToBean(foo, z);
                    list.add(object);
                }
    
            }catch (DocumentException e){ 
                log.error("XML: {} Parse failed.",filepath, e);
                return null;
            }catch (Exception e){ 
                log.error("XML parse failed.",e);
                return null;
            }
            return list;
        }
    
        /** * 将Element 更具类型转化为对象 Bean * 这里是获取属性的值，你也可以获取内容 * @param rootElt * @param pojo * @return * @throws Exception */
        private static <T> T fromXmlToBean(Element rootElt, Class<T> pojo) throws Exception
        { 
            // 首先得到pojo所定义的字段
            Field[] fields = pojo.getDeclaredFields();
            // 根据传入的Class动态生成pojo对象
            T obj = pojo.newInstance();
            for (Field field : fields)
            { 
                // 设置字段可访问（必须，否则报错）
                field.setAccessible(true);
                // 得到字段的属性名
                String name = field.getName();
                // 这一段的作用是如果字段在Element中不存在会抛出异常，如果出异常，则跳过。
                try
                { 
                    rootElt.attributeValue(name).trim();
                }catch (Exception ex)
                { 
                    continue;
                }
                if (rootElt.attributeValue(name).trim() != null && !"".equals(rootElt.attributeValue(name).trim()))
                { 
                    // 根据字段的类型将值转化为相应的类型，并设置到生成的对象中。
                    if (field.getType().equals(Long.class) || field.getType().equals(long.class))
                    { 
                        field.set(obj, Long.parseLong(rootElt.attributeValue(name).trim()));
                    }
                    else if (field.getType().equals(String.class))
                    { 
                        field.set(obj, rootElt.attributeValue(name).trim());
                    }
                    else if (field.getType().equals(Double.class) || field.getType().equals(double.class))
                    { 
                        field.set(obj, Double.parseDouble(rootElt.attributeValue(name).trim()));
                    }
                    else if (field.getType().equals(Integer.class) || field.getType().equals(int.class))
                    { 
                        field.set(obj, Integer.parseInt(rootElt.attributeValue(name).trim()));
                    }
                    else if (field.getType().equals(java.util.Date.class))
                    { 
                        field.set(obj, Date.parse(rootElt.attributeValue(name).trim()));
                    }
                }
            }
            return obj;
        }
    }

上述代码仅供参考，实际使用时根据具体需求参考修改函数即可。

`XmlObject` 类就是你要的解析之后对象类。

参考文档：

https://www.jb51.net/article/44687.htm

https://www.cnblogs.com/longqingyang/p/5577937.html