Package org.miaixz.bus.core.xyz

Class XmlKit

java.lang.Object
org.miaixz.bus.core.xyz.XmlKit
public class XmlKit extends Object
XML工具类 此工具使用w3c dom工具，不需要依赖第三方包。 工具类封装了XML文档的创建、读取、写出和部分XML操作
Since:
Java 17+
Author:
Kimi Liu

  • Field Details

    • INVALID_PATTERN

      public static final Pattern INVALID_PATTERN
      在XML中无效的字符 正则

    • COMMENT_PATTERN

      public static final Pattern COMMENT_PATTERN
      在XML中注释的内容 正则

  • Constructor Details

    • XmlKit

      public XmlKit()

  • Method Details

    • readXml

      public static Document readXml(String pathOrContent)
      读取解析XML文件 如果给定内容以“<”开头，表示这是一个XML内容，直接读取，否则按照路径处理 路径可以为相对路径，也可以是绝对路径，相对路径相对于ClassPath
      Parameters:
      pathOrContent - 内容或路径
      Returns:
      XML文档对象

    • readXml

      public static Document readXml(File file)
      读取解析XML文件
      Parameters:
      file - XML文件
      Returns:
      XML文档对象

    • readXml

      public static Document readXml(InputStream inputStream) throws InternalException
      读取解析XML文件 编码在XML中定义
      Parameters:
      inputStream - XML流
      Returns:
      XML文档对象
      Throws:
      InternalException - IO异常或转换异常

    • readXml

      public static Document readXml(Reader reader) throws InternalException
      读取解析XML文件
      Parameters:
      reader - XML流
      Returns:
      XML文档对象
      Throws:
      InternalException - IO异常或转换异常

    • readXml

      public static Document readXml(InputSource source, boolean namespaceAware)
      读取解析XML文件 编码在XML中定义
      Parameters:
      source - InputSource
      namespaceAware - 是否打开命名空间支持
      Returns:
      XML文档对象

    • parseXml

      public static Document parseXml(String xmlStr)
      将String类型的XML转换为XML文档
      Parameters:
      xmlStr - XML字符串
      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

    • toString

      public static String toString(Node 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(Node doc, Charset charset, boolean isPretty)
      将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8
      Parameters:
      doc - XML文档
      charset - 编码
      isPretty - 是否格式化输出
      Returns:
      XML字符串

    • toString

      public static String toString(Node doc, Charset charset, boolean isPretty, boolean omitXmlDeclaration)
      将XML文档转换为String 字符编码使用XML文档中的编码，获取不到则使用UTF-8 当omitXmlDeclaration为true时，表示忽略xml Declaration，即删掉 
      
     <?xml version="1.0" encoding="utf-8"?>
      Parameters:
      doc - XML文档
      charset - 编码
      isPretty - 是否格式化输出
      omitXmlDeclaration - 是否忽略 xml Declaration
      Returns:
      XML字符串

    • 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(Document doc, File file, Charset charset)
      将XML文档写入到文件 使用Document中的编码
      Parameters:
      doc - XML文档
      file - 文件
      charset - 编码

    • write

      public static void write(Node node, Writer writer, Charset charset, int indent)
      将XML文档写出
      Parameters:
      node - Node XML文档节点或文档本身
      writer - 写出的Writer，Writer决定了输出XML的编码
      charset - 编码
      indent - 格式化输出中缩进量，小于1表示不格式化输出

    • write

      public static void write(Node node, Writer writer, Charset charset, int indent, boolean omitXmlDeclaration)
      将XML文档写出 当omitXmlDeclaration为true时，表示忽略xml Declaration，即删掉 
      
     <?xml version="1.0" encoding="utf-8"?>
      Parameters:
      node - Node XML文档节点或文档本身
      writer - 写出的Writer，Writer决定了输出XML的编码
      charset - 编码
      indent - 格式化输出中缩进量，小于1表示不格式化输出
      omitXmlDeclaration - 是否忽略 xml Declaration

    • write

      public static void write(Node node, OutputStream out, Charset charset, int indent)
      将XML文档写出
      Parameters:
      node - Node XML文档节点或文档本身
      out - 写出的Writer，Writer决定了输出XML的编码
      charset - 编码
      indent - 格式化输出中缩进量，小于1表示不格式化输出

    • write

      public static void write(Node node, OutputStream out, Charset charset, int indent, boolean omitXmlDeclaration)
      将XML文档写出 当omitXmlDeclaration为true时，表示忽略xml Declaration，即删掉 
      
     <?xml version="1.0" encoding="utf-8"?>
      Parameters:
      node - Node XML文档节点或文档本身
      out - 写出的Writer，Writer决定了输出XML的编码
      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文档

    • getRootElement

      public static Element getRootElement(Document doc)
      获得XML文档根节点
      Parameters:
      doc - Document
      Returns:
      根节点
      See Also:

    • getOwnerDocument

      public static Document getOwnerDocument(Node node)
      获取节点所在的Document
      Parameters:
      node - 节点
      Returns:
      Document

    • 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

    • getElements

      public static List<Element> getElements(Element element, String tagName)
      根据节点名获得子节点列表
      Parameters:
      element - 节点
      tagName - 节点名，如果节点名为空（null或blank），返回所有子节点
      Returns:
      节点列表

    • 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 - 父节点，如果指定将返回此节点的所有直接子节点，null返回所有就节点
      nodeList - NodeList
      Returns:
      Element列表

    • writeObjectAsXml

      public static void writeObjectAsXml(File dest, Object bean)
      将可序列化的对象转换为XML写入文件，已经存在的文件将被覆盖 Writes serializable object to a XML file. Existing file will be overwritten
      Parameters:
      dest - 目标文件
      bean - 对象

    • xmlToBean

      public static <T> T xmlToBean(Node node, Class<T> beanClass)
      XML转Java Bean 如果XML根节点只有一个，且节点名和Bean的名称一致，则直接转换子节点
      Type Parameters:
      T - bean类型
      Parameters:
      node - XML节点
      beanClass - bean类
      Returns:
      beans

    • xmlToMap

      public static Map<String,Object> xmlToMap(String xmlStr)
      XML格式字符串转换为Map
      Parameters:
      xmlStr - 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)
      XML格式字符串转换为Map
      Parameters:
      node - XML节点
      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

    • mapToXmlString

      public static String mapToXmlString(Map<?,?> data)
      将Map转换为XML格式的字符串
      Parameters:
      data - Map类型数据
      Returns:
      XML格式的字符串

    • mapToXmlString

      public static String mapToXmlString(Map<?,?> data, boolean omitXmlDeclaration)
      将Map转换为XML格式的字符串 当omitXmlDeclaration为true时，表示忽略xml Declaration，即 
      
     <?xml version="1.0" encoding="utf-8"?>
      Parameters:
      data - Map类型数据
      omitXmlDeclaration - 是否忽略 xml Declaration
      Returns:
      XML格式的字符串

    • mapToXmlString

      public static String mapToXmlString(Map<?,?> data, String rootName)
      将Map转换为XML格式的字符串
      Parameters:
      data - Map类型数据
      rootName - 根节点名
      Returns:
      XML格式的字符串

    • mapToXmlString

      public static String mapToXmlString(Map<?,?> data, String rootName, String namespace)
      将Map转换为XML格式的字符串
      Parameters:
      data - Map类型数据
      rootName - 根节点名
      namespace - 命名空间，可以为null
      Returns:
      XML格式的字符串

    • mapToXmlString

      public static String mapToXmlString(Map<?,?> data, String rootName, String namespace, boolean omitXmlDeclaration)
      将Map转换为XML格式的字符串 当omitXmlDeclaration为true时，表示忽略xml Declaration，即删掉 
      
     <?xml version="1.0" encoding="utf-8"?>
      Parameters:
      data - Map类型数据
      rootName - 根节点名
      namespace - 命名空间，可以为null
      omitXmlDeclaration - 是否忽略 xml Declaration
      Returns:
      XML格式的字符串

    • mapToXmlString

      public static String mapToXmlString(Map<?,?> data, String rootName, String namespace, boolean isPretty, boolean omitXmlDeclaration)
      将Map转换为XML格式的字符串 当omitXmlDeclaration为true时，表示忽略xml Declaration，即删掉 
      
     <?xml version="1.0" encoding="utf-8"?>
      Parameters:
      data - Map类型数据
      rootName - 根节点名
      namespace - 命名空间，可以为null
      isPretty - 是否格式化输出
      omitXmlDeclaration - 是否忽略 xml Declaration
      Returns:
      XML格式的字符串

    • mapToXmlString

      public static String mapToXmlString(Map<?,?> data, String rootName, String namespace, Charset charset, boolean isPretty, boolean omitXmlDeclaration)
      将Map转换为XML格式的字符串 当omitXmlDeclaration为true时，表示忽略xml Declaration，即删掉 
      
     <?xml version="1.0" encoding="utf-8"?>
      Parameters:
      data - Map类型数据
      rootName - 根节点名
      namespace - 命名空间，可以为null
      charset - 编码
      isPretty - 是否格式化输出
      omitXmlDeclaration - 是否忽略 xml Declaration
      Returns:
      XML格式的字符串

    • mapToXml

      public static Document mapToXml(Map<?,?> data, String rootName)
      将Map转换为XML
      Parameters:
      data - Map类型数据
      rootName - 根节点名
      Returns:
      XML

    • mapToXml

      public static Document mapToXml(Map<?,?> data, String rootName, String namespace)
      将Map转换为XML
      Parameters:
      data - Map类型数据
      rootName - 根节点名
      namespace - 命名空间，可以为null
      Returns:
      XML

    • beanToXml

      public static Document beanToXml(Object bean)
      将Bean转换为XML
      Parameters:
      bean - Bean对象
      Returns:
      XML

    • beanToXml

      public static Document beanToXml(Object bean, String namespace)
      将Bean转换为XML
      Parameters:
      bean - Bean对象
      namespace - 命名空间，可以为null
      Returns:
      XML

    • beanToXml

      public static Document beanToXml(Object bean, String namespace, boolean ignoreNull)
      将Bean转换为XML
      Parameters:
      bean - Bean对象
      namespace - 命名空间，可以为null
      ignoreNull - 忽略值为null的属性
      Returns:
      XML

    • isElement

      public static boolean isElement(Node node)
      给定节点是否为Element 类型节点
      Parameters:
      node - 节点
      Returns:
      是否为 Element 类型节点

    • 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:
      子节点

    • append

      public static void append(Node node, Object data)
      追加数据子节点，可以是Map、集合、文本
      Parameters:
      node - 节点
      data - 数据