java.lang.Object

org.aoju.bus.core.toolkit.XmlKit

public class XmlKit extends Object

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

Since:: Java 17+
Author:: Kimi Liu

Constructor Summary

Constructors

Constructor

Description

XmlKit()
Method Summary

Modifier and Type

Method

Description

static void

append(Node node, Object data)

追加数据子节点，可以是Map、集合、文本

static Element

appendChild(Node node, String tagName)

在已有节点上创建子节点

static Element

appendChild(Node node, String tagName, String namespace)

在已有节点上创建子节点

static Node

appendText(Node node, CharSequence text)

创建文本子节点

static DocumentBuilder

builder()

创建 DocumentBuilder

static String

caseToXml(String xml)

将xml节点转小写

static String

cleanComment(String xmlContent)

去除XML文本中的注释内容

static String

cleanInvalid(String xmlContent)

去除XML文本中的无效字符

static Document

createXml()

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

static Document

createXml(String rootElementName)

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

static Document

createXml(String rootElementName, String namespace)

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

static XPath

createXPath()

创建XPath

static String

escape(String string)

转义XML特殊字符:

static String

escapeToXml(String xml)

替换xml中特殊字符

static String

format(String xmlStr)

格式化XML输出

static String

format(Document doc)

格式化XML输出

static Object

getByXPath(String expression, Object source, QName returnType)

通过XPath方式读取XML节点等信息

static Element

getElement(Document doc)

获得XML文档根节点

static Element

getElement(Element element, String tagName)

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

static Document

getElement(Node node)

获取节点所在的Document

static Element

getElementByXPath(String expression, Object source)

通过XPath方式读取XML节点等信息

static String

getField(String xml, String field)

static Node

getNodeByXPath(String expression, Object source)

通过XPath方式读取XML节点等信息

static NodeList

getNodeListByXPath(String expression, Object source)

通过XPath方式读取XML的NodeList

static String

getText(Element element, String tagName)

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

static String

getText(Element element, String tagName, String defaultValue)

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

static boolean

isElement(Node node)

给定节点是否为Element 类型节点

static Document

mapToXml(Map<?,?> data, String rootName)

将Map转换为XML

static String

mapToXml(Map<String,Object> map)

将MAP对象转换为XML格式

static Document

parseXml(String xmlStr)

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

static void

readBySax(File file, ContentHandler contentHandler)

使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理

static void

readBySax(InputStream source, ContentHandler contentHandler)

使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理

static void

readBySax(Reader reader, ContentHandler contentHandler)

使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理

static void

readBySax(InputSource source, ContentHandler contentHandler)

使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理

static Document

readXML(File file)

读取解析XML文件

static Document

readXML(InputStream inputStream)

读取解析XML文件编码在XML中定义

static Document

readXML(Reader reader)

读取解析XML文件

static Document

readXML(String pathOrContent)

读取解析XML文件如果给定内容以“<”开头，表示这是一个XML内容，直接读取，否则按照路径处理路径可以为相对路径，也可以是绝对路径，相对路径相对于ClassPath

static Document

readXML(InputSource source)

读取解析XML文件编码在XML中定义

static String

toCase(String xml, boolean type)

将XML内的所有属性大写或小写

static void

toFile(Document doc, String absolutePath)

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

static void

toFile(Document doc, String path, String charset)

将XML文档写入到文件

static String

toString(Document doc)

将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8 默认非格式化输出，若想格式化请使用format(Document)

static String

toString(Document doc, boolean isPretty)

将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8

static String

toString(Document doc, String charset, boolean isPretty)

将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8

static String

toString(Node doc)

将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8 默认非格式化输出，若想格式化请使用format(Document)

static String

toString(Node doc, boolean isPretty)

将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8

static String

toString(Node doc, String charset, boolean isPretty)

将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8

static String

toString(Node doc, String charset, boolean isPretty, boolean omitXmlDeclaration)

将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8

static void

toXml(Map<String,Object> map, StringBuffer buffer)

map 转xml

static List<Element>

transElements(Element parentEle, NodeList nodeList)

将NodeList转换为Element列表非Element节点将被忽略

static List<Element>

transElements(NodeList nodeList)

将NodeList转换为Element列表

static void

transform(Source source, Result result, String charset, int indent)

