使用dom4j创建和解析xml文件

时间:2023-03-08 15:54:59
使用dom4j创建和解析xml文件

使用dom4j创建和解析xml文件

  在项目开发中,我们经常会遇到xml文件的创建和解析从别人接口得到的xml文件,而我们最常使用的组件是dom4j。

下面我就以代码来讲解一下如何使用dom4j来创建xml文件。

1.项目结构

使用dom4j创建和解析xml文件

在这里我们要,引入dom4j中的两个jar包,分别是:

dom4j-1.6.1;

jaxen-1.1-beta-6;

2.简要介绍

  >创建xml 的主要类 DocumentHelper
  document = DocumentHelper.createDocument();

  >写入文件的主要类XMLWriter
  >格式化xml的辅助类OutputFormat
  OutputFormat format = OutputFormat.createPrettyPrint();
  writer = new XMLWriter(new FileWriter(filepath), format);

  >格式化输出 OutputFormat  相应的还有createCompactFormat() 创建压缩的xml文件,删去了所有的换行等无用的字符。createPrettyPrint() 则是生成格式化的xml 代码,让看起来好读一点。

3.实例

下面以代码来详细讲解,注释很清楚。

代码清单【1】XmlUtils.java

 package com.lxf.xmlUtils;

 import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.util.List;
import java.util.Properties;
import java.util.UUID; import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter; /**
* 使用dom4j生成和解析xml文件
* @author Administrator
*2016/12/05
*/
public class XmlUtils
{
private static final XmlUtils INSTANCE = new XmlUtils(); private static final String UU_STRING = UUID.randomUUID().toString().substring(0, 5);
private static final String FILEBASEPATH = getPropertiesInfo("filepath") +"\\"+ UU_STRING + ".xml" ; public static XmlUtils getInstance()
{
return INSTANCE;
} /**
* 1.使用dom4j创建xml文档对象
*/
public static Document createDocument()
{
/*
* 1.使用DocumentHelper创建文档对象.
*/
Document document = DocumentHelper.createDocument();
/*
* 2.创建根节点
*/
Element root = DocumentHelper.createElement("message");
document.setRootElement(root);
/*
* 3.为根节点设置一级节点
*/
Element element1 = root.addElement("name");
element1.setText("java"); Element element2 = root.addElement("age");
element2.setText("23");
/*
* 为一级节点设置子节点
*/
Element element3 = root.addElement("address");
Element element31 = element3.addElement("id");
element31.setText("1");
Element element32 = element3.addElement("province");
element32.setText("北京市");
Element element33 = element3.addElement("street");
element33.setText("长安街");
/*
*4.为节点设置属性
*/
root.setAttributeValue("version", "2.0");
element1.setAttributeValue("kind", "book"); return document; } /**
* 2.使用dom4j创建输出xml文件
*/
public static void createXml()
{
/*
* 1.创建文档对象
*/
Document document = createDocument();
//生成的xml文件存放路径
String filePath =FILEBASEPATH;
File file = new File(filePath); OutputStreamWriter osw = null;
try
{
osw = new OutputStreamWriter(new FileOutputStream(file));
/*
* 2.设置xml文档的输出格式为缩进
*/
OutputFormat format = OutputFormat.createPrettyPrint();
/*
*3.设置输出文档的编码为UTF-8
*/
format.setEncoding("UTF-8");
XMLWriter out = new XMLWriter(osw, format);
/*
* 4.输出xml文档
*/
out.write(document); }
catch (FileNotFoundException e)
{
e.printStackTrace();
}
catch (IOException e)
{
e.printStackTrace();
}
finally
{
//关闭输出流
if(null != osw )
{
try
{
osw.close();
}
catch (IOException e)
{
e.printStackTrace();
}
}
}
} /**
* 3.使用dom4j解析xml文件
*/
public static void analyzeXml()
{
//生成的xml文件存放路径
String filePath =FILEBASEPATH;
File file = new File(filePath);
/*
* 1.使用SAXReader创建Document文档对象
*/
SAXReader reader = new SAXReader();
try
{
Document document = reader.read(file);
/*
* 2.获取xml文件的根节点
*/
Element root = document.getRootElement();
/*
* 3.获取子节点和属性
*/
iteratorCherk(root);
}
catch (DocumentException e)
{
e.printStackTrace();
} } /**
* 4.获取节点名,节点属性
*/
public static void iteratorCherk(Element element)
{
List<Element> elements = element.elements();
for(Element e : elements)
{
List<Attribute> attributeList = e.attributes();
String name = e.getName();
String text = e.getTextTrim();
if(text.length()==0)
{
System.out.println(name+":");
}else
{
System.out.println(name+"="+ text);
}
for(Attribute att : attributeList)
{
String aname = att.getName();
String atext = att.getText();
System.out.println(aname +"="+ atext);
}
iteratorCherk(e);
} } /**
* 5.获取配置文件的配置信息
* @return
*/
public static String getPropertiesInfo(String string)
{
InputStream inputStream = XmlUtils.class.getClassLoader().getResourceAsStream("config.properties");
Properties p = new Properties();
try
{
p.load(inputStream);
}
catch (IOException e)
{
e.printStackTrace();
}
return p.getProperty(string);
}
}

使用JUnit测试,代码清单【2】XmlTest.java

 package demo;

 import org.junit.Test;

 import com.lxf.xmlUtils.XmlUtils;

 /**
* xml工具类测试
* @author Administrator
*
*/
public class XmlTest
{
/**
* 创建xml文件测试
*/
@Test
public void createXmlTest()
{
XmlUtils.getInstance().createXml();
} /**
* 解析xml文件测试
*/
@Test
public void analyzeXmlTest()
{
XmlUtils.getInstance().analyzeXml();
} }

4.拓展和后期补充

  可以看到,我在项目中配置了一个.properties文件,大家可以在为xml文件增加节点和给节点赋值的时候,

读取配置文件的内容(.properties文件的内容结构是key=value).关于读取配置文件可以参照我的上一篇总结(java读取properties配置文件总结).

未来两天,我还会进行javaBean与Xml文件相互转换的总结,目前的想法是:

(1)使用目前掌握的dom4j知识;

(2)使用JAXBContext类,是应用的入口,用于管理XML/Java绑定信息。

使用Marshaller接口,将Java对象序列化为XML数据;

    使用Unmarshaller接口,将XML数据反序列化为Java对象。