C#对XmlHelper帮助类操作Xml文档的通用方法汇总

2024-10-01 12:26:02

前言

该篇文章主要总结的是自己平时工作中使用频率比较高的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("\'", "&apos;").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("\'", "&apos;").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);
    }

到此这篇关于C#XmlHelper帮助类操作Xml文档的通用方法汇总的文章就介绍到这了,更多相关C#XmlHelper帮助类内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

c#如何使用 XML 文档功能

下面的示例提供对某个已存档类型的基本概述. 示例 // If compiling from the command line, compile with: -doc:YourFileName.xml /// <summary> /// Class level summary documentation goes here. /// </summary> /// <remarks> /// Longer comments can be associated with a
c#对XML文档的创建与增删改查的示例代码

一.创建的第一种方式 //1.创建一个XML文档 XmlDocument doc = new XmlDocument(); //2.创建第一行描述信息 XmlDeclaration dec = doc.CreateXmlDeclaration("1.0", "utf-8", null); //3.将创建的第一行描述信息添加到文档中 doc.AppendChild(dec); //4.给文档添加根节点 XmlElement Books = doc.CreateElem
C#用NPOI导出导入Excel帮助类

本文实例为大家分享了C#用NPOI导出导入Excel帮助类的具体代码,供大家参考,具体内容如下 1.准备工作在管理NuGet程序包中搜索 NPOI,安装 NPOI 到要项目中. 2.帮助类 /// <summary> /// DataTable写入Excel /// </summary> /// <param name="dt"></param> /// <param name="strExcelFileName&quo
C#对XmlHelper帮助类操作Xml文档的通用方法汇总

前言该篇文章主要总结的是自己平时工作中使用频率比较高的Xml文档操作的一些常用方法和收集网上写的比较好的一些通用Xml文档操作的方法(主要包括Xml序列化和反序列化,Xml文件读取,Xml文档节点内容增删改的一些通过方法).当然可能还有很多方法会漏了,假如各位同学好的方法可以在文末留言,我会统一收集起来. C#XML基础入门 https://www.jb51.net/article/104113.htm Xml反序列化为对象 #region Xml反序列化为对象 /// <summary>
C#操作读取、写入XML文档的实用方法

本文给大家分享一下C#操作(读取.写入)XML文档的实用方法,这种方法主要是对比较规范的XML文档进行操作,因为它(XML文档)和类对象是严格对应的,否则在反序列或序列化的时候会出现错误.其他的不用多说,直接看示例代码吧: using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; using System.Threading.Tasks; using
得到XML文档大小的方法

XML文档从格式到大小都是不是确定的.有的可能只有几行,而有的却有好几兆字节.你也许会怀疑是不是需要了解XML文档的大小.而当性能成为首要问题时,知道XML文档大小就是件必须要作的事情了. 从性能角度讲,有两类处理XML文档的方法.批量处理方式需要较短的时间,解析成组的文档.实时方式就是实时的处理文档.批处理方式的性能可以通过在一定时间内处理多少文档来测量,而实时模式的性能也采用类似的测量方式,不过是以处理一个文档需要多长时间来计算的. Scenarios场景想象一下,你有一个实时工作的系统,
Java获取XML节点总结之读取XML文档节点的方法

dom4j是Java的XML API,用来读写XML文件的.目前有很多场景中使用dom4j来读写xml的. 要使用dom4j开发,需要下载导入dom4j相应的jar文件. 官网下载:http://www.dom4j.org/dom4j-1.6.1/ github下载:http://dom4j.github.io/ 下载解压之后如图所示: 我们只需要把dom4j-1.6.1.jar文件构建到我们开发项目中就可以了. 下面就以Eclipse创建java项目的构建方法为例说明: 声明:本Java项目的
通过php删除xml文档内容的方法

本文实例讲述了通过php删除xml文档内容的方法.分享给大家供大家参考.具体实现方法如下: 第一种情况:删除一个student节点复制代码代码如下: <?php //1.创建一个DOMDocument对象.该对象就表示 xml文件 $xmldoc = new DOMDocument(); //2.加载xml文件(指定要解析哪个xml文件,此时dom树节点就会加载到内存中) $xmldoc->load("class.xml"); //3.删除一条学生student信息记录
通过php添加xml文档内容的方法

本文实例讲述了通过php添加xml文档内容的方法.分享给大家供大家参考.具体分析如下: 这里讲述的添加xml文档内容,从上一篇<DOM基础及php读取xml内容操作的方法>继续,代码如下: 复制代码代码如下: <?php //1.创建一个DOMDocument对象.该对象就表示 xml文件 $xmldoc = new DOMDocument(); //2.加载xml文件(指定要解析哪个xml文件,此时dom树节点就会加载到内存中) $xmldoc->load("clas
通过php修改xml文档内容的方法

本文实例讲述了通过php修改xml文档内容的方法,分享给大家供大家参考.具体实现方法如下: 复制代码代码如下: <?php //1.创建一个DOMDocument对象.该对象就表示 xml文件 $xmldoc = new DOMDocument(); //2.加载xml文件(指定要解析哪个xml文件,此时dom树节点就会加载到内存中) $xmldoc->load("class.xml"); //3.更新一条学生student信息记录,更新她的年龄 //(1)找到该学生 $
dom4j创建和解析xml文档的实现方法

DOM4J解析特征: 1.JDOM的一种智能分支,它合并了许多超出基本XML文档表示的功能. 2.它使用接口和抽象基本类方法. 3.具有性能优异.灵活性好.功能强大和极端易用的特点. 4.是一个开放源码的文件 jar包:dom4j-1.6.1.jar 创建 book.xml: package com.example.xml.dom4j; import java.io.FileWriter; import org.dom4j.Document; import org.dom4j.Document
JS实现兼容各浏览器解析XML文档数据的方法

本文实例讲述了JS实现兼容各浏览器解析XML文档数据的方法.分享给大家供大家参考.具体分析如下: 网站上很多用JS解析XML文档的资料或多或少都有点问题, 以下是自己总结的代码,用来解析XML文档,兼容各个浏览器. parseXMLDOM.js代码: /* * 纯JS解析XML文档(兼容各个浏览器) */ function parseXMLDOM(){ var _browserType = ""; var _xmlFile = ""; var _XmlDom = n
解析php DOMElement 操作xml 文档的实现代码

复制代码代码如下: /*<?xml version="1.0" encoding="UTF-8" standalone="no"?> <?xml-stylesheet type="text/css" href="css.css"?><!-- 引入dtd文档定义文件 (根元素:班级)&l

C#对XmlHelper帮助类操作Xml文档的通用方法汇总

前言

C#XML基础入门

相关推荐

随机推荐