XmlUtil (hutool-core 4.1.18 API)

java.lang.Object
- cn.hutool.core.util.XmlUtil

```
public class XmlUtil
extends java.lang.Object
```
XML工具类
此工具使用w3c dom工具，不需要依赖第三方包。
工具类封装了XML文档的创建、读取、写出和部分XML操作

作者:

xiaoleilu

字段概要

字段
限定符和类型字段和说明

static java.lang.String INVALID_REGEX
在XML中无效的字符正则

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

构造器概要

构造器
构造器和说明

XmlUtil()

构造器
构造器和说明
`XmlUtil()`

方法概要

方法
限定符和类型	方法和说明
`static org.w3c.dom.Element`	`appendChild(org.w3c.dom.Node node, java.lang.String tagName)` 在已有节点上创建子节点
`static java.lang.String`	`cleanInvalid(java.lang.String xmlContent)` 去除XML文本中的无效字符
`static javax.xml.parsers.DocumentBuilder`	`createDocumentBuilder()` 创建 DocumentBuilder
`static org.w3c.dom.Document`	`createXml()` 创建XML文档创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
`static org.w3c.dom.Document`	`createXml(java.lang.String rootElementName)` 创建XML文档创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
`static javax.xml.xpath.XPath`	`createXPath()` 创建XPath Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static java.lang.String`	`elementText(org.w3c.dom.Element element, java.lang.String tagName)` 根据节点名获得第一个子节点
`static java.lang.String`	`elementText(org.w3c.dom.Element element, java.lang.String tagName, java.lang.String defaultValue)` 根据节点名获得第一个子节点
`static java.lang.String`	`escape(java.lang.String string)` 转义XML特殊字符: & (ampersand) 替换为 & < (小于) 替换为 < > (大于) 替换为 > " (双引号) 替换为 "
`static java.lang.Object`	`getByXPath(java.lang.String expression, java.lang.Object source, javax.xml.namespace.QName returnType)` 通过XPath方式读取XML节点等信息 Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static org.w3c.dom.Element`	`getElement(org.w3c.dom.Element element, java.lang.String tagName)` 根据节点名获得第一个子节点
`static org.w3c.dom.Element`	`getElementByXPath(java.lang.String expression, java.lang.Object source)` 通过XPath方式读取XML节点等信息 Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static java.util.List<org.w3c.dom.Element>`	`getElements(org.w3c.dom.Element element, java.lang.String tagName)` 根据节点名获得子节点列表
`static org.w3c.dom.Node`	`getNodeByXPath(java.lang.String expression, java.lang.Object source)` 通过XPath方式读取XML节点等信息 Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static org.w3c.dom.NodeList`	`getNodeListByXPath(java.lang.String expression, java.lang.Object source)` 通过XPath方式读取XML的NodeList Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static org.w3c.dom.Element`	`getRootElement(org.w3c.dom.Document doc)` 获得XML文档根节点
`static boolean`	`isElement(org.w3c.dom.Node node)` 给定节点是否为`Element` 类型节点
`static org.w3c.dom.Document`	`mapToXml(java.util.Map<?,?> data, java.lang.String rootName)` 将Map转换为XML
`static java.lang.String`	`mapToXmlStr(java.util.Map<?,?> data, java.lang.String rootName)` 将Map转换为XML格式的字符串
`static org.w3c.dom.Document`	`parseXml(java.lang.String xmlStr)` 将String类型的XML转换为XML文档
`static <T> T`	`readObjectFromXml(java.io.File source)` 从XML中读取对象 Reads serialized object from the XML file.
`static <T> T`	`readObjectFromXml(org.xml.sax.InputSource source)` 从XML中读取对象 Reads serialized object from the XML file.
`static <T> T`	`readObjectFromXml(java.lang.String xmlStr)` 从XML中读取对象 Reads serialized object from the XML file.
`static org.w3c.dom.Document`	`readXML(java.io.File file)` 读取解析XML文件
`static org.w3c.dom.Document`	`readXML(org.xml.sax.InputSource source)` 读取解析XML文件编码在XML中定义
`static org.w3c.dom.Document`	`readXML(java.io.InputStream inputStream)` 读取解析XML文件编码在XML中定义
`static org.w3c.dom.Document`	`readXML(java.io.Reader reader)` 读取解析XML文件
`static org.w3c.dom.Document`	`readXML(java.lang.String pathOrContent)` 读取解析XML文件如果给定内容以“<”开头，表示这是一个XML内容，直接读取，否则按照路径处理路径可以为相对路径，也可以是绝对路径，相对路径相对于ClassPath
`static void`	`toFile(org.w3c.dom.Document doc, java.lang.String absolutePath)` 将XML文档写入到文件使用Document中的编码
`static void`	`toFile(org.w3c.dom.Document doc, java.lang.String path, java.lang.String charset)` 将XML文档写入到文件
`static java.lang.String`	`toStr(org.w3c.dom.Document doc)` 将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
`static java.lang.String`	`toStr(org.w3c.dom.Document doc, boolean isPretty)` 将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
`static java.lang.String`	`toStr(org.w3c.dom.Document doc, java.lang.String charset, boolean isPretty)` 将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
`static java.util.List<org.w3c.dom.Element>`	`transElements(org.w3c.dom.Element parentEle, org.w3c.dom.NodeList nodeList)` 将NodeList转换为Element列表非Element节点将被忽略
`static java.util.List<org.w3c.dom.Element>`	`transElements(org.w3c.dom.NodeList nodeList)` 将NodeList转换为Element列表
`static void`	`transform(javax.xml.transform.Source source, javax.xml.transform.Result result, java.lang.String charset, boolean isPretty)` 将XML文档写出
`static void`	`write(org.w3c.dom.Node node, java.io.OutputStream out, java.lang.String charset, boolean isPretty)` 将XML文档写出
`static void`	`write(org.w3c.dom.Node node, java.io.Writer writer, boolean isPretty)` 将XML文档写出
`static void`	`writeObjectAsXml(java.io.File dest, java.lang.Object bean)` 将可序列化的对象转换为XML写入文件，已经存在的文件将被覆盖 Writes serializable object to a XML file.
`static java.util.Map<java.lang.String,java.lang.Object>`	`xmlToMap(org.w3c.dom.Node node)` XML格式字符串转换为Map
`static java.util.Map<java.lang.String,java.lang.Object>`	`xmlToMap(org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.Object> result)` XML节点转换为Map
`static java.util.Map<java.lang.String,java.lang.Object>`	`xmlToMap(java.lang.String xmlStr)` XML格式字符串转换为Map
`static java.util.Map<java.lang.String,java.lang.Object>`	`xmlToMap(java.lang.String xmlStr, java.util.Map<java.lang.String,java.lang.Object> result)` XML格式字符串转换为Map 只支持第一级别的XML，不支持多级XML

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - INVALID_REGEX
```
public static final java.lang.String INVALID_REGEX
```
    在XML中无效的字符正则
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - XmlUtil
```
public XmlUtil()
```
- 方法详细资料
  - readXML
```
public static org.w3c.dom.Document readXML(java.io.File file)
```
    读取解析XML文件
    
    参数:
    file - XML文件
    
    返回:
    XML文档对象
  - readXML
```
public static org.w3c.dom.Document readXML(java.lang.String pathOrContent)
```
    读取解析XML文件
    如果给定内容以“<”开头，表示这是一个XML内容，直接读取，否则按照路径处理
    路径可以为相对路径，也可以是绝对路径，相对路径相对于ClassPath
    
    参数:
    pathOrContent - 内容或路径
    
    返回:
    XML文档对象
    从以下版本开始:
    
    3.0.9
  - readXML
```
public static org.w3c.dom.Document readXML(java.io.InputStream inputStream)
                                    throws UtilException