将XML文档写出

static void

transform(Source source, Result result, String charset, int indent, boolean omitXmlDeclaration)

将XML文档写出

static void

write(Node node, OutputStream out, String charset, int indent)

将XML文档写出

static void

write(Node node, OutputStream out, String charset, int indent, boolean omitXmlDeclaration)

将XML文档写出

static void

write(Node node, Writer writer, String charset, int indent)

将XML文档写出

static void

write(Node node, Writer writer, String charset, int indent, boolean omitXmlDeclaration)

将XML文档写出

static <T> T

xmlToBean(Node node, Class<T> bean)

XML转Java Bean

static Map<String,Object>

xmlToMap(String xmlStr)

XML格式字符串转换为Map

static Map<String,Object>

xmlToMap(String xmlStr, Map<String,Object> result)

XML格式字符串转换为Map 只支持第一级别的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 Details
- XmlKit
  
  public XmlKit()
Method Details
- readXML
  
  public static Document readXML(File file)
  
  读取解析XML文件
  
  Parameters:
  
  file - XML文件
  
  Returns:
  
  XML文档对象
- readXML
  
  public static Document readXML(String pathOrContent)
  
  读取解析XML文件如果给定内容以“<”开头，表示这是一个XML内容，直接读取，否则按照路径处理路径可以为相对路径，也可以是绝对路径，相对路径相对于ClassPath
  
  Parameters:
  
  pathOrContent - 内容或路径
  
  Returns:
  
  XML文档对象
- readXML
  
  public static Document readXML(InputStream inputStream)
  
  读取解析XML文件编码在XML中定义
  
  Parameters:
  
  inputStream - XML流
  
  Returns:
  
  XML文档对象
- readXML
  
  public static Document readXML(Reader reader)
  
  读取解析XML文件
  
  Parameters:
  
  reader - XML流
  
  Returns:
  
  XML文档对象
- readXML
  
  public static Document readXML(InputSource source)
  
  读取解析XML文件编码在XML中定义
  
  Parameters:
  
  source - InputSource
  
  Returns:
  
  XML文档对象
- readBySax
  
  public static void readBySax(File file, ContentHandler contentHandler)
  
  使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理
  
  Parameters:
  
  file - XML源文件,使用后自动关闭
  
  contentHandler - XML流处理器，用于按照Element处理xml
- readBySax
  
  public static void readBySax(Reader reader, ContentHandler contentHandler)
  
  使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理
  
  Parameters:
  
  reader - XML源Reader,使用后自动关闭
  
  contentHandler - XML流处理器，用于按照Element处理xml
- readBySax
  
  public static void readBySax(InputStream source, ContentHandler contentHandler)
  
  使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理
  
  Parameters:
  
  source - XML源流,使用后自动关闭
  
  contentHandler - XML流处理器，用于按照Element处理xml
- readBySax
  
  public static void readBySax(InputSource source, ContentHandler contentHandler)
  
  使用Sax方式读取指定的XML 如果用户传入的contentHandler为DefaultHandler，则其接口都会被处理
  
  Parameters:
  
  source - XML源，可以是文件、流、路径等
  
  contentHandler - XML流处理器，用于按照Element处理xml
- parseXml
  
  public static Document parseXml(String xmlStr)
  
  将String类型的XML转换为XML文档
  
  Parameters:
  
  xmlStr - XML字符串
  
  Returns:
  
  XML文档
- toString
  
  public static String toString(Node doc)
  
  将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8 默认非格式化输出，若想格式化请使用format(Document)
  
  Parameters:
  
  doc - XML文档
  
  Returns:
  
  XML字符串
- toString
  
  public static String toString(Document doc)
  
  将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8 默认非格式化输出，若想格式化请使用format(Document)
  
  Parameters:
  
  doc - XML文档
  
  Returns:
  
  XML字符串
- toString
  
  public static String toString(Node doc, boolean isPretty)
  
  将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
  
  Parameters:
  
  doc - XML文档
  
  isPretty - 是否格式化输出
  
  Returns:
  
  XML字符串
- toString
  
  public static String toString(Document doc, boolean isPretty)
  
  将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
  
  Parameters:
  
  doc - XML文档
  
  isPretty - 是否格式化输出
  
  Returns:
  
  XML字符串
