XmlUtils (bus-core 3.0.0 API)

java.lang.Object
- org.aoju.bus.core.utils.XmlUtils

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

Since:

JDK 1.8

Version:

3.0.0

Author:

Kimi Liu

Constructor Summary

Constructors
Constructor and Description

XmlUtils()

Constructors
Constructor and Description
`XmlUtils()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Element`	`appendChild(Node node, String tagName)` 在已有节点上创建子节点
`static String`	`cleanInvalid(String xmlContent)` 去除XML文本中的无效字符
`static Object`	`convertXmlStrToObject(String xml, Class clazz)` 将String类型的xml转换成对象
`static DocumentBuilder`	`createDocumentBuilder()` 创建 DocumentBuilder
`static Document`	`createXml()` 创建XML文档创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
`static Document`	`createXml(String rootElementName)` 创建XML文档创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
`static XPath`	`createXPath()` 创建XPath Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static String`	`elementText(Element element, String tagName)` 根据节点名获得第一个子节点
`static String`	`elementText(Element element, String tagName, String defaultValue)` 根据节点名获得第一个子节点
`static String`	`escape(String string)` 转义XML特殊字符:
`static Object`	`getByXPath(String expression, Object source, QName returnType)` 通过XPath方式读取XML节点等信息 Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static Element`	`getElement(Element element, String tagName)` 根据节点名获得第一个子节点
`static Element`	`getElementByXPath(String expression, Object source)` 通过XPath方式读取XML节点等信息 Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`String`	`getfield(String str, String field)`
`static String`	`getFieldByxml(String xml, String field)`
`static Node`	`getNodeByXPath(String expression, Object source)` 通过XPath方式读取XML节点等信息 Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static NodeList`	`getNodeListByXPath(String expression, Object source)` 通过XPath方式读取XML的NodeList Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
`static Element`	`getRootElement(Document doc)` 获得XML文档根节点
`static boolean`	`isElement(Node node)` 给定节点是否为`Element` 类型节点
`static Document`	`mapToXml(Map<?,?> data, String rootName)` 将Map转换为XML
`static String`	`mapToXmlNosign(Map<String,Object> map)` 将MAP对象转换为XML格式
`static String`	`parseBeanToXml(Object object)` 将对象转换为XML
`static String`	`parseBeanToXml(Object object, Map<String,Object> map, Marshaller.Listener listener)` 将对象转换为XML
`static Object`	`parseXmlToBean(String text, Object javaBean)` 将字符串装换为对象
`static Object`	`parseXmlToBean(String text, Object javaBean, String charset)` 将字符串装换为对象
`static <T> List<T>`	`parseXmlToBeanList(String xml, String rel, Class<T> clazz)` 将xml对象根据定义的节点进行拆分,并实现List对象转换
`static <T> List<T>`	`parseXmlToBeanList(String xml, String rel, Class<T> clazz, boolean isSelect)` 将xml对象根据定义的节点进行拆分,并实现List对象转换
`static <T> T`	`readObjectFromXml(InputSource source)` 从XML中读取对象 Reads serialized object from the XML file.
`static Document`	`readXML(InputSource source)` 读取解析XML文件编码在XML中定义
`static Document`	`readXML(InputStream inputStream)` 读取解析XML文件编码在XML中定义
`static Document`	`readXML(Reader reader)` 读取解析XML文件
`static String`	`replaceEscapeCharacter(String xml)` 替换xml中特殊字符
`String`	`requestModel(Object esbEntry)`
`static List<Element>`	`transElements(Element parentEle, NodeList nodeList)` 将NodeList转换为Element列表非Element节点将被忽略
`static List<Element>`	`transElements(NodeList nodeList)` 将NodeList转换为Element列表
`static <T> List<T>`	`XMLToBeanList(String xml, String rel, Class<T> clazz)` xml转list
`static String`	`xmlToLowerCase(String xml)` 将xml节点转小写
`static Map<String,Object>`	`xmlToMap(Node node)` XML格式字符串转换为Map
`static Map<String,Object>`	`xmlToMap(Node node, Map<String,Object> result)` XML节点转换为Map

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XmlUtils
```
public XmlUtils()
```
- Method Detail
  - readXML
```
public static Document readXML(InputStream inputStream)
                        throws CommonException
