Java解析XML文件(DOM4J解析xml文件)

小灰灰 2023-10-12 17:54 117阅读 0赞

##  ##

内容重点1：DOM4J创建、解析、修改XML文件

内容重点2：DOM4J模拟解析web.xml配置文件，实现实例化servlet

## 1、什么是xml ##

Xml(Extensible Markup Language) 一种扩展性标示语言,出现的意义其实与JSON字符串的意义相似,是新一代的数据交换标准。

优势：一种结构化文档和通用且适应性强的格式，它不仅仅适用于web，而且可以被用于任何的地方。

本案例介绍DOM4J如何解析xml配置文件

## 2、常见的xml解析工具 ##

**DOM4J****：****是所有****xml****解析中综合性能最优的产品。**是一个简单、灵活的开放源代码的库，具有性能优异、功能强大和极易使用的特点。

**JDOM****和****DOM:****基于树模型，在运行的时候会将****xml****文件中的所有内容都加入到内存中，对内存的消耗大。适用于小文档。当文档超过****15M****左右的时候会出现内存溢出。**

**SAX****解析：****基于事件驱动****，表现较好，这要依赖于它特定的解析方式－事件驱动。一个****SAX****检测即将到来的****XML****流，但并没有载入到内存（当然当****XML****流被读入时，会有部分文档暂时隐藏在内存中）。**

## 3、通过DOM4J解析XML文件 ##

3.1、创建一个标准的1.xml文件

在你自己系统中的任意地方创建一个1.xml文件，配置如下内容，xml格式是自定的，我使用的xml是具有代表性的一种格式，用于学习足够使用。

<?xml version="1.0" encoding="UTF-8"?>
    <students>
      <student id="1001" name="十一郎">安徽合肥1</student>
      <student id="1002" name="十二郎">安徽合肥2</student>
      <student id="1003" name="十三郎">安徽合肥3</student>
      <student id="1004" name="十四郎">安徽合肥4</student>
    </students>

### 3.2、下载DOM4J的包 ###

下载地址：[dom4j][]

说明：此处可以根据自己的JDK版本下载对应的dom4j版本。我用的是JDK1.8所以下载

所以下载dom4j-2.1.4版本。

![81ca0a0df31845d8a28f7f38b32a4c2a.png][]

### 3.3、在工程中引入DOM4J的jar包 ###

![0b29b054ef71444b96f6c92f73fd5e09.png][]

### 3.4、读取特定的xml中的内容 ###

getName()：得到当前的元素名称

getText()：得到元素中间的内容

attributeValue("sex")：得到元素对应的属性的值

【解析代码】

package com.it.test;
    import java.io.File;
    import java.util.List;
    import org.dom4j.Document;
    import org.dom4j.DocumentException;
    import org.dom4j.Element;
    import org.dom4j.io.SAXReader;
    public class TestXMLParse {
    	public static void main(String[] args) throws DocumentException {
    		//创建核心解析器
    	   SAXReader reader=new SAXReader();
    	   File file=new File("C://aa//1.xml");
    	   Document doc=reader.read(file);
    	   //得到xml的跟节点-既students
    	   Element root= doc.getRootElement();
    	   //通过根节点得到所有子节点-既所有student
    	   List<Element> elements= root.elements();
    	   //遍历得到所有的自己点的属性和值
    	   for (Element eles:elements) {
    		   //attributeValue:得到指定属性的值
    		   System.out.print("id的值=>"+eles.attributeValue("id"));
    		   System.out.print(",name的值=>"+eles.attributeValue("name"));
    		   //得到节点中间的值
    		   System.out.println(",地址=>"+eles.getTextTrim());
    	   }
    	}
    }

【结果输出】

![597bc2c02ea6480d9e5424d64283eb9d.png][]

## 4、将结果写入XML文件中 ##

本案例中，我们创建一个集合，在集合中添加Student对象，模拟从数据库中查询数据。

### 4.1、写入后样式 ###

students:为根元素

student:为子元素

id,name,sex,age,pwd:为元素属性

![81235accaa944ace9ab59cc5c3e7cef7.png][]

### 4.2、导入lomok工具包 ###

![e832764135d64f19bdffb6045ff5d231.png][]

### 4.3、创建Student对象 ###

创建对象，并设置set和get方法及构造器，案例中采用lomok注解生成，也可以手动添加。

@Setter //生成set方法
    @Getter //生成get方法
    @AllArgsConstructor //生成有参数构造器
    @NoArgsConstructor  //生成无参数构造器
    public class Student {
    	private String stu_id;
    	private String stu_name;
    	private String stu_sex;
    	private String stu_age;
    	private String stu_addr;
    	private String stu_pwd;
    }

