由来

在日常编码中，我们接触最多的除了JSON外，就是XML格式了，一般而言，我们首先想到的是引入Dom4j包，却不知JDK已经封装有XML解析和构建工具：w3c dom。但是由于这个API操作比较繁琐，因此 EasyTool 中提供了XmlUtil简化XML的创建、读和写的过程。

下面是XmlUtil工具类的方法列表，包含了每个方法的说明：

• ParseXml：解析XML字符串，返回解析后的XML文档对象。
• LoadXmlFromFile：从XML文件中加载XML文档，返回XML文档对象。
• CreateNewXmlDocument：创建新的XML文档，返回XML文档对象。
• CreateXmlElement：创建新的XML元素，可以指定元素的名称和值，返回新创建的XML元素。
• CreateXmlAttribute：创建新的XML属性，可以指定属性的名称和值，返回新创建的XML属性。
• GetXmlElement：从XML文档中获取指定名称的元素，返回指定名称的XML元素。
• GetXmlElement：从XML元素中获取指定名称的子元素，返回指定名称的XML元素。
• GetXmlAttribute：从XML元素中获取指定名称的属性，返回指定名称的XML属性。
• GetXmlAttributeStringValue：从XML元素中获取指定名称的属性的值，返回指定名称的属性的字符串值。
• GetXmlAttributeIntValue：从XML元素中获取指定名称的属性的整数值，返回指定名称的属性的整数值。
• GetXmlAttributeFloatValue：从XML元素中获取指定名称的属性的浮点数值，返回指定名称的属性的浮点数值。
• SaveXmlToFile：将XML文档保存到指定路径的文件中。
• XmlToString：将XML文档转换为字符串，返回XML文档的字符串表示。
• XmlElementToString：将XML元素转换为字符串，返回XML元素的字符串表示。
• AddXmlElement：在XML元素中添加子元素。
• AddXmlAttribute：在XML元素中添加属性。
• AddXmlAttribute：在XML元素中添加具有指定名称和值的属性。
• SetXmlAttribute：在XML元素中设置指定名称的属性的值。
• XmlElementToDictionary：将XML元素转换为字典，返回包含XML元素的所有属性的键值对字典。
• DictionaryToXmlElement：将字典转换为XML元素，可以指定XML元素的名称，返回新创建的XML元素。

EasyTool.XmlUtil 类

静态工具类 XmlUtil，提供了许多方便的方法，用于执行各种XML操作。它的功能包括：

• 解析XML字符串。
• 从XML文件中加载XML文档。
• 创建新的XML文档、元素和属性。
• 读取和写入XML元素和属性。
• 将XML文档和XML元素转换为字符串。
• 在XML元素中添加子元素和属性，设置属性的值。
• 将XML元素转换为字典，将字典转换为XML元素。
• 开发人员可以使用XmlUtil工具类轻松地执行各种XML操作，同时确保他们的代码正确和安全。

ParseXml-解析XML字符串

/// <summary>
/// 解析XML字符串
/// </summary>
/// <param name="xml">要解析的XML字符串。</param>
/// <returns>解析后的XML文档对象。</returns>
public static XmlDocument ParseXml(string xml)

LoadXmlFromFile-从XML文件中加载XML文档

/// <summary>
/// 从XML文件中加载XML文档
/// </summary>
/// <param name="filePath">XML文件的完整路径。</param>
/// <returns>XML文档对象。</returns>
public static XmlDocument LoadXmlFromFile(string filePath)

CreateNewXmlDocument-创建新的XML文档

/// <summary>
/// 创建新的XML文档
/// </summary>
/// <returns>XML文档对象。</returns>
public static XmlDocument CreateNewXmlDocument()

CreateXmlElement-创建新的XML元素

/// <summary>
/// 创建新的XML元素
/// </summary>
/// <param name="name">元素的名称。</param>
/// <param name="value">元素的值。</param>
/// <returns>新创建的XML元素。</returns>
public static XmlElement CreateXmlElement(string name, string value = null)

CreateXmlAttribute-创建新的XML属性

/// <summary>
/// 创建新的XML属性
/// </summary>
/// <param name="name">属性的名称。</param>
/// <param name="value">属性的值。</param>
/// <returns>新创建的XML属性。</returns>
public static XmlAttribute CreateXmlAttribute(string name, string value)

GetXmlElement-从XML文档中获取指定名称的元素

/// <summary>
/// 从XML文档中获取指定名称的元素
/// </summary>
/// <param name="document">XML文档对象。</param>
/// <param name="elementName">元素的名称。</param>
/// <returns>指定名称的XML元素。</returns>
public static XmlElement GetXmlElement(XmlDocument document, string elementName)

GetXmlElement-从XML元素中获取指定名称的子元素

/// <summary>
/// 从XML元素中获取指定名称的子元素
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="childElementName">子元素的名称。</param>
/// <returns>指定名称的子元素。</returns>
public static XmlElement GetXmlElement(XmlElement element, string childElementName)

GetXmlAttribute-从XML元素中获取指定名称的属性

/// <summary>
/// 从XML元素中获取指定名称的属性
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="attributeName">属性的名称。</param>
/// <returns>指定名称的XML属性。</returns>
public static XmlAttribute GetXmlAttribute(XmlElement element, string attributeName)