```
    读取解析XML文件
    编码在XML中定义
    
    Parameters:
    
    inputStream - XML流
    
    Returns:
    
    XML文档对象
    
    Throws:
    
    CommonException - IO异常或转换异常
    
    Since:
    
    3.0.9
  - readXML
```
public static Document readXML(Reader reader)
                        throws CommonException
```
    读取解析XML文件
    
    Parameters:
    
    reader - XML流
    
    Returns:
    
    XML文档对象
    
    Throws:
    
    CommonException - IO异常或转换异常
    
    Since:
    
    3.0.9
  - readXML
```
public static Document readXML(InputSource source)
```
    读取解析XML文件
    编码在XML中定义
    
    Parameters:
    
    source - InputSource
    
    Returns:
    
    XML文档对象
    
    Since:
    
    3.0.9
  - readObjectFromXml
```
public static <T> T readObjectFromXml(InputSource source)
```
    从XML中读取对象 Reads serialized object from the XML file.
    
    Type Parameters:
    
    T - 对象类型
    
    Parameters:
    
    source - InputSource
    
    Returns:
    
    对象
    
    Since:
    
    3.2.0
  - createXml
```
public static Document createXml()
```
    创建XML文档
    创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
    
    Returns:
    
    XML文档
    
    Since:
    
    4.0.8
  - createDocumentBuilder
```
public static DocumentBuilder createDocumentBuilder()
```
    创建 DocumentBuilder
    
    Returns:
    
    DocumentBuilder
    
    Since:
    
    4.1.2
  - createXml
```
public static Document createXml(String rootElementName)
```
    创建XML文档
    创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，既XML在转为文本的时候才定义编码
    
    Parameters:
    
    rootElementName - 根节点名称
    
    Returns:
    
    XML文档
  - getRootElement
```
public static Element getRootElement(Document doc)
```
    获得XML文档根节点
    
    Parameters:
    
    doc - Document
    
    Returns:
    
    根节点
    
    Since:
    
    3.0.8
    
    See Also:
    
    Document.getDocumentElement()
  - cleanInvalid
```
public static String cleanInvalid(String xmlContent)
```
    去除XML文本中的无效字符
    
    Parameters:
    
    xmlContent - XML文本
    
    Returns:
    
    当传入为null时返回null
  - getElement
```
public static Element getElement(Element element,
                                 String tagName)
```
    根据节点名获得第一个子节点
    
    Parameters:
    
    element - 节点
    
    tagName - 节点名
    
    Returns:
    
    节点
  - elementText
```
public static String elementText(Element element,
                                 String tagName)
```
    根据节点名获得第一个子节点
    
    Parameters:
    
    element - 节点
    
    tagName - 节点名
    
    Returns:
    
    节点中的值
  - elementText
```
public static String elementText(Element element,
                                 String tagName,
                                 String defaultValue)
```
    根据节点名获得第一个子节点
    
    Parameters:
    
    element - 节点
    
    tagName - 节点名
    
    defaultValue - 默认值
    
    Returns:
    
    节点中的值
  - transElements
```
public static List<Element> transElements(NodeList nodeList)
```
    将NodeList转换为Element列表
    
    Parameters:
    
    nodeList - NodeList
    
    Returns:
    
    Element列表
  - transElements
```
public static List<Element> transElements(Element parentEle,
                                          NodeList nodeList)
```
    将NodeList转换为Element列表
    非Element节点将被忽略
    
    Parameters:
    
    parentEle - 父节点，如果指定将返回此节点的所有直接子节点，nul返回所有就节点
    
    nodeList - NodeList
    
    Returns:
    
    Element列表
  - createXPath
```
public static XPath createXPath()
```
    创建XPath
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    Returns:
    
    XPath
    
    Since:
    
    3.2.0
  - getElementByXPath
```
public static Element getElementByXPath(String expression,
                                        Object source)