### 4.4、将集合写入到XML文件中 ###

package com.it.test;
    
    import java.io.File;
    import java.io.FileOutputStream;
    import java.io.IOException;
    import java.io.OutputStream;
    import java.util.ArrayList;
    import java.util.List;
    
    import org.dom4j.Document;
    import org.dom4j.DocumentHelper;
    import org.dom4j.Element;
    import org.dom4j.io.OutputFormat;
    import org.dom4j.io.XMLWriter;
    
    import com.it.bean.Student;
    public class TestWriterXML {
    	public static void main(String[] args) throws IOException {
    		//创建集合模拟数据库查询数据
    		List<Student> list=new ArrayList<>();
    		Student stu1=new Student("1001","陈平安","男","15","东宝瓶洲泥瓶巷","1001");
    		Student stu2=new Student("1002","王煊","男","25","旧星","1002");
    		Student stu3=new Student("1003","萧炎","男","35","乌坦城萧家","1003");
    		list.add(stu1);
    		list.add(stu2);
    		list.add(stu3);
    		//创建Document对象-DOM4J写入XML中需要将list转化成Document
    	    Document  doc=DocumentHelper.createDocument();
    	    //向Document对象中添加根节点-XML最外层的元素节点
    	    Element root= doc.addElement("students");
    	    //向Document对象中添加数
    	    for (int i = 0; i <list.size(); i++) {
    	    	root.addElement("student")
    	    	.addAttribute("id", list.get(i).getStu_id())
    	    	.addAttribute("name", list.get(i).getStu_name())
    	    	.addAttribute("sex", list.get(i).getStu_sex())
    	    	.addAttribute("age", list.get(i).getStu_age())
    	    	.addAttribute("pwd", list.get(i).getStu_pwd())
    	    	.addText(list.get(i).getStu_addr());
    	    }
    	    //在C盘中创建目录xmlfile-此处可以自定义地址
    	    File file=new File("C://xmlfile");
    	    if(!file.exists()){//如果目录不存在，就创建目录
    		   file.mkdir();
    	    }
    	    //将内容写入到C://xmlfile目录中的test.xml文件中
    	    OutputStream out=new FileOutputStream(file+"//"+"test.xml");
    	    //设置写入的格式，createPrettyPrint表示写入的时候换行
    	    OutputFormat format=OutputFormat.createPrettyPrint();
    	    //设置编码集为UTF-8,中文也可以使用GBK
    	    format.setEncoding("UTF-8");
    	    //通过XMLWriter将内容写入到xml中
    	    XMLWriter writer=new XMLWriter(out, format);
    	    writer.write(doc);//写入
    	    writer.flush();//关闭资源前刷新
    	    writer.close();//关闭资源
    	    out.close();//关闭输出流
    
    	}
    }

## 5、修改XML中指定的参数 ##

案例说明：本案例中将id为1003人的姓名修改成”萧炎-斗破苍穹”

### 5.1、编码实现 ###

package com.it.test;
    
    import java.io.File;
    import java.io.FileOutputStream;
    import java.io.IOException;
    import java.io.OutputStream;
    import java.util.List;
    
    import org.dom4j.Attribute;
    import org.dom4j.Document;
    import org.dom4j.DocumentException;
    import org.dom4j.Element;
    import org.dom4j.io.OutputFormat;
    import org.dom4j.io.SAXReader;
    import org.dom4j.io.XMLWriter;
    public class TestUpdXML {
    	public static void main(String[] args) throws IOException, DocumentException {
    		//创建核心解析器
    	    SAXReader reader=new SAXReader();
    	    File file=new File("C://xmlfile//test.xml");
    	    Document doc=reader.read(file);
    	   
    	    //得到xml的跟节点
    	    Element root= doc.getRootElement();
    	    //通过跟节点得到子节点
    	    List<Element> elements= root.elements();
    	    //遍历得到所有的自己点的属性和值
    	    for (Element eles:elements) {
    		   if(eles.attributeValue("id").equals("1003")){
    			  Attribute attr= eles.attribute("name");
    			  attr.setValue("萧炎-斗破苍穹");
    			  break;
    		   }
    		   //修改地址，地址在元素中间，修改方式如下
    		   //eles.setText("");
            }
    	    //内容修改后，需要将内容重写写入到xml文件中
    	    OutputStream out=new FileOutputStream(file);
    	   
    	    OutputFormat format=OutputFormat.createPrettyPrint();
    	    format.setEncoding("UTF-8");
    	   
    	    XMLWriter writer=new XMLWriter(out, format);
    	    writer.write(doc);
    	    writer.flush();
    	    writer.close();
    	    out.close();
    	}
    }