GetXmlAttributeStringValue-从XML元素中获取指定名称的属性的值

/// <summary>
/// 从XML元素中获取指定名称的属性的值
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="attributeName">属性的名称。</param>
/// <returns>指定名称的属性的值。</returns>
public static string GetXmlAttributeStringValue(XmlElement element, string attributeName)

GetXmlAttributeIntValue-从XML元素中获取指定名称的属性的整数值

/// <summary>
/// 从XML元素中获取指定名称的属性的整数值
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="attributeName">属性的名称。</param>
/// <returns>指定名称的属性的整数值。</returns>
public static int GetXmlAttributeIntValue(XmlElement element, string attributeName)

GetXmlAttributeFloatValue-从XML元素中获取指定名称的属性的浮点数值

/// <summary>
/// 从XML元素中获取指定名称的属性的浮点数值
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="attributeName">属性的名称。</param>
/// <returns>指定名称的属性的浮点数值。</returns>
public static float GetXmlAttributeFloatValue(XmlElement element, string attributeName)

SaveXmlToFile-将XML文档保存到指定路径的文件中

/// <summary>
/// 将XML文档保存到指定路径的文件中
/// </summary>
/// <param name="document">XML文档对象。</param>
/// <param name="filePath">文件路径。</param>
public static void SaveXmlToFile(XmlDocument document, string filePath)

XmlToString-将XML文档转换为字符串

/// <summary>
/// 将XML文档转换为字符串
/// </summary>
/// <param name="document">XML文档对象。</param>
/// <returns>XML文档的字符串表示。</returns>
public static string XmlToString(XmlDocument document)

XmlElementToString-将XML元素转换为字符串

/// <summary>
/// 将XML元素转换为字符串
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <returns>XML元素的字符串表示。</returns>
public static string XmlElementToString(XmlElement element)

AddXmlElement-在XML元素中添加子元素

/// <summary>
/// 在XML元素中添加子元素
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="childElement">要添加的子元素对象。</param>
public static void AddXmlElement(XmlElement element, XmlElement childElement)

AddXmlAttribute-在XML元素中添加属性

/// <summary>
/// 在XML元素中添加属性
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="attribute">要添加的属性对象。</param>
public static void AddXmlAttribute(XmlElement element, XmlAttribute attribute)

AddXmlAttribute-在XML元素中添加具有指定名称和值的属性

/// <summary>
/// 在XML元素中添加具有指定名称和值的属性
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="attributeName">要添加的属性的名称。</param>
/// <param name="attributeValue">要添加的属性的值。</param>
public static void AddXmlAttribute(XmlElement element, string attributeName, string attributeValue)

SetXmlAttribute-在XML元素中设置指定名称的属性的值

/// <summary>
/// 在XML元素中设置指定名称的属性的值
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <param name="attributeName">要设置的属性的名称。</param>
/// <param name="attributeValue">要设置的属性的值。</param>
public static void SetXmlAttribute(XmlElement element, string attributeName, string attributeValue)

XmlElementToDictionary-将XML元素转换为字典

/// <summary>
/// 将XML元素转换为字典
/// </summary>
/// <param name="element">XML元素对象。</param>
/// <returns>包含XML元素的所有属性的键值对字典。</returns>
public static Dictionary<string, string> XmlElementToDictionary(XmlElement element)

DictionaryToXmlElement-将字典转换为XML元素

/// <summary>
/// 将字典转换为XML元素
/// </summary>
/// <param name="dictionary">要转换为XML元素的键值对字典。</param>
/// <param name="elementName">XML元素的名称。</param>
/// <returns>新创建的XML元素。</returns>
public static XmlElement DictionaryToXmlElement(Dictionary<string, string> dictionary, string elementName)

示例代码

以下代码示例演示了XmlUtil工具类的常用方法，包括从文件中加载XML文档、获取元素和属性、添加子元素和属性、将XML文档和XML元素转换为字符串、将XML元素转换为字典以及将字典转换为XML元素。使用XmlUtil工具类可以轻松地完成各种XML操作。

// 从XML文件中加载XML文档
var document = XmlUtil.LoadXmlFromFile("example.xml");

// 从XML文档中获取指定名称的元素
var element = XmlUtil.GetXmlElement(document, "root");

// 从XML元素中获取指定名称的属性的值
var attributeValue = XmlUtil.GetXmlAttributeStringValue(element, "attribute");

// 在XML元素中添加子元素
var childElement = XmlUtil.CreateXmlElement("child", "child value");
XmlUtil.AddXmlElement(element, childElement);

// 在XML元素中添加属性
var attribute = XmlUtil.CreateXmlAttribute("newAttribute", "new attribute value");
XmlUtil.AddXmlAttribute(element, attribute);

// 将XML文档保存到指定路径的文件中
XmlUtil.SaveXmlToFile(document, "example.xml");

// 将XML文档转换为字符串
var xmlString = XmlUtil.XmlToString(document);

// 将XML元素转换为字符串
var elementString = XmlUtil.XmlElementToString(element);

// 将XML元素转换为字典
var dictionary = XmlUtil.XmlElementToDictionary(element);

// 将字典转换为XML元素
var newElement = XmlUtil.DictionaryToXmlElement(dictionary, "newElement");