阅读目录

XML是一种很常见的数据保存方式，我经常用它来保存一些数据，或者是一些配置参数。使用C#，我们可以借助.net framework提供的很多API来读取或者创建修改这些XML，然而，不同人使用XML的方法很有可能并不相同。今天我打算谈谈我使用XML的一些方法，供大家参考。

最简单的使用XML的方法

由于.net framework针对XML提供了很多API，这些API根据不同的使用场景实现了不同层次的封装，比如，我们可以直接使用XmlTextReader、XmlDocument、XPath来取数XML中的数据，也可以使用LINQ TO XML或者反序列化的方法从XML中读取数据。那么，使用哪种方法最简单呢？

我个人倾向于使用序列化，反序列化的方法来使用XML。 采用这种方法，我只要考虑如何定义数据类型就可以了，读写XML各只需要一行调用即可完成。例如：

// 1. 首先要创建或者得到一个数据对象

Order order = GetOrderById(123);

// 2. 用序列化的方法生成XML

string xml = XmlHelper.XmlSerialize(order, Encoding.UTF8);

// 3. 从XML读取数据并生成对象

Order order2 = XmlHelper.XmlDeserialize<Order>(xml, Encoding.UTF8);

就是这么简单的事情，XML结构是什么样的，我根本不用关心，我只关心数据是否能保存以及下次是否能将它们读取出来。

说明：XmlHelper是一个工具类，全部源代码如下：

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Xml.Serialization;

using System.IO;

using System.Xml;

// 此处代码来源于博客【在.net中读写config文件的各种方法】的示例代码

// http://www.cnblogs.com/fish-li/archive/2011/12/18/2292037.html

namespace MyMVC

{

    public static class XmlHelper

    {

        private static void XmlSerializeInternal(Stream stream, object o, Encoding encoding)

        {

            if( o == null )

                throw new ArgumentNullException("o");

            if( encoding == null )

                throw new ArgumentNullException("encoding");

            XmlSerializer serializer = new XmlSerializer(o.GetType());

            XmlWriterSettings settings = new XmlWriterSettings();

            settings.Indent = true;

            settings.NewLineChars = "\r\n";

            settings.Encoding = encoding;

            settings.IndentChars = "    ";

            using( XmlWriter writer = XmlWriter.Create(stream, settings) ) {

                serializer.Serialize(writer, o);

                writer.Close();

            }

        }

        /// <summary>

        /// 将一个对象序列化为XML字符串

        /// </summary>

        /// <param name="o">要序列化的对象</param>

        /// <param name="encoding">编码方式</param>

        /// <returns>序列化产生的XML字符串</returns>

        public static string XmlSerialize(object o, Encoding encoding)

        {

            using( MemoryStream stream = new MemoryStream() ) {

                XmlSerializeInternal(stream, o, encoding);

                stream.Position = 0;

                using( StreamReader reader = new StreamReader(stream, encoding) ) {

                    return reader.ReadToEnd();

                }

            }

        }

        /// <summary>

        /// 将一个对象按XML序列化的方式写入到一个文件

        /// </summary>

        /// <param name="o">要序列化的对象</param>

        /// <param name="path">保存文件路径</param>

        /// <param name="encoding">编码方式</param>

        public static void XmlSerializeToFile(object o, string path, Encoding encoding)

        {

            if( string.IsNullOrEmpty(path) )

                throw new ArgumentNullException("path");

            using( FileStream file = new FileStream(path, FileMode.Create, FileAccess.Write) ) {

                XmlSerializeInternal(file, o, encoding);

            }

        }

        /// <summary>

        /// 从XML字符串中反序列化对象

        /// </summary>

        /// <typeparam name="T">结果对象类型</typeparam>

        /// <param name="s">包含对象的XML字符串</param>

        /// <param name="encoding">编码方式</param>

        /// <returns>反序列化得到的对象</returns>

        public static T XmlDeserialize<T>(string s, Encoding encoding)

        {

            if( string.IsNullOrEmpty(s) )

                throw new ArgumentNullException("s");

            if( encoding == null )

                throw new ArgumentNullException("encoding");

            XmlSerializer mySerializer = new XmlSerializer(typeof(T));

            using( MemoryStream ms = new MemoryStream(encoding.GetBytes(s)) ) {

                using( StreamReader sr = new StreamReader(ms, encoding) ) {

                    return (T)mySerializer.Deserialize(sr);

                }

            }

        }

        /// <summary>

        /// 读入一个文件，并按XML的方式反序列化对象。

        /// </summary>

        /// <typeparam name="T">结果对象类型</typeparam>

        /// <param name="path">文件路径</param>

        /// <param name="encoding">编码方式</param>

        /// <returns>反序列化得到的对象</returns>

        public static T XmlDeserializeFromFile<T>(string path, Encoding encoding)

        {

            if( string.IsNullOrEmpty(path) )

                throw new ArgumentNullException("path");

            if( encoding == null )

                throw new ArgumentNullException("encoding");

            string xml = File.ReadAllText(path, encoding);

            return XmlDeserialize<T>(xml, encoding);

        }

    }

}

或许有人会说：我使用XPath从XML读取数据也很简单啊。我认为这种说法有一个限制条件：只需要从XML中读取少量的数据。如果要全部读取，用这种方法会写出一大堆的机械代码出来！所以，我非常反感用这种方法从XML中读取全部数据。

XML形式	处理方法	补充说明
XmlElement	定义一个属性	属性名与节点名字匹配
XmlAttribute	[XmlAttribute] 加到属性上
InnerText	[XmlText] 加到属性上	一个类型只能使用一次
节点重命名	根节点：[XmlType("testClass")] 元素节点：[XmlElement("name")] 属性节点：[XmlAttribute("id")] 列表子元素节点：[XmlArrayItem("Detail")] 列表元素自身：[XmlArray("Items")]

C#_在.net中序列化读写xml方法的总结

最简单的使用XML的方法

类型定义与XML结构的映射

使用 XmlElement

使用 XmlAttribute

使用 InnerText

重命名节点名称

列表和数组的序列化

列表和数组的做为数据成员的序列化

类型继承与反序列化

反序列化的实战演练

反序列化的使用总结

排除不需要序列化的成员

强制指定成员的序列化顺序

自定义序列化行为

序列化去掉XML命名空间及声明头

XML的使用建议

C#_在.net中序列化读写xml方法的总结的更多相关文章

随机推荐

热门专题