- toString
  
  public static String toString(Node doc, String charset, boolean isPretty)
  
  将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
  
  Parameters:
  
  doc - XML文档
  
  charset - 编码
  
  isPretty - 是否格式化输出
  
  Returns:
  
  XML字符串
- toString
  
  public static String toString(Document doc, String charset, boolean isPretty)
  
  将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
  
  Parameters:
  
  doc - XML文档
  
  charset - 编码
  
  isPretty - 是否格式化输出
  
  Returns:
  
  XML字符串
- toString
  
  public static String toString(Node doc, String charset, boolean isPretty, boolean omitXmlDeclaration)
  
  将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
  
  Parameters:
  
  doc - XML文档
  
  charset - 编码
  
  isPretty - 是否格式化输出
  
  omitXmlDeclaration - 是否忽略 xml Declaration
  
  Returns:
  
  XML字符串
- toFile
  
  public static void toFile(Document doc, String absolutePath)
  
  将XML文档写入到文件使用Document中的编码
  
  Parameters:
  
  doc - XML文档
  
  absolutePath - 文件绝对路径，不存在会自动创建
- toFile
  
  public static void toFile(Document doc, String path, String charset)
  
  将XML文档写入到文件
  
  Parameters:
  
  doc - XML文档
  
  path - 文件路径绝对路径或相对ClassPath路径，不存在会自动创建
  
  charset - 自定义XML文件的编码，如果为null 读取XML文档中的编码，否则默认UTF-8
- format
  
  public static String format(Document doc)
  
  格式化XML输出
  
  Parameters:
  
  doc - Document XML文档
  
  Returns:
  
  格式化后的XML字符串
- format
  
  public static String format(String xmlStr)
  
  格式化XML输出
  
  Parameters:
  
  xmlStr - XML字符串
  
  Returns:
  
  格式化后的XML字符串
- write
  
  public static void write(Node node, Writer writer, String charset, int indent)
  
  将XML文档写出
  
  Parameters:
  
  node - Node XML文档节点或文档本身
  
  writer - 写出的Writer，Writer决定了输出XML的编码
  
  charset - 编码
  
  indent - 格式化输出中缩进量，小于1表示不格式化输出
- write
  
  public static void write(Node node, Writer writer, String charset, int indent, boolean omitXmlDeclaration)
  
  将XML文档写出
  
  Parameters:
  
  node - Node XML文档节点或文档本身
  
  writer - 写出的Writer，Writer决定了输出XML的编码
  
  charset - 编码
  
  indent - 格式化输出中缩进量，小于1表示不格式化输出
  
  omitXmlDeclaration - 是否输出 xml Declaration
- write
  
  public static void write(Node node, OutputStream out, String charset, int indent)
  
  将XML文档写出
  
  Parameters:
  
  node - Node XML文档节点或文档本身
  
  out - 写出的Writer，Writer决定了输出XML的编码
  
  charset - 编码
  
  indent - 格式化输出中缩进量，小于1表示不格式化输出
- write
  
  public static void write(Node node, OutputStream out, String charset, int indent, boolean omitXmlDeclaration)
  
  将XML文档写出
  
  Parameters:
  
  node - Node XML文档节点或文档本身
  
  out - 写出的Writer，Writer决定了输出XML的编码
  
  charset - 编码
  
  indent - 格式化输出中缩进量，小于1表示不格式化输出
  
  omitXmlDeclaration - 是否输出 xml Declaration
- transform
  
  public static void transform(Source source, Result result, String charset, int indent)
  
  将XML文档写出
  
  Parameters:
  
  source - 源
  
  result - 目标
  
  charset - 编码
  
  indent - 格式化输出中缩进量，小于1表示不格式化输出
- transform
  
  public static void transform(Source source, Result result, String charset, int indent, boolean omitXmlDeclaration)
  
  将XML文档写出
  
  Parameters:
  
  source - 源
  
  result - 目标
  
  charset - 编码
  
  indent - 格式化输出中缩进量，小于1表示不格式化输出
  
  omitXmlDeclaration - 是否输出 xml Declaration
- createXml
  
  public static Document createXml()
  
  创建XML文档创建的XML默认是utf8编码,修改编码的过程是在toStr和toFile方法里,既XML在转为文本的时候才定义编码
  
  Returns:
  
  XML文档