```
    读取解析XML文件
    编码在XML中定义
    
    参数:
    inputStream - XML流
    
    返回:
    XML文档对象
    
    抛出:
    
    UtilException - IO异常或转换异常
    从以下版本开始:
    
    3.0.9
  - readXML
```
public static org.w3c.dom.Document readXML(java.io.Reader reader)
                                    throws UtilException
```
    读取解析XML文件
    
    参数:
    reader - XML流
    
    返回:
    XML文档对象
    
    抛出:
    
    UtilException - IO异常或转换异常
    从以下版本开始:
    
    3.0.9
  - readXML
```
public static org.w3c.dom.Document readXML(org.xml.sax.InputSource source)
```
    读取解析XML文件
    编码在XML中定义
    
    参数:
    source - InputSource
    
    返回:
    XML文档对象
    从以下版本开始:
    
    3.0.9
  - parseXml
```
public static org.w3c.dom.Document parseXml(java.lang.String xmlStr)
```
    将String类型的XML转换为XML文档
    
    参数:
    xmlStr - XML字符串
    
    返回:
    XML文档
  - readObjectFromXml
```
public static <T> T readObjectFromXml(java.io.File source)
                           throws java.io.IOException
```
    从XML中读取对象 Reads serialized object from the XML file.
    
    类型参数:
    T - 对象类型
    参数:
    source - XML文件
    
    返回:
    对象
    
    抛出:
    
    java.io.IOException - IO异常
  - readObjectFromXml
```
public static <T> T readObjectFromXml(java.lang.String xmlStr)
                           throws java.io.IOException