### 5.2、修改结果 ###

![414cfe72ef0c4efaa44d5865631364e1.png][]

## 6、DOM4J解析web.xml文件实例化Servlet ##

原理分析：我们解析用户在地址栏中输入的地址信息如add.do,用这个地址去web.xml文件中通过DOM4J技术，解析判断add.do对应的是哪个url-pattern，找到后获取对应的servlet-name。在用这个servlet-name去找到对应额servlet-class。使用类的全限定实现servlet的实例化。

特殊说明：在web.xml中，Servlet的配置文件url-pattern可以写一个也可以写多个，在解析的时候需要考虑到单个或多个的情况。

### 6.1、创建类模拟servlet ###

包名：com.it.servlet

public class AddServlet {
    	public AddServlet(){
    		System.out.println("===========AddServlet被实例化==========");
    	}
    }

### 6.2、创建测试使用的web.xml配置文件 ###

将需要解析的web.xml配置文件放在工程的src目录下，案例中使用的Eclipse开发工具，如果使用maven工程或者idea工程，可以将配置放置在resources目录中都可以。

其中add.do是真是存在的，upd.do和delete.do是不存在的，仅作为模拟数据使用。

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
      <welcome-file-list>
        <welcome-file>index.html</welcome-file>
      </welcome-file-list>
      
      <servlet>
        <servlet-name>AddServlet</servlet-name>
        <servlet-class>com.it.servlet.AddServlet</servlet-class>
      </servlet>
      <servlet-mapping>
        <servlet-name>AddServlet</servlet-name>
        <url-pattern>/add.do</url-pattern>
      </servlet-mapping>
      
      <servlet>
        <servlet-name>UpdServlet</servlet-name>
        <servlet-class>com.it.servlet.UpdServlet</servlet-class>
      </servlet>
      <servlet-mapping>
        <servlet-name>UpdServlet</servlet-name>
        <url-pattern>/upd.do</url-pattern>
      </servlet-mapping>
      
      <servlet>
        <servlet-name>DeleteServlet</servlet-name>
        <servlet-class>com.it.servlet.DeleteServlet</servlet-class>
      </servlet>
      <servlet-mapping>
        <servlet-name>DeleteServlet</servlet-name>
        <url-pattern>/delete.do</url-pattern>
      </servlet-mapping>
      
    </web-app>

### 6.3、解析web.xml-只有一个url-pattern的解析方式 ###

说明1：System.getProperty("user.dir")获取运行项目的路径

【测试代码】

package com.it.test;
    
    import java.io.File;
    import java.util.List;
    
    import org.dom4j.Document;
    import org.dom4j.Element;
    import org.dom4j.io.SAXReader;
    
    public class TestParseWebXML {
    	public static void main(String[] args) throws Exception{
    		 String url="/add.do";
    		   SAXReader reader=new SAXReader();
    		   File file=new File(System.getProperty("user.dir")+"//src//web.xml");
    	       Document doc=reader.read(file);
    		   //得到xml的跟节点
    		   Element root= doc.getRootElement();
    		   //通过跟节点得到子节点
    		   List<Element> elements= root.elements();
    		   String servletName="";
    		   //寻找第一个参数：通过url找到对应的servlet-name的值
    		   for (Element eles:elements) {
    			  //判断进入servlet-mapping元素中，此时web.xml有多个servlet-mapping
    			  if(eles.getName().equals("servlet-mapping")){
    				  //判断servlet-mapping中的url-pattern的值url参数相等
    				  if(eles.elementText("url-pattern").equals(url)){
    					  //如果条件满足，就获取对应的servlet-name的值
    					  servletName=eles.elementText("servlet-name");
    				  }
    			  }
    		   }
    		 //寻找第二个参数：通过servlet-name找到对应的servlet-class的值
    		   String servletClass="";
    		   for (Element eles:elements) {
    				  //先进入到servlet元素中，此时有多个servlet元素
    				  if(eles.getName().equals("servlet")){
    					  //判断servlet-name是否与上面的servletName相等
    					  if(eles.elementText("servlet-name").equals(servletName)){
    						  //如果条件满足，获取servlet-class的值
    						  servletClass=eles.elementText("servlet-class");
    					  }
    				  }
    			   }
    		   //通过servletClass的全限定类名实现类的实例化
    		   Class.forName(servletClass).newInstance();
    	}
    }