- createXml
  
  public static Document createXml(String rootElementName)
  
  创建XML文档创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，即XML在转为文本的时候才定义编码
  
  Parameters:
  
  rootElementName - 根节点名称
  
  Returns:
  
  XML文档
- createXml
  
  public static Document createXml(String rootElementName, String namespace)
  
  创建XML文档创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，即XML在转为文本的时候才定义编码
  
  Parameters:
  
  rootElementName - 根节点名称
  
  namespace - 命名空间，无则传null
  
  Returns:
  
  XML文档
- getElement
  public static Element getElement(Document doc)
  
  获得XML文档根节点
  
  Parameters:
  
  doc - Document
  
  Returns:
  
  根节点
  
  See Also:
  
  Document.getDocumentElement()
- getElement
  
  public static Element getElement(Element element, String tagName)
  
  根据节点名获得第一个子节点
  
  Parameters:
  
  element - 节点
  
  tagName - 节点名
  
  Returns:
  
  节点
- getElement
  
  public static Document getElement(Node node)
  
  获取节点所在的Document
  
  Parameters:
  
  node - 节点
  
  Returns:
  
  Document
- getText
  
  public static String getText(Element element, String tagName)
  
  根据节点名获得第一个子节点
  
  Parameters:
  
  element - 节点
  
  tagName - 节点名
  
  Returns:
  
  节点中的值