```
    从XML中读取对象 Reads serialized object from the XML file.
    
    类型参数:
    T - 对象类型
    参数:
    xmlStr - XML内容
    
    返回:
    对象
    
    抛出:
    
    java.io.IOException - IO异常
    从以下版本开始:
    
    3.2.0
  - readObjectFromXml
```
public static <T> T readObjectFromXml(org.xml.sax.InputSource source)
                           throws java.io.IOException
```
    从XML中读取对象 Reads serialized object from the XML file.
    
    类型参数:
    T - 对象类型
    参数:
    source - InputSource
    
    返回:
    对象
    
    抛出:
    
    java.io.IOException - IO异常
    从以下版本开始:
    
    3.2.0
  - toStr
```
public static java.lang.String toStr(org.w3c.dom.Document doc)
```
    将XML文档转换为String
    字符编码使用XML文档中的编码，获取不到则使用UTF-8
    
    参数:
    doc - XML文档
    
    返回:
    XML字符串
  - toStr
```
public static java.lang.String toStr(org.w3c.dom.Document doc,
                     boolean isPretty)
```
    将XML文档转换为String
    字符编码使用XML文档中的编码，获取不到则使用UTF-8
    
    参数:
    doc - XML文档
    isPretty - 是否格式化输出
    
    返回:
    XML字符串
    从以下版本开始:
    
    3.0.9
  - toStr
```
public static java.lang.String toStr(org.w3c.dom.Document doc,
                     java.lang.String charset,
                     boolean isPretty)
```
    将XML文档转换为String
    字符编码使用XML文档中的编码，获取不到则使用UTF-8
    
    参数:
    doc - XML文档
    charset - 编码
    isPretty - 是否格式化输出
    
    返回:
    XML字符串
    从以下版本开始:
    
    3.0.9
  - toFile
```
public static void toFile(org.w3c.dom.Document doc,
          java.lang.String absolutePath)
```
    将XML文档写入到文件
    使用Document中的编码
    
    参数:
    doc - XML文档
    absolutePath - 文件绝对路径，不存在会自动创建
  - toFile
```
public static void toFile(org.w3c.dom.Document doc,
          java.lang.String path,
          java.lang.String charset)
```
    将XML文档写入到文件
    
    参数:
    doc - XML文档
    path - 文件路径绝对路径或相对ClassPath路径，不存在会自动创建
    charset - 自定义XML文件的编码，如果为null 读取XML文档中的编码，否则默认UTF-8
  - write
```
public static void write(org.w3c.dom.Node node,
         java.io.Writer writer,
         boolean isPretty)
```
    将XML文档写出
    
    参数:
    node - Node XML文档节点或文档本身
    writer - 写出的Writer，Writer决定了输出XML的编码
    isPretty - 是否格式化输出
    从以下版本开始:
    
    3.0.9
  - write
```
public static void write(org.w3c.dom.Node node,
         java.io.OutputStream out,
         java.lang.String charset,
         boolean isPretty)
```
    将XML文档写出
    
    参数:
    node - Node XML文档节点或文档本身
    out - 写出的Writer，Writer决定了输出XML的编码
    charset - 编码
    isPretty - 是否格式化输出
    从以下版本开始:
    
    4.0.8
  - transform
```
public static void transform(javax.xml.transform.Source source,
             javax.xml.transform.Result result,
             java.lang.String charset,
             boolean isPretty)