【测试结果】

![0527c26fbfb74990a4831d084e8ce960.png][]

### 6.4、解析web.xml-有多个url-pattern的解析方式 ###

【对应的servlet-mapping配置】

<servlet-mapping>
    <servlet-name>AddServlet</servlet-name>
    <url-pattern>/add.do</url-pattern>
    <url-pattern>/add1.do</url-pattern>
    <url-pattern>/add2.do</url-pattern>
    <url-pattern>/add3.do</url-pattern>
      </servlet-mapping>

### 6.5、具体解析方式 ###

说明1：我们此时设置url的值为add2.do

【代码测试】

package com.it.test;
    
    import java.io.File;
    import java.util.List;
    
    import org.dom4j.Document;
    import org.dom4j.Element;
    import org.dom4j.io.SAXReader;
    /**
     * dom4j，模拟解析web.xml配置文件。
     * @author Administrator
     *
     */
    public class TestParseWebXML {
    	public static void main(String[] args) throws Exception{
    		 String url="/add2.do";
    		   SAXReader reader=new SAXReader();
    		   File file=new File(System.getProperty("user.dir")+"//src//web.xml");
    	       Document doc=reader.read(file);
    		   //得到xml的跟节点
    		   Element root= doc.getRootElement();
    		   //通过跟节点得到子节点
    		   List<Element> elements= root.elements();
    		   String servletName="";
    		   //寻找第一个参数:通过url找到对应的servlet-name的值
    	       for (Element eles:elements) {
    				if(eles.getName().equals("servlet-mapping")){
    					//得到当前的servlet-mapping元素下的子元素(serlvet-name,url-pattern)
    					List<Element> urlpattern=eles.elements();
                         用来遍历一个servlet-mapping中的多个url-pattern
    					for (Element e:urlpattern) {
    						if(e.getName().equals("url-pattern")){
    							if(e.getText().equals(url)){//第一次/add.do;第二次/add1.do....
    								servletName=eles.elementText("servlet-name");
    							}
    						}
    					}
    				}
    		   }
    		   //寻找第一个参数:通过servlet-name找到对应的servlet-class的值
    		   String servletClass="";
    		   for (Element eles:elements) {
    				  //先进入到servlet元素中，此时有多个servlet元素
    				  if(eles.getName().equals("servlet")){
    					  //判断servlet-name是否与上面的servletName相等
    					  if(eles.elementText("servlet-name").equals(servletName)){
    						  //如果条件满足，获取servlet-class的值
    						  servletClass=eles.elementText("servlet-class");
    					  }
    				  }
    			   }
    		   //通过servletClass的全限定类名实现类的实例化
    		   Class.forName(servletClass).newInstance();
    	}
    }

【测试结果】

![5256af3c47404209a87603e64c2245c5.png][]

## 7、源码下载 ##

[https://download.csdn.net/download/tangshiyilang/87928643][https_download.csdn.net_download_tangshiyilang_87928643]

[dom4j]: https://dom4j.github.io/
[81ca0a0df31845d8a28f7f38b32a4c2a.png]: https://img-blog.csdnimg.cn/81ca0a0df31845d8a28f7f38b32a4c2a.png
[0b29b054ef71444b96f6c92f73fd5e09.png]: https://img-blog.csdnimg.cn/0b29b054ef71444b96f6c92f73fd5e09.png
[597bc2c02ea6480d9e5424d64283eb9d.png]: https://img-blog.csdnimg.cn/597bc2c02ea6480d9e5424d64283eb9d.png
[81235accaa944ace9ab59cc5c3e7cef7.png]: https://img-blog.csdnimg.cn/81235accaa944ace9ab59cc5c3e7cef7.png
[e832764135d64f19bdffb6045ff5d231.png]: https://img-blog.csdnimg.cn/e832764135d64f19bdffb6045ff5d231.png
[414cfe72ef0c4efaa44d5865631364e1.png]: https://img-blog.csdnimg.cn/414cfe72ef0c4efaa44d5865631364e1.png
[0527c26fbfb74990a4831d084e8ce960.png]: https://img-blog.csdnimg.cn/0527c26fbfb74990a4831d084e8ce960.png
[5256af3c47404209a87603e64c2245c5.png]: https://img-blog.csdnimg.cn/5256af3c47404209a87603e64c2245c5.png
[https_download.csdn.net_download_tangshiyilang_87928643]: https://download.csdn.net/download/tangshiyilang/87928643