- getText
  
  public static String getText(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列表
- getByXPath
  
  public static Object getByXPath(String expression, Object source, QName returnType)
  
  通过XPath方式读取XML节点等信息
  
  Parameters:
  
  expression - XPath表达式
  
  source - 资源,可以是Docunent、Node节点等
  
  returnType - 返回类型,XPathConstants
  
  Returns:
  
  匹配返回类型的值
- getElementByXPath
  
  public static Element getElementByXPath(String expression, Object source)
  
  通过XPath方式读取XML节点等信息
  
  Parameters:
  
  expression - XPath表达式
  
  source - 资源,可以是Docunent、Node节点等
  
  Returns:
  
  匹配返回类型的值
- getNodeListByXPath
  
  public static NodeList getNodeListByXPath(String expression, Object source)
  
  通过XPath方式读取XML的NodeList
  
  Parameters:
  
  expression - XPath表达式
  
  source - 资源,可以是Docunent、Node节点等
  
  Returns:
  
  NodeList
- getNodeByXPath
  
  public static Node getNodeByXPath(String expression, Object source)
  
  通过XPath方式读取XML节点等信息
  
  Parameters:
  
  expression - XPath表达式
  
  source - 资源,可以是Docunent、Node节点等
  
  Returns:
  
  匹配返回类型的值
- xmlToMap
  
  public static Map<String,Object> xmlToMap(String xmlStr)
  
  XML格式字符串转换为Map
  
  Parameters:
  
  xmlStr - XML字符串
  
  Returns:
  
  XML数据转换后的Map
- xmlToMap
  
  public static Map<String,Object> xmlToMap(Node node)
  
  XML格式字符串转换为Map
  
  Parameters:
  
  node - XML节点
  
  Returns:
  
  XML数据转换后的Map
- xmlToMap
  
  public static Map<String,Object> xmlToMap(String xmlStr, Map<String,Object> result)
  
  XML格式字符串转换为Map 只支持第一级别的XML，不支持多级XML
  
  Parameters:
  
  xmlStr - XML字符串
  
  result - 结果Map类型
  
  Returns:
  
  XML数据转换后的Map
- xmlToMap
  
  public static Map<String,Object> xmlToMap(Node node, Map<String,Object> result)
  
  XML节点转换为Map
  
  Parameters:
  
  node - XML节点
  
  result - 结果Map类型
  
  Returns:
  
  XML数据转换后的Map
- xmlToBean
  
  public static <T> T xmlToBean(Node node, Class<T> bean)
  
  XML转Java Bean
  
  Type Parameters:
  
  T - bean类型
  
  Parameters:
  
  node - XML节点
  
  bean - bean类
  
  Returns:
  
  bean
- mapToXml
  
  public static String mapToXml(Map<String,Object> map)
  
  将MAP对象转换为XML格式
  
  Parameters:
  
  map - 对象信息
  
  Returns:
  
  xml字符串
- mapToXml
  
  public static Document mapToXml(Map<?,?> data, String rootName)
  
  将Map转换为XML
  
  Parameters:
  
  data - Map类型数据
  
  rootName - 节点
  
  Returns:
  
  XML
- escapeToXml
  
  public static String escapeToXml(String xml)
  
  替换xml中特殊字符
  
  Parameters:
  
  xml - 字符串信息
  
  Returns:
  
  字符串
- caseToXml
  
  public static String caseToXml(String xml)
  
  将xml节点转小写
  
  Parameters:
  
  xml - 字符串
  
  Returns:
  
  xml字符串
- getField
  
  public static String getField(String xml, String field)
  
  Parameters:
  
  xml - 字符串
  
  field - 要获取的字段名
  
  Returns:
  
  返回该字段的值
- builder
  
  public static DocumentBuilder builder()
  
  创建 DocumentBuilder
  
  Returns:
  
  DocumentBuilder
- createXPath
  
  public static XPath createXPath()
  
  创建XPath
  
  Returns:
  
  XPath
- cleanInvalid
  
  public static String cleanInvalid(String xmlContent)
  
  去除XML文本中的无效字符
  
  Parameters:
  
  xmlContent - XML文本
  
  Returns:
  
  当传入为null时返回null
- cleanComment
  
  public static String cleanComment(String xmlContent)
  
  去除XML文本中的注释内容
  
  Parameters:
  
  xmlContent - XML文本
  
  Returns:
  
  当传入为null时返回null
- isElement
  
  public static boolean isElement(Node node)
  
  给定节点是否为Element 类型节点
  
  Parameters:
  
  node - 节点
  
  Returns:
  
  是否为Element 类型节点
- append
  
  public static void append(Node node, Object data)
  
  追加数据子节点，可以是Map、集合、文本
  
  Parameters:
  
  node - 节点
  
  data - 数据
- appendChild
  
  public static Element appendChild(Node node, String tagName)
  
  在已有节点上创建子节点
  
  Parameters:
  
  node - 节点
  
  tagName - 标签名
  
  Returns:
  
  子节点
- appendChild
  
  public static Element appendChild(Node node, String tagName, String namespace)
  
  在已有节点上创建子节点
  
  Parameters:
  
  node - 节点
  
  tagName - 标签名
  
  namespace - 命名空间，无传null
  
  Returns:
  
  子节点
- appendText
  
  public static Node appendText(Node node, CharSequence text)
  
  创建文本子节点
  
  Parameters:
  
  node - 节点
  
  text - 文本
  
  Returns:
  
  子节点
- escape
  public static String escape(String string)
  
  转义XML特殊字符:
  & (ampersand) 替换为 & < (小于) 替换为 < > (大于) 替换为 > " (双引号) 替换为 "
  
  Parameters:
  
  string - 被替换的字符串
  
  Returns:
  
  替换后的字符串
- toCase
  
  public static String toCase(String xml, boolean type)
  
  将XML内的所有属性大写或小写
  
  Parameters:
  
  xml - XML字符串
  
  type - 转换类型，即:大写 false / 小写 true
  
  Returns:
  
  转换后的XML
- toXml
  
  public static void toXml(Map<String,Object> map, StringBuffer buffer)
  
  map 转xml
  
  Parameters:
  
  map - map 对象
  
  buffer - 返回字符

Class XmlKit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

XmlKit

Method Details

readXML

readXML

readXML

readXML

readXML

readBySax

readBySax

readBySax

readBySax

parseXml

toString

toString

toString

toString

toString

toString

toString

toFile

toFile

format

format

write

write

write

write

transform

transform

createXml

createXml

createXml

getElement

getElement

getElement

getText

getText

transElements

transElements

getByXPath

getElementByXPath

getNodeListByXPath

getNodeByXPath

xmlToMap

xmlToMap

xmlToMap

xmlToMap

xmlToBean

mapToXml

mapToXml

escapeToXml

caseToXml

getField

builder

createXPath

cleanInvalid

cleanComment

isElement

append

appendChild

appendChild

appendText

escape

toCase

toXml