```
    将XML文档写出
    
    参数:
    source - 源
    result - 目标
    charset - 编码
    isPretty - 是否格式化输出
    从以下版本开始:
    
    4.0.9
  - createXml
```
public static org.w3c.dom.Document createXml()
```
    创建XML文档
    创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
    
    返回:
    XML文档
    从以下版本开始:
    
    4.0.8
  - createDocumentBuilder
```
public static javax.xml.parsers.DocumentBuilder createDocumentBuilder()
```
    创建 DocumentBuilder
    
    返回:
    DocumentBuilder
    从以下版本开始:
    
    4.1.2
  - createXml
```
public static org.w3c.dom.Document createXml(java.lang.String rootElementName)
```
    创建XML文档
    创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
    
    参数:
    rootElementName - 根节点名称
    
    返回:
    XML文档
  - getRootElement
```
public static org.w3c.dom.Element getRootElement(org.w3c.dom.Document doc)
```
    获得XML文档根节点
    
    参数:
    doc - Document
    
    返回:
    根节点
    从以下版本开始:
    
    3.0.8
    
    另请参阅:
    Document.getDocumentElement()
  - cleanInvalid
```
public static java.lang.String cleanInvalid(java.lang.String xmlContent)
```
    去除XML文本中的无效字符
    
    参数:
    xmlContent - XML文本
    
    返回:
    当传入为null时返回null
  - getElements
```
public static java.util.List<org.w3c.dom.Element> getElements(org.w3c.dom.Element element,
                                              java.lang.String tagName)
```
    根据节点名获得子节点列表
    
    参数:
    element - 节点
    tagName - 节点名，如果节点名为空（null或blank），返回所有子节点
    
    返回:
    节点列表
  - getElement
```
public static org.w3c.dom.Element getElement(org.w3c.dom.Element element,
                             java.lang.String tagName)
```
    根据节点名获得第一个子节点
    
    参数:
    element - 节点
    tagName - 节点名
    
    返回:
    节点
  - elementText
```
public static java.lang.String elementText(org.w3c.dom.Element element,
                           java.lang.String tagName)
```
    根据节点名获得第一个子节点
    
    参数:
    element - 节点
    tagName - 节点名
    
    返回:
    节点中的值
  - elementText
```
public static java.lang.String elementText(org.w3c.dom.Element element,
                           java.lang.String tagName,
                           java.lang.String defaultValue)
```
    根据节点名获得第一个子节点
    
    参数:
    element - 节点
    tagName - 节点名
    defaultValue - 默认值
    
    返回:
    节点中的值
  - transElements
```
public static java.util.List<org.w3c.dom.Element> transElements(org.w3c.dom.NodeList nodeList)
```
    将NodeList转换为Element列表
    
    参数:
    nodeList - NodeList
    
    返回:
    Element列表
  - transElements
```
public static java.util.List<org.w3c.dom.Element> transElements(org.w3c.dom.Element parentEle,
                                                org.w3c.dom.NodeList nodeList)
```
    将NodeList转换为Element列表
    非Element节点将被忽略
    
    参数:
    parentEle - 父节点，如果指定将返回此节点的所有直接子节点，nul返回所有就节点
    nodeList - NodeList
    
    返回:
    Element列表
  - writeObjectAsXml
```
public static void writeObjectAsXml(java.io.File dest,
                    java.lang.Object bean)
                             throws java.io.IOException
```
    将可序列化的对象转换为XML写入文件，已经存在的文件将被覆盖
    Writes serializable object to a XML file. Existing file will be overwritten
    
    参数:
    dest - 目标文件
    bean - 对象
    
    抛出:
    
    java.io.IOException - IO异常
  - createXPath
```
public static javax.xml.xpath.XPath createXPath()
```
    创建XPath
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    返回:
    XPath
    从以下版本开始:
    
    3.2.0
  - getElementByXPath
```
public static org.w3c.dom.Element getElementByXPath(java.lang.String expression,
                                    java.lang.Object source)
```
    通过XPath方式读取XML节点等信息
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    参数:
    expression - XPath表达式
    source - 资源，可以是Docunent、Node节点等
    
    返回:
    匹配返回类型的值
    从以下版本开始:
    
    4.0.9
  - getNodeListByXPath
```
public static org.w3c.dom.NodeList getNodeListByXPath(java.lang.String expression,
                                      java.lang.Object source)
```
    通过XPath方式读取XML的NodeList
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    参数:
    expression - XPath表达式
    source - 资源，可以是Docunent、Node节点等
    
    返回:
    NodeList
    从以下版本开始:
    
    4.0.9
  - getNodeByXPath
```
public static org.w3c.dom.Node getNodeByXPath(java.lang.String expression,
                              java.lang.Object source)