```
    通过XPath方式读取XML节点等信息
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    Parameters:
    
    expression - XPath表达式
    
    source - 资源，可以是Docunent、Node节点等
    
    Returns:
    
    匹配返回类型的值
    
    Since:
    
    4.0.9
  - getNodeListByXPath
```
public static NodeList getNodeListByXPath(String expression,
                                          Object source)
```
    通过XPath方式读取XML的NodeList
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    Parameters:
    
    expression - XPath表达式
    
    source - 资源，可以是Docunent、Node节点等
    
    Returns:
    
    NodeList
    
    Since:
    
    4.0.9
  - getNodeByXPath
```
public static Node getNodeByXPath(String expression,
                                  Object source)
```
    通过XPath方式读取XML节点等信息
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    Parameters:
    
    expression - XPath表达式
    
    source - 资源，可以是Docunent、Node节点等
    
    Returns:
    
    匹配返回类型的值
    
    Since:
    
    4.0.9
  - getByXPath
```
public static Object getByXPath(String expression,
                                Object source,
                                QName returnType)
```
    通过XPath方式读取XML节点等信息
    Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
    
    Parameters:
    
    expression - XPath表达式
    
    source - 资源，可以是Docunent、Node节点等
    
    returnType - 返回类型，XPathConstants
    
    Returns:
    
    匹配返回类型的值
    
    Since:
    
    3.2.0
  - escape
```
public static String escape(String string)
```
    转义XML特殊字符:
```
 & (ampersand) 替换为 &amp;
 < (小于) 替换为 &lt;
 > (大于) 替换为 &gt;
 " (双引号) 替换为 &quot;
 
```
    Parameters:
    
    string - 被替换的字符串
    
    Returns:
    
    替换后的字符串
    
    Since:
    
    4.0.8
  - xmlToMap
```
public static Map<String,Object> xmlToMap(Node node)
```
    XML格式字符串转换为Map
    
    Parameters:
    
    node - XML节点
    
    Returns:
    
    XML数据转换后的Map
    
    Since:
    
    4.0.8
  - xmlToMap
```
public static Map<String,Object> xmlToMap(Node node,
                                          Map<String,Object> result)
```
    XML节点转换为Map
    
    Parameters:
    
    node - XML节点
    
    result - 结果Map类型
    
    Returns:
    
    XML数据转换后的Map
    
    Since:
    
    4.0.8
  - mapToXml
```
public static Document mapToXml(Map<?,?> data,
                                String rootName)
```
    将Map转换为XML
    
    Parameters:
    
    data - Map类型数据
    
    rootName - 节点
    
    Returns:
    
    XML
    
    Since:
    
    4.0.9
  - isElement
```
public static boolean isElement(Node node)
```
    给定节点是否为Element 类型节点
    
    Parameters:
    
    node - 节点
    
    Returns:
    
    是否为Element 类型节点
    
    Since:
    
    4.0.8
  - appendChild
```
public static Element appendChild(Node node,
                                  String tagName)
```
    在已有节点上创建子节点
    
    Parameters:
    
    node - 节点
    
    tagName - 标签名
    
    Returns:
    
    子节点
    
    Since:
    
    4.0.9
  - parseXmlToBean
```
public static Object parseXmlToBean(String text,
                                    Object javaBean)
```
    将字符串装换为对象
    
    Parameters:
    
    text - 字符串
    
    javaBean - 对象
    
    Returns:
    
    object对象
  - parseXmlToBean
```
public static Object parseXmlToBean(String text,
                                    Object javaBean,
                                    String charset)
```
    将字符串装换为对象
    
    Parameters:
    
    text - 字符串
    
    javaBean - 对象
    
    charset - 编码
    
    Returns:
    
    object对象
  - convertXmlStrToObject
```
public static Object convertXmlStrToObject(String xml,
                                           Class clazz)
