C#对XmlHelper帮助类操作Xml文档的通用方法汇总
作者：追逐时光者 发布时间：2023-06-29 05:37:01
标签：C#,XmlHelper,帮助类
前言
该篇文章主要总结的是自己平时工作中使用频率比较高的Xml文档操作的一些常用方法和收集网上写的比较好的一些通用Xml文档操作的方法（主要包括Xml序列化和反序列化，Xml文件读取，Xml文档节点内容增删改的一些通过方法）。当然可能还有很多方法会漏了，假如各位同学好的方法可以在文末留言，我会统一收集起来。
C#XML基础入门
https://www.jb51.net/article/104113.htm
Xml反序列化为对象
#region Xml反序列化为对象
/// <summary>
/// Xml反序列化为指定模型对象
/// </summary>
/// <typeparam name="T">对象类型</typeparam>
/// <param name="xmlContent">Xml内容</param>
/// <param name="isThrowException">是否抛出异常</param>
/// <returns></returns>
public static T XmlConvertToModel<T>(string xmlContent, bool isThrowException = false) where T : class
{
StringReader stringReader = null;
try
{
XmlSerializer xmlSerializer = new XmlSerializer(typeof(T));
stringReader = new StringReader(xmlContent);
return (T)xmlSerializer.Deserialize(stringReader);
}
catch (Exception ex)
if (isThrowException)
{
throw ex;
}
return null;
finally
stringReader?.Dispose();
}
/// <summary>
/// 读取Xml文件内容反序列化为指定的对象
/// </summary>
/// <param name="filePath">Xml文件的位置（绝对路径）</param>
/// <returns></returns>
public static T DeserializeFromXml<T>(string filePath)
if (!File.Exists(filePath))
throw new ArgumentNullException(filePath + " not Exists");
using (StreamReader reader = new StreamReader(filePath))
XmlSerializer xs = new XmlSerializer(typeof(T));
T ret = (T)xs.Deserialize(reader);
return ret;
return default(T);
#endregion
对象序列化为Xml
#region 对象序列化为Xml
/// <summary>
/// 对象序列化为Xml
/// </summary>
/// <param name="obj">对象</param>
/// <param name="isThrowException">是否抛出异常</param>
/// <returns></returns>
public static string ObjectSerializerXml<T>(T obj, bool isThrowException = false)
{
if (obj == null)
{
return string.Empty;
}
try
using (StringWriter sw = new StringWriter())
{
Type t = obj.GetType();
//强制指定命名空间，覆盖默认的命名空间
XmlSerializerNamespaces namespaces = new XmlSerializerNamespaces();
//在Xml序列化时去除默认命名空间xmlns:xsd和xmlns:xsi
namespaces.Add(string.Empty, string.Empty);
XmlSerializer serializer = new XmlSerializer(obj.GetType());
//序列化时增加namespaces
serializer.Serialize(sw, obj, namespaces);
sw.Close();
string replaceStr = sw.ToString().Replace(@"<?xml version=""1.0"" encoding=""utf-16""?>", "");
return replaceStr;
}
catch (Exception ex)
if (isThrowException)
throw ex;
}
#endregion
Xml字符处理
#region Xml字符处理
/// <summary>
/// 特殊符号转换为转义字符
/// </summary>
/// <param name="xmlStr"></param>
/// <returns></returns>
public string XmlSpecialSymbolConvert(string xmlStr)
{
return xmlStr.Replace("&", "&").Replace("<", "<").Replace(">", ">").Replace("\'", "'").Replace("\"", """);
}
#endregion
创建Xml文档
#region 创建Xml文档
/// <summary>
/// 创建Xml文档
/// </summary>
/// <param name="saveFilePath">文件保存位置</param>
public void CreateXmlDocument(string saveFilePath)
{
XmlDocument xmlDoc = new XmlDocument();
//创建类型声明节点
XmlNode node = xmlDoc.CreateXmlDeclaration("1.0", "utf-8", "");
xmlDoc.AppendChild(node);
//创建Xml根节点
XmlNode root = xmlDoc.CreateElement("books");
xmlDoc.AppendChild(root);
XmlNode root1 = xmlDoc.CreateElement("book");
root.AppendChild(root1);
//创建子节点
CreateNode(xmlDoc, root1, "author", "追逐时光者");
CreateNode(xmlDoc, root1, "title", "XML学习教程");
CreateNode(xmlDoc, root1, "publisher", "时光出版社");
//将文件保存到指定位置
xmlDoc.Save(saveFilePath/*"D://xmlSampleCreateFile.xml"*/);
}
/// <summary>
/// 创建节点
/// </summary>
/// <param name="xmlDoc">xml文档</param>
/// <param name="parentNode">Xml父节点</param>
/// <param name="name">节点名</param>
/// <param name="value">节点值</param>
///
public void CreateNode(XmlDocument xmlDoc, XmlNode parentNode, string name, string value)
//创建对应Xml节点元素
XmlNode node = xmlDoc.CreateNode(XmlNodeType.Element, name, null);
node.InnerText = value;
parentNode.AppendChild(node);
#endregion
Xml数据读取
#region Xml数据读取
/// <summary>
/// 读取Xml指定节点中的数据
/// </summary>
/// <param name="filePath">Xml文档路径</param>
/// <param name="node">节点</param>
/// <param name="attribute">读取数据的属性名</param>
/// <returns>string</returns>
/**************************************************
* 使用示列:
* XmlHelper.XmlReadNodeAttributeValue(path, "/books/book", "author")
************************************************/
public static string XmlReadNodeAttributeValue(string filePath, string node, string attribute)
{
string value = "";
try
{
XmlDocument doc = new XmlDocument();
doc.Load(filePath);
XmlNode xmlNode = doc.SelectSingleNode(node);
value = (attribute.Equals("") ? xmlNode.InnerText : xmlNode.Attributes[attribute].Value);
}
catch { }
return value;
}
/// 获得xml文件中指定节点的节点数据
/// <param name="nodeName">节点名</param>
/// <returns></returns>
public static string GetNodeInfoByNodeName(string filePath, string nodeName)
string XmlString = string.Empty;
XmlDocument xml = new XmlDocument();
xml.Load(filePath);
XmlElement root = xml.DocumentElement;
XmlNode node = root.SelectSingleNode("//" + nodeName);
if (node != null)
XmlString = node.InnerText;
return XmlString;
/// 获取某一节点的所有孩子节点的值
/// <param name="node">要查询的节点</param>
public string[] ReadAllChildallValue(string node, string filePath)
int i = 0;
string[] str = { };
XmlDocument doc = new XmlDocument();
doc.Load(filePath);
XmlNode xn = doc.SelectSingleNode(node);
XmlNodeList nodelist = xn.ChildNodes; //得到该节点的子节点
if (nodelist.Count > 0)
str = new string[nodelist.Count];
foreach (XmlElement el in nodelist)//读元素值
{
str[i] = el.Value;
i++;
}
return str;
public XmlNodeList ReadAllChild(string node, string filePath)
return nodelist;
#endregion
Xml插入数据
#region Xml插入数据
/// <summary>
/// Xml指定节点元素属性插入数据
/// </summary>
/// <param name="path">路径</param>
/// <param name="node">节点</param>
/// <param name="element">元素名</param>
/// <param name="attribute">属性名</param>
/// <param name="value">属性数据</param>
/// <returns></returns>
/**************************************************
* 使用示列:
* XmlHelper.XmlInsertValue(path, "/books", "book", "author", "Value")
************************************************/
public static void XmlInsertValue(string path, string node, string element, string attribute, string value)
{
try
{
XmlDocument doc = new XmlDocument();
doc.Load(path);
XmlNode xmlNode = doc.SelectSingleNode(node);
if (element.Equals(""))
{
if (!attribute.Equals(""))
{
XmlElement xe = (XmlElement)xmlNode;
xe.SetAttribute(attribute, value);
}
}
else
XmlElement xe = doc.CreateElement(element);
if (attribute.Equals(""))
xe.InnerText = value;
else
//添加新增的节点
xmlNode.AppendChild(xe);
//保存Xml文档
doc.Save(path);
}
catch { }
}
#endregion
Xml修改数据
#region Xml修改数据
/// <summary>
/// Xml指定节点元素属性修改数据
/// </summary>
/// <param name="path">路径</param>
/// <param name="node">节点</param>
/// <param name="attribute">属性名</param>
/// <param name="value">属性数据</param>
/// <returns></returns>
/**************************************************
* 使用示列:
* XmlHelper.XmlUpdateValue(path, "/books", "book","author","Value")
************************************************/
public static void XmlUpdateValue(string path, string node, string attribute, string value)
{
try
{
XmlDocument doc = new XmlDocument();
doc.Load(path);
XmlNode xmlNode = doc.SelectSingleNode(node);
XmlElement xmlElement = (XmlElement)xmlNode;
if (attribute.Equals(""))
xmlElement.InnerText = value;
else
xmlElement.SetAttribute(attribute, value);
//保存Xml文档
doc.Save(path);
}
catch { }
}
#endregion
Xml删除数据
#region Xml删除数据
/// <summary>
/// 删除数据
/// </summary>
/// <param name="path">路径</param>
/// <param name="node">节点</param>
/// <param name="attribute">属性名</param>
/// <returns></returns>
/**************************************************
* 使用示列:
* XmlHelper.XmlDelete(path, "/books", "book")
************************************************/
public static void XmlDelete(string path, string node, string attribute)
{
try
{
XmlDocument doc = new XmlDocument();
doc.Load(path);
XmlNode xn = doc.SelectSingleNode(node);
XmlElement xe = (XmlElement)xn;
if (attribute.Equals(""))
xn.ParentNode.RemoveChild(xn);
else
xe.RemoveAttribute(attribute);
doc.Save(path);
}
catch { }
}
#endregion
完整的XmlHelper帮助类
注意：有些方法不能保证百分之百没有问题的，假如有问题可以留言给我，我会验证并立即修改。
/// <summary>
/// Xml帮助类
/// </summary>
public class XMLHelper
{
#region Xml反序列化为对象
/// <summary>
/// Xml反序列化为指定模型对象
/// </summary>
/// <typeparam name="T">对象类型</typeparam>
/// <param name="xmlContent">Xml内容</param>
/// <param name="isThrowException">是否抛出异常</param>
/// <returns></returns>
public static T XmlConvertToModel<T>(string xmlContent, bool isThrowException = false) where T : class
{
StringReader stringReader = null;
try
{
XmlSerializer xmlSerializer = new XmlSerializer(typeof(T));
stringReader = new StringReader(xmlContent);
return (T)xmlSerializer.Deserialize(stringReader);
}
catch (Exception ex)
if (isThrowException)
{
throw ex;
}
return null;
finally
stringReader?.Dispose();
}
/// <summary>
/// 读取Xml文件内容反序列化为指定的对象
/// </summary>
/// <param name="filePath">Xml文件的位置（绝对路径）</param>
/// <returns></returns>
public static T DeserializeFromXml<T>(string filePath)
if (!File.Exists(filePath))
throw new ArgumentNullException(filePath + " not Exists");
using (StreamReader reader = new StreamReader(filePath))
XmlSerializer xs = new XmlSerializer(typeof(T));
T ret = (T)xs.Deserialize(reader);
return ret;
return default(T);
#endregion
#region 对象序列化为Xml
/// 对象序列化为Xml
/// <param name="obj">对象</param>
public static string ObjectSerializerXml<T>(T obj, bool isThrowException = false)
if (obj == null)
return string.Empty;
using (StringWriter sw = new StringWriter())
Type t = obj.GetType();
//强制指定命名空间，覆盖默认的命名空间
XmlSerializerNamespaces namespaces = new XmlSerializerNamespaces();
//在Xml序列化时去除默认命名空间xmlns:xsd和xmlns:xsi
namespaces.Add(string.Empty, string.Empty);
XmlSerializer serializer = new XmlSerializer(obj.GetType());
//序列化时增加namespaces
serializer.Serialize(sw, obj, namespaces);
sw.Close();
string replaceStr = sw.ToString().Replace(@"<?xml version=""1.0"" encoding=""utf-16""?>", "");
return replaceStr;
#region Xml字符处理
/// 特殊符号转换为转义字符
/// <param name="xmlStr"></param>
public string XmlSpecialSymbolConvert(string xmlStr)
return xmlStr.Replace("&", "&").Replace("<", "<").Replace(">", ">").Replace("\'", "'").Replace("\"", """);
#region 创建Xml文档
/// 创建Xml文档
/// <param name="saveFilePath">文件保存位置</param>
public void CreateXmlDocument(string saveFilePath)
XmlDocument xmlDoc = new XmlDocument();
//创建类型声明节点
XmlNode node = xmlDoc.CreateXmlDeclaration("1.0", "utf-8", "");
xmlDoc.AppendChild(node);
//创建Xml根节点
XmlNode root = xmlDoc.CreateElement("books");
xmlDoc.AppendChild(root);
XmlNode root1 = xmlDoc.CreateElement("book");
root.AppendChild(root1);
//创建子节点
CreateNode(xmlDoc, root1, "author", "追逐时光者");
CreateNode(xmlDoc, root1, "title", "XML学习教程");
CreateNode(xmlDoc, root1, "publisher", "时光出版社");
//将文件保存到指定位置
xmlDoc.Save(saveFilePath/*"D://xmlSampleCreateFile.xml"*/);
/// <summary>
/// 创建节点
/// <param name="xmlDoc">xml文档</param>
/// <param name="parentNode">Xml父节点</param>
/// <param name="name">节点名</param>
/// <param name="value">节点值</param>
///
public void CreateNode(XmlDocument xmlDoc, XmlNode parentNode, string name, string value)
//创建对应Xml节点元素
XmlNode node = xmlDoc.CreateNode(XmlNodeType.Element, name, null);
node.InnerText = value;
parentNode.AppendChild(node);
#region Xml数据读取
/// 读取Xml指定节点中的数据
/// <param name="filePath">Xml文档路径</param>
/// <param name="node">节点</param>
/// <param name="attribute">读取数据的属性名</param>
/// <returns>string</returns>
/**************************************************
* 使用示列:
* XmlHelper.XmlReadNodeAttributeValue(path, "/books/book", "author")
************************************************/
public static string XmlReadNodeAttributeValue(string filePath, string node, string attribute)
string value = "";
XmlDocument doc = new XmlDocument();
doc.Load(filePath);
XmlNode xmlNode = doc.SelectSingleNode(node);
value = (attribute.Equals("") ? xmlNode.InnerText : xmlNode.Attributes[attribute].Value);
catch { }
return value;
/// 获得xml文件中指定节点的节点数据
/// <param name="nodeName">节点名</param>
public static string GetNodeInfoByNodeName(string filePath, string nodeName)
string XmlString = string.Empty;
XmlDocument xml = new XmlDocument();
xml.Load(filePath);
XmlElement root = xml.DocumentElement;
XmlNode node = root.SelectSingleNode("//" + nodeName);
if (node != null)
XmlString = node.InnerText;
return XmlString;
/// 获取某一节点的所有孩子节点的值
/// <param name="node">要查询的节点</param>
public string[] ReadAllChildallValue(string node, string filePath)
int i = 0;
string[] str = { };
XmlDocument doc = new XmlDocument();
doc.Load(filePath);
XmlNode xn = doc.SelectSingleNode(node);
XmlNodeList nodelist = xn.ChildNodes; //得到该节点的子节点
if (nodelist.Count > 0)
str = new string[nodelist.Count];
foreach (XmlElement el in nodelist)//读元素值
str[i] = el.Value;
i++;
return str;
public XmlNodeList ReadAllChild(string node, string filePath)
return nodelist;
#region Xml插入数据
/// Xml指定节点元素属性插入数据
/// <param name="path">路径</param>
/// <param name="element">元素名</param>
/// <param name="attribute">属性名</param>
/// <param name="value">属性数据</param>
* XmlHelper.XmlInsertValue(path, "/books", "book", "author", "Value")
public static void XmlInsertValue(string path, string node, string element, string attribute, string value)
doc.Load(path);
if (element.Equals(""))
if (!attribute.Equals(""))
{
XmlElement xe = (XmlElement)xmlNode;
xe.SetAttribute(attribute, value);
}
else
XmlElement xe = doc.CreateElement(element);
if (attribute.Equals(""))
xe.InnerText = value;
else
//添加新增的节点
xmlNode.AppendChild(xe);
//保存Xml文档
doc.Save(path);
#region Xml修改数据
/// Xml指定节点元素属性修改数据
* XmlHelper.XmlUpdateValue(path, "/books", "book","author","Value")
public static void XmlUpdateValue(string path, string node, string attribute, string value)
XmlElement xmlElement = (XmlElement)xmlNode;
if (attribute.Equals(""))
xmlElement.InnerText = value;
xmlElement.SetAttribute(attribute, value);
#region Xml删除数据
/// 删除数据
* XmlHelper.XmlDelete(path, "/books", "book")
public static void XmlDelete(string path, string node, string attribute)
XmlNode xn = doc.SelectSingleNode(node);
XmlElement xe = (XmlElement)xn;
xn.ParentNode.RemoveChild(xn);
xe.RemoveAttribute(attribute);
}
来源：https://www.cnblogs.com/Can-daydayup/p/16058817.html
0
投稿猜你喜欢
- 题目从命令行读入两个数组的长度和数组的值，其中第一行两个数na和nb代表aa和bb数组的长度代码import java.util.Scann
读取自定义properties注入到bean在使用springboot项目时，可使用@value的方式直接读取application.pro- 当我们对一些需要用到的资料进行整理时，会发现文件的内存占用很大，不过是下载或者存储，都不是很方便，这时候我们会想到把文件变成zip格式，即进
- 前言现在不少应用都是采用了混合开发模式，不论是原生加RN,或是原生加Flutter,或是原生加H5。原生实现主业务线，其他部分可以借助跨平台
- SpringBoot实战电商项目mall（30k+star）地址：https://github.com/macrozheng/mall摘要权
- 定义栈又名堆栈，是一种操作受限的线性表，仅能在表尾进行插入和删除操作。它的特点是先进后出，就好比我们往桶里面放盘子，放的时候都是从下往上一个
- 概念逃逸分析一种数据分析算法，基于此算法可以有效减少 Java 对象在堆内存中的分配。 Hotspot 虚拟机的编译器能够分析出一个新对象的
- 用idea编写代码不多天，写代码的时候突然左侧目录没了，遇到这种情况相信大多数的小伙伴都是和我一样直接百度，于是网上找了很长时间，大多数都是
- 1. 为什么需要智能指针？简单的说，智能指针是为了实现类似于Java中的垃圾回收机制。Java的垃圾回收机制使程序员从繁杂的内存管理任务中彻
- 该文章中使用了较多的 委托delegate和Lambda表达式，如果你并不熟悉这些，请查看我的文章《委托与匿名委托》、《匿名委托与Lambd
- 一、概念Tomcat的虚拟目录即在服务器上另选择一个webapps之外的文件夹存放项目文件，通过配置Tomcat的属性，实现访问。注：未配置
- 本文实例讲述了C#提取网页中超链接link和text部分的方法。分享给大家供大家参考，具体如下：string s = "..&qu
- OpenFeign介绍一开始，我们使用原生的 DiscoveryClient 发现服务和使用RestTemplate进行服务间调用，然后我们
- 本文为大家分享了Toast类避免显示时间叠加的方法，供大家参考，具体内容如下import android.app.Activity;impo
- 由于for循环可以通过控制循环变量的初始值和循环结束条件来改变遍历的区间，所以在排序或者遍历的时候，利用for循环就比较简单，以下是本人学习
- 一些Java编程老手在做CodeReview时，都会告诉其他人，使用HashMap时建议指定容量大小，原因是指定容量后，代码性能会更好一些。
- HTTP请求，在日常开发中，还是比较常见的，今天给大家分享HttpUtils如何使用。阅读本文，你将收获：简单总结HTTP请求常用配置；Ja
- 一、了解Spring自动装配的方式采用传统的XML方式配置Bean组件的关键代码如下所示<bean id="userMapp
- 本文实例为大家分享了android实现注册登录程序的具体代码，供大家参考，具体内容如 * 册页面：user_register.xml：<
- 开始用的.net 自带的DataContractJsonSerializer进行序列化和反序列化，当代码写完以后，调试，我X（原谅我的脏话，