```
    通过XPath方式读取XML节点等信息
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    参数:
    expression - XPath表达式
    source - 资源，可以是Docunent、Node节点等
    
    返回:
    匹配返回类型的值
    从以下版本开始:
    
    4.0.9
  - getByXPath
```
public static java.lang.Object getByXPath(java.lang.String expression,
                          java.lang.Object source,
                          javax.xml.namespace.QName returnType)
```
    通过XPath方式读取XML节点等信息
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    参数:
    expression - XPath表达式
    source - 资源，可以是Docunent、Node节点等
    returnType - 返回类型，XPathConstants
    
    返回:
    匹配返回类型的值
    从以下版本开始:
    
    3.2.0
  - escape
```
public static java.lang.String escape(java.lang.String string)
```
    转义XML特殊字符:
```
 & (ampersand) 替换为 &amp;
 < (小于) 替换为 &lt;
 > (大于) 替换为 &gt;
 " (双引号) 替换为 &quot;
 
```
    参数:
    string - 被替换的字符串
    
    返回:
    替换后的字符串
    从以下版本开始:
    
    4.0.8
  - xmlToMap
```
public static java.util.Map<java.lang.String,java.lang.Object> xmlToMap(java.lang.String xmlStr)
```
    XML格式字符串转换为Map
    
    参数:
    xmlStr - XML字符串
    
    返回:
    XML数据转换后的Map
    从以下版本开始:
    
    4.0.8
  - xmlToMap
```
public static java.util.Map<java.lang.String,java.lang.Object> xmlToMap(org.w3c.dom.Node node)
```
    XML格式字符串转换为Map
    
    参数:
    node - XML节点
    
    返回:
    XML数据转换后的Map
    从以下版本开始:
    
    4.0.8
  - xmlToMap
```
public static java.util.Map<java.lang.String,java.lang.Object> xmlToMap(java.lang.String xmlStr,
                                                        java.util.Map<java.lang.String,java.lang.Object> result)
```
    XML格式字符串转换为Map
    只支持第一级别的XML，不支持多级XML
    
    参数:
    xmlStr - XML字符串
    result - 结果Map类型
    
    返回:
    XML数据转换后的Map
    从以下版本开始:
    
    4.0.8
  - xmlToMap
```
public static java.util.Map<java.lang.String,java.lang.Object> xmlToMap(org.w3c.dom.Node node,
                                                        java.util.Map<java.lang.String,java.lang.Object> result)
```
    XML节点转换为Map
    
    参数:
    node - XML节点
    result - 结果Map类型
    
    返回:
    XML数据转换后的Map
    从以下版本开始:
    
    4.0.8
  - mapToXmlStr
```
public static java.lang.String mapToXmlStr(java.util.Map<?,?> data,
                           java.lang.String rootName)
```
    将Map转换为XML格式的字符串
    
    参数:
    data - Map类型数据
    
    返回:
    XML格式的字符串
    从以下版本开始:
    
    4.0.8
  - mapToXml
```
public static org.w3c.dom.Document mapToXml(java.util.Map<?,?> data,
                            java.lang.String rootName)
```
    将Map转换为XML
    
    参数:
    data - Map类型数据
    
    返回:
    XML
    从以下版本开始:
    
    4.0.9
  - isElement
```
public static boolean isElement(org.w3c.dom.Node node)
```
    给定节点是否为Element 类型节点
    
    参数:
    node - 节点
    
    返回:
    是否为Element 类型节点
    从以下版本开始:
    
    4.0.8
  - appendChild
```
public static org.w3c.dom.Element appendChild(org.w3c.dom.Node node,
                              java.lang.String tagName)
```
    在已有节点上创建子节点
    
    参数:
    node - 节点
    tagName - 标签名
    
    返回:
    子节点
    从以下版本开始:
    
    4.0.9

类 XmlUtil

字段概要

构造器概要

方法概要

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

字段详细资料

INVALID_REGEX

构造器详细资料

XmlUtil

方法详细资料

readXML

readXML

readXML

readXML

readXML

parseXml

readObjectFromXml

readObjectFromXml

readObjectFromXml

toStr

toStr

toStr

toFile

toFile

write

write

transform

createXml

createDocumentBuilder

createXml

getRootElement

cleanInvalid

getElements

getElement

elementText

elementText

transElements

transElements

writeObjectAsXml

createXPath

getElementByXPath

getNodeListByXPath

getNodeByXPath

getByXPath

escape

xmlToMap

xmlToMap

xmlToMap

xmlToMap

mapToXmlStr

mapToXml

isElement

appendChild