com.xiaoleilu.hutool.util

类 XmlUtil

java.lang.Object

com.xiaoleilu.hutool.util.XmlUtil

public class XmlUtil
extends Object

XML工具类
此工具使用w3c dom工具，不需要依赖第三方包。

作者:

xiaoleilu

字段概要

字段

限定符和类型	字段和说明
static String	INVALID_REGEX 在XML中无效的字符 正则

构造器概要

构造器

构造器和说明
XmlUtil()

方法概要

方法

限定符和类型	方法和说明
static String	cleanInvalid(String xmlContent) 去除XML文本中的无效字符
static Document	createXml(String rootElementName) 创建XML文档 创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
static String	elementText(Element element, String tagName) 根据节点名获得第一个子节点
static String	elementText(Element element, String tagName, String defaultValue) 根据节点名获得第一个子节点
static Element	getElement(Element element, String tagName) 根据节点名获得第一个子节点
static List<Element>	getElements(Element element, String tagName) 根据节点名获得子节点列表
static Document	parseXml(String xmlStr) 将String类型的XML转换为XML文档
static <T> T	readObjectFromXml(File source) 从XML中读取对象 Reads serialized object from the XML file.
static Document	readXML(File file) 读取解析XML文件
static Document	readXML(String absoluteFilePath) 读取解析XML文件
static void	toFile(Document doc, String absolutePath) 将XML文档写入到文件 使用Document中的编码
static void	toFile(Document doc, String absolutePath, String charset) 将XML文档写入到文件
static String	toStr(Document doc) 将XML文档转换为String
static String	toStr(Document doc, String charset) 将XML文档转换为String 此方法会修改Document中的字符集
static List<Element>	transElements(Element parentEle, NodeList nodeList) 将NodeList转换为Element列表
static List<Element>	transElements(NodeList nodeList) 将NodeList转换为Element列表
static <T> void	writeObjectAsXml(File dest, T t) 将可序列化的对象转换为XML写入文件，已经存在的文件将被覆盖 Writes serializable object to a XML file.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

INVALID_REGEX

public static final String INVALID_REGEX

在XML中无效的字符 正则

另请参阅:

常量字段值

构造器详细资料

XmlUtil

public XmlUtil()

方法详细资料

readXML

public static Document readXML(File file)

读取解析XML文件

参数:

file - XML文件

返回:

XML文档对象

readXML

public static Document readXML(String absoluteFilePath)

读取解析XML文件

参数:

absoluteFilePath - XML文件绝对路径

返回:

XML文档对象

parseXml

public static Document parseXml(String xmlStr)

将String类型的XML转换为XML文档

参数:

xmlStr - XML字符串

返回:

XML文档

toStr

public static String toStr(Document doc)

将XML文档转换为String

参数:

doc - XML文档

返回:

XML字符串

toStr

public static String toStr(Document doc,
           String charset)

将XML文档转换为String
此方法会修改Document中的字符集

参数:

doc - XML文档

charset - 自定义XML的字符集

返回:

XML字符串

toFile

public static void toFile(Document doc,
          String absolutePath)

将XML文档写入到文件
使用Document中的编码

参数:

doc - XML文档

absolutePath - 文件绝对路径，不存在会自动创建

toFile

public static void toFile(Document doc,
          String absolutePath,
          String charset)

将XML文档写入到文件

参数:

doc - XML文档

absolutePath - 文件绝对路径，不存在会自动创建

charset - 自定义XML文件的编码

createXml

public static Document createXml(String rootElementName)

创建XML文档
创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码

参数:

rootElementName - 根节点名称

返回:

XML文档

cleanInvalid

public static String cleanInvalid(String xmlContent)

去除XML文本中的无效字符

参数:

xmlContent - XML文本

返回:

当传入为null时返回null

getElements

public static List<Element> getElements(Element element,
                        String tagName)

根据节点名获得子节点列表

参数:

element - 节点

tagName - 节点名

返回:

节点列表

getElement

public static Element getElement(Element element,
                 String tagName)

根据节点名获得第一个子节点

参数:

element - 节点

tagName - 节点名

返回:

节点

elementText

public static String elementText(Element element,
                 String tagName)

根据节点名获得第一个子节点

参数:

element - 节点

tagName - 节点名

返回:

节点中的值

elementText

public static String elementText(Element element,
                 String tagName,
                 String defaultValue)

根据节点名获得第一个子节点

参数:

element - 节点

tagName - 节点名

返回:

节点中的值

transElements

public static List<Element> transElements(NodeList nodeList)

将NodeList转换为Element列表

参数:

nodeList - NodeList

返回:

Element列表

transElements

public static List<Element> transElements(Element parentEle,
                          NodeList nodeList)

将NodeList转换为Element列表

参数:

parentEle - 父节点，如果指定将返回此节点的所有直接子节点，nul返回所有就节点

nodeList - NodeList

返回:

Element列表

writeObjectAsXml

public static <T> void writeObjectAsXml(File dest,
                        T t)
                             throws IOException

将可序列化的对象转换为XML写入文件，已经存在的文件将被覆盖
Writes serializable object to a XML file. Existing file will be overwritten

类型参数:

T -

参数:

dest - 目标文件

t - 对象

抛出:

IOException

readObjectFromXml

public static <T> T readObjectFromXml(File source)
                           throws IOException

从XML中读取对象 Reads serialized object from the XML file.

类型参数:

T -

参数:

source - XML文件

返回:

对象

抛出:

IOException