```
    将String类型的xml转换成对象
    
    Parameters:
    
    xml - 字符串
    
    clazz - 对象
    
    Returns:
    
    object对象
  - parseXmlToBeanList
```
public static <T> List<T> parseXmlToBeanList(String xml,
                                             String rel,
                                             Class<T> clazz,
                                             boolean isSelect)
```
    将xml对象根据定义的节点进行拆分,并实现List对象转换
    
    Type Parameters:
    
    T - 对象
    
    Parameters:
    
    xml - 字符串
    
    rel - 拆分节点
    
    clazz - 对象信息
    
    isSelect - 是否拆分
    
    Returns:
    
    list对象
  - parseXmlToBeanList
```
public static <T> List<T> parseXmlToBeanList(String xml,
                                             String rel,
                                             Class<T> clazz)
```
    将xml对象根据定义的节点进行拆分,并实现List对象转换
    
    Type Parameters:
    
    T - 对象
    
    Parameters:
    
    xml - 字符串
    
    rel - 拆分节点
    
    clazz - 对象信息
    
    Returns:
    
    list对象
  - parseBeanToXml
```
public static String parseBeanToXml(Object object)
                             throws Exception
```
    将对象转换为XML
    
    Parameters:
    
    object - 对象信息
    
    Returns:
    
    string xml
    
    Throws:
    
    Exception - 异常
  - parseBeanToXml
```
public static String parseBeanToXml(Object object,
                                    Map<String,Object> map,
                                    Marshaller.Listener listener)
                             throws Exception
```
    将对象转换为XML
    
    Parameters:
    
    object - 对象信息
    
    map - map
    
    listener - Listener
    
    Returns:
    
    string xml
    
    Throws:
    
    Exception - 异常
  - replaceEscapeCharacter
```
public static String replaceEscapeCharacter(String xml)
```
    替换xml中特殊字符
    
    Parameters:
    
    xml - 字符串信息
    
    Returns:
    
    字符串
  - mapToXmlNosign
```
public static String mapToXmlNosign(Map<String,Object> map)
```
    将MAP对象转换为XML格式
    
    Parameters:
    
    map - 对象信息
    
    Returns:
    
    xml字符串
  - XMLToBeanList
```
public static <T> List<T> XMLToBeanList(String xml,
                                        String rel,
                                        Class<T> clazz)
```
    xml转list
    
    Type Parameters:
    
    T - 对象
    
    Parameters:
    
    xml - 字符串
    
    rel - 拆分节点
    
    clazz - 对象
    
    Returns:
    
    list对象
  - xmlToLowerCase
```
public static String xmlToLowerCase(String xml)
```
    将xml节点转小写
    
    Parameters:
    
    xml - 字符串
    
    Returns:
    
    xml字符串
  - getFieldByxml
```
public static String getFieldByxml(String xml,
                                   String field)
```
    Parameters:
    
    xml - 字符串
    
    field - 要获取的字段名
    
    Returns:
    
    返回该字段的值
  - requestModel
```
public String requestModel(Object esbEntry)
                    throws JAXBException
```
    Throws:
    
    JAXBException
  - getfield
```
public String getfield(String str,
                       String field)
```

Class XmlUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XmlUtils

Method Detail

readXML

readXML

readXML

readObjectFromXml

createXml

createDocumentBuilder

createXml

getRootElement

cleanInvalid

getElement

elementText

elementText

transElements

transElements

createXPath

getElementByXPath

getNodeListByXPath

getNodeByXPath

getByXPath

escape

xmlToMap

xmlToMap

mapToXml

isElement

appendChild

parseXmlToBean

parseXmlToBean

convertXmlStrToObject

parseXmlToBeanList

parseXmlToBeanList

parseBeanToXml

parseBeanToXml

replaceEscapeCharacter

mapToXmlNosign

XMLToBeanList

xmlToLowerCase

getFieldByxml

requestModel

getfield