• 在.net中读写config文件的各种方法


    阅读目录

      今天谈谈在.net中读写config文件的各种方法。 在这篇博客中,我将介绍各种配置文件的读写操作。 由于内容较为直观,因此没有过多的空道理,只有实实在在的演示代码, 目的只为了再现实战开发中的各种场景。希望大家能喜欢。

      通常,我们在.NET开发过程中,会接触二种类型的配置文件:config文件,xml文件。 今天的博客示例也将介绍这二大类的配置文件的各类操作。 在config文件中,我将主要演示如何创建自己的自定义的配置节点,而不是介绍如何使用appSetting 。

      请明:本文所说的config文件特指app.config或者web.config,而不是一般的XML文件。 在这类配置文件中,由于.net framework已经为它们定义了一些配置节点,因此我们并不能简单地通过序列化的方式去读写它。

    config文件 - 自定义配置节点

      为什么要自定义的配置节点? 确实,有很多人在使用config文件都是直接使用appSetting的,把所有的配置参数全都塞到那里,这样做虽然不错, 但是如果参数过多,这种做法的缺点也会明显地暴露出来:appSetting中的配置参数项只能按key名来访问,不能支持复杂的层次节点也不支持强类型, 而且由于全都只使用这一个集合,你会发现:完全不相干的参数也要放在一起!

      想摆脱这种困扰吗?自定义的配置节点将是解决这个问题的一种可行方法。

      首先,我们来看一下如何在app.config或者web.config中增加一个自定义的配置节点。 在这篇博客中,我将介绍4种自定义配置节点的方式,最终的配置文件如下:

     1 <?xml version="1.0" encoding="utf-8" ?>
     2 <configuration>
     3     <configSections>
     4         <section name="MySection111" type="RwConfigDemo.MySection1, RwConfigDemo" />
     5         <section name="MySection222" type="RwConfigDemo.MySection2, RwConfigDemo" />
     6         <section name="MySection333" type="RwConfigDemo.MySection3, RwConfigDemo" />
     7         <section name="MySection444" type="RwConfigDemo.MySection4, RwConfigDemo" />
     8     </configSections>
     9 
    10     <MySection111 username="fish-li" url="http://www.cnblogs.com/fish-li/"></MySection111>
    11 
    12     <MySection222>
    13         <users username="fish" password="liqifeng"></users>
    14     </MySection222>
    15 
    16     <MySection444>
    17         <add key="aa" value="11111"></add>
    18         <add key="bb" value="22222"></add>
    19         <add key="cc" value="33333"></add>
    20     </MySection444>
    21 
    22     <MySection333>
    23         <Command1>
    24             <![CDATA[
    25                 create procedure ChangeProductQuantity(
    26                     @ProductID int,
    27                     @Quantity int
    28                 )
    29                 as
    30                 update Products set Quantity = @Quantity 
    31                 where ProductID = @ProductID;
    32             ]]>
    33         </Command1>
    34         <Command2>
    35             <![CDATA[
    36                 create procedure DeleteCategory(
    37                     @CategoryID int
    38                 )
    39                 as
    40                 delete from Categories
    41                 where CategoryID = @CategoryID;
    42             ]]>
    43         </Command2>
    44     </MySection333>    
    45 </configuration>
    View Code

      同时,我还提供所有的示例代码(文章结尾处可供下载),演示程序的界面如下:

     

    回到顶部

    config文件 - Property

    先来看最简单的自定义节点,每个配置值以属性方式存在:

    <MySection111 username="fish-li" url="http://www.cnblogs.com/fish-li/"></MySection111>
    
    

    实现代码如下:

     1 public class MySection1 : ConfigurationSection
     2 {
     3     [ConfigurationProperty("username", IsRequired = true)]
     4     public string UserName
     5     {
     6         get { return this["username"].ToString(); }
     7         set { this["username"] = value; }
     8     }
     9 
    10     [ConfigurationProperty("url", IsRequired = true)]
    11     public string Url
    12     {
    13         get { return this["url"].ToString(); }
    14         set { this["url"] = value; }
    15     }
    16 }

    小结: 1. 自定义一个类,以ConfigurationSection为基类,各个属性要加上[ConfigurationProperty] ,ConfigurationProperty的构造函数中传入的name字符串将会用于config文件中,表示各参数的属性名称。 2. 属性的值的读写要调用this[],由基类去保存,请不要自行设计Field来保存。 3. 为了能使用配置节点能被解析,需要在<configSections>中注册:<section name="MySection111" type="RwConfigDemo.MySection1, RwConfigDemo" />,且要注意name="MySection111"要与<MySection111 ..... >是对应的。

    说明:下面将要介绍另三种配置节点,虽然复杂一点,但是一些基础的东西与这个节点是一样的,所以后面我就不再重复说明了。

     

    config文件 - Element

    再来看个复杂点的,每个配置项以XML元素的方式存在:

    <MySection222>
        <users username="fish" password="liqifeng"></users>
    </MySection222>
    

    实现代码如下:

     1 public class MySection2 : ConfigurationSection
     2 {
     3     [ConfigurationProperty("users", IsRequired = true)]
     4     public MySectionElement Users
     5     {
     6         get { return (MySectionElement)this["users"]; }
     7     }
     8 }
     9 
    10 public class MySectionElement : ConfigurationElement
    11 {
    12     [ConfigurationProperty("username", IsRequired = true)]
    13     public string UserName
    14     {
    15         get { return this["username"].ToString(); }
    16         set { this["username"] = value; }
    17     }
    18 
    19     [ConfigurationProperty("password", IsRequired = true)]
    20     public string Password
    21     {
    22         get { return this["password"].ToString(); }
    23         set { this["password"] = value; }
    24     }
    25 }
    View Code

    小结: 1. 自定义一个类,以ConfigurationSection为基类,各个属性除了要加上[ConfigurationProperty] 2. 类型也是自定义的,具体的配置属性写在ConfigurationElement的继承类中。

    config文件 - CDATA

    有时配置参数包含较长的文本,比如:一段SQL脚本,或者一段HTML代码,那么,就需要CDATA节点了。假设要实现一个配置,包含二段SQL脚本:

     1 <MySection333>
     2     <Command1>
     3         <![CDATA[
     4             create procedure ChangeProductQuantity(
     5                 @ProductID int,
     6                 @Quantity int
     7             )
     8             as
     9             update Products set Quantity = @Quantity 
    10             where ProductID = @ProductID;
    11         ]]>
    12     </Command1>
    13     <Command2>
    14         <![CDATA[
    15             create procedure DeleteCategory(
    16                 @CategoryID int
    17             )
    18             as
    19             delete from Categories
    20             where CategoryID = @CategoryID;
    21         ]]>
    22     </Command2>
    23 </MySection333>

    实现代码如下:

     1 public class MySection3 : ConfigurationSection
     2 {
     3     [ConfigurationProperty("Command1", IsRequired = true)]
     4     public MyTextElement Command1
     5     {
     6         get { return (MyTextElement)this["Command1"]; }
     7     }
     8 
     9     [ConfigurationProperty("Command2", IsRequired = true)]
    10     public MyTextElement Command2
    11     {
    12         get { return (MyTextElement)this["Command2"]; }
    13     }
    14 }
    15 
    16 public class MyTextElement : ConfigurationElement
    17 {
    18     protected override void DeserializeElement(System.Xml.XmlReader reader, bool serializeCollectionKey)
    19     {
    20         CommandText = reader.ReadElementContentAs(typeof(string), null) as string;
    21     }
    22     protected override bool SerializeElement(System.Xml.XmlWriter writer, bool serializeCollectionKey)
    23     {
    24         if( writer != null )
    25             writer.WriteCData(CommandText);
    26         return true;
    27     }
    28 
    29     [ConfigurationProperty("data", IsRequired = false)]
    30     public string CommandText
    31     {
    32         get { return this["data"].ToString(); }
    33         set { this["data"] = value; }
    34     }
    35 }
    View Code

    小结: 1. 在实现上大体可参考MySection2, 2. 每个ConfigurationElement由我们来控制如何读写XML,也就是要重载方法SerializeElement,DeserializeElement

    config文件 - Collection

    <MySection444>
        <add key="aa" value="11111"></add>
        <add key="bb" value="22222"></add>
        <add key="cc" value="33333"></add>
    </MySection444>
    
    

    这种类似的配置方式,在ASP.NET的HttpHandler, HttpModule中太常见了,想不想知道如何实现它们? 代码如下:

     1 public class MySection4 : ConfigurationSection    // 所有配置节点都要选择这个基类
     2 {
     3     private static readonly ConfigurationProperty s_property
     4         = new ConfigurationProperty(string.Empty, typeof(MyKeyValueCollection), null, 
     5                                         ConfigurationPropertyOptions.IsDefaultCollection);
     6     
     7     [ConfigurationProperty("", Options = ConfigurationPropertyOptions.IsDefaultCollection)]
     8     public MyKeyValueCollection KeyValues
     9     {
    10         get
    11         {
    12             return (MyKeyValueCollection)base[s_property];
    13         }
    14     }
    15 }
    16 
    17 
    18 [ConfigurationCollection(typeof(MyKeyValueSetting))]
    19 public class MyKeyValueCollection : ConfigurationElementCollection        // 自定义一个集合
    20 {
    21     // 基本上,所有的方法都只要简单地调用基类的实现就可以了。
    22 
    23     public MyKeyValueCollection() : base(StringComparer.OrdinalIgnoreCase)    // 忽略大小写
    24     {
    25     }
    26 
    27     // 其实关键就是这个索引器。但它也是调用基类的实现,只是做下类型转就行了。
    28     new public MyKeyValueSetting this[string name]
    29     {
    30         get
    31         {
    32             return (MyKeyValueSetting)base.BaseGet(name);
    33         }
    34     }
    35 
    36     // 下面二个方法中抽象类中必须要实现的。
    37     protected override ConfigurationElement CreateNewElement()
    38     {
    39         return new MyKeyValueSetting();
    40     }
    41     protected override object GetElementKey(ConfigurationElement element)
    42     {
    43         return ((MyKeyValueSetting)element).Key;
    44     }
    45 
    46     // 说明:如果不需要在代码中修改集合,可以不实现Add, Clear, Remove
    47     public void Add(MyKeyValueSetting setting)
    48     {
    49         this.BaseAdd(setting);
    50     }
    51     public void Clear()
    52     {
    53         base.BaseClear();
    54     }
    55     public void Remove(string name)
    56     {
    57         base.BaseRemove(name);
    58     }
    59 }
    60 
    61 public class MyKeyValueSetting : ConfigurationElement    // 集合中的每个元素
    62 {
    63     [ConfigurationProperty("key", IsRequired = true)]
    64     public string Key
    65     {
    66         get { return this["key"].ToString(); }
    67         set { this["key"] = value; }
    68     }
    69 
    70     [ConfigurationProperty("value", IsRequired = true)]
    71     public string Value
    72     {
    73         get { return this["value"].ToString(); }
    74         set { this["value"] = value; }
    75     }
    76 }
    View Code

    小结: 1. 为每个集合中的参数项创建一个从ConfigurationElement继承的派生类,可参考MySection1 2. 为集合创建一个从ConfigurationElementCollection继承的集合类,具体在实现时主要就是调用基类的方法。 3. 在创建ConfigurationSection的继承类时,创建一个表示集合的属性就可以了,注意[ConfigurationProperty]的各参数。

    config文件 - 读与写

    前面我逐个介绍了4种自定义的配置节点的实现类,下面再来看一下如何读写它们。

    读取配置参数:

     1 MySection1 mySectioin1 = (MySection1)ConfigurationManager.GetSection("MySection111");
     2 txtUsername1.Text = mySectioin1.UserName;
     3 txtUrl1.Text = mySectioin1.Url;
     4 
     5 
     6 MySection2 mySectioin2 = (MySection2)ConfigurationManager.GetSection("MySection222");
     7 txtUsername2.Text = mySectioin2.Users.UserName;
     8 txtUrl2.Text = mySectioin2.Users.Password;
     9 
    10 
    11 MySection3 mySection3 = (MySection3)ConfigurationManager.GetSection("MySection333");
    12 txtCommand1.Text = mySection3.Command1.CommandText.Trim();
    13 txtCommand2.Text = mySection3.Command2.CommandText.Trim();
    14 
    15 
    16 MySection4 mySection4 = (MySection4)ConfigurationManager.GetSection("MySection444");
    17 txtKeyValues.Text = string.Join("\r\n",
    18                         (from kv in mySection4.KeyValues.Cast<MyKeyValueSetting>()
    19                          let s = string.Format("{0}={1}", kv.Key, kv.Value)
    20                          select s).ToArray());
    View Code

    小结:在读取自定节点时,我们需要调用ConfigurationManager.GetSection()得到配置节点,并转换成我们定义的配置节点类,然后就可以按照强类型的方式来访问了。

    写配置文件:

     1 Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
     2 
     3 MySection1 mySectioin1 = config.GetSection("MySection111") as MySection1;
     4 mySectioin1.UserName = txtUsername1.Text.Trim();
     5 mySectioin1.Url = txtUrl1.Text.Trim();
     6 
     7 MySection2 mySection2 = config.GetSection("MySection222") as MySection2;
     8 mySection2.Users.UserName = txtUsername2.Text.Trim();
     9 mySection2.Users.Password = txtUrl2.Text.Trim();
    10 
    11 MySection3 mySection3 = config.GetSection("MySection333") as MySection3;
    12 mySection3.Command1.CommandText = txtCommand1.Text.Trim();
    13 mySection3.Command2.CommandText = txtCommand2.Text.Trim();
    14 
    15 MySection4 mySection4 = config.GetSection("MySection444") as MySection4;
    16 mySection4.KeyValues.Clear();
    17 
    18 (from s in txtKeyValues.Lines
    19      let p = s.IndexOf('=')
    20      where p > 0
    21      select new MyKeyValueSetting { Key = s.Substring(0, p), Value = s.Substring(p + 1) }
    22 ).ToList()
    23 .ForEach(kv => mySection4.KeyValues.Add(kv));
    24 
    25 config.Save();
    View Code

    小结:在修改配置节点前,我们需要调用ConfigurationManager.OpenExeConfiguration(),然后调用config.GetSection()在得到节点后,转成我们定义的节点类型, 然后就可以按照强类型的方式来修改我们定义的各参数项,最后调用config.Save();即可。

    注意: 1. .net为了优化配置节点的读取操作,会将数据缓存起来,如果希望使用修改后的结果生效,您还需要调用ConfigurationManager.RefreshSection(".....") 2. 如果是修改web.config,则需要使用 WebConfigurationManager

     

    读写 .net framework中已经定义的节点

    前面一直在演示自定义的节点,那么如何读取.net framework中已经定义的节点呢?

    假如我想读取下面配置节点中的发件人。

    1 <system.net>
    2     <mailSettings>
    3         <smtp from="Fish.Q.Li@newegg.com">
    4             <network />
    5         </smtp>
    6     </mailSettings>
    7 </system.net>

    读取配置参数:

    1 SmtpSection section = ConfigurationManager.GetSection("system.net/mailSettings/smtp") as SmtpSection;
    2 labMailFrom.Text = "Mail From: " + section.From;

    写配置文件:

    1 Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
    2 SmtpSection section = config.GetSection("system.net/mailSettings/smtp") as SmtpSection;
    3 section.From = "Fish.Q.Li@newegg.com2";
    4 
    5 config.Save();

    xml配置文件

    前面演示在config文件中创建自定义配置节点的方法,那些方法也只适合在app.config或者web.config中,如果您的配置参数较多, 或者打算将一些数据以配置文件的形式单独保存,那么,直接读写整个XML将会更方便。 比如:我有一个实体类,我想将它保存在XML文件中,有可能是多条记录,也可能是一条。 这次我来反过来说,假如我们先定义了XML的结构,是下面这个样子的,那么我将怎么做呢?

     1 <?xml version="1.0" encoding="utf-8"?>
     2 <ArrayOfMyCommand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     3                   xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     4   <MyCommand Name="InsretCustomer" Database="MyTestDb">
     5     <Parameters>
     6       <Parameter Name="Name" Type="DbType.String" />
     7       <Parameter Name="Address" Type="DbType.String" />
     8     </Parameters>
     9     <CommandText>insret into .....</CommandText>
    10   </MyCommand>
    11 </ArrayOfMyCommand>

    对于上面的这段XML结构,我们可以在C#中先定义下面的类,然后通过序列化及反序列化的方式来实现对它的读写。

    C#类的定义如下:

     1 public class MyCommand
     2 {
     3     [XmlAttribute("Name")]
     4     public string CommandName;
     5 
     6     [XmlAttribute]
     7     public string Database;
     8 
     9     [XmlArrayItem("Parameter")]
    10     public List<MyCommandParameter> Parameters = new List<MyCommandParameter>();
    11 
    12     [XmlElement]
    13     public string CommandText;
    14 }
    15 
    16 public class MyCommandParameter
    17 {
    18     [XmlAttribute("Name")]
    19     public string ParamName;
    20 
    21     [XmlAttribute("Type")]
    22     public string ParamType;
    23 }

    有了这二个C#类,读写这段XML就非常容易了。以下就是相应的读写代码:

     1 private void btnReadXml_Click(object sender, EventArgs e)
     2 {
     3     btnWriteXml_Click(null, null);
     4     
     5     List<MyCommand> list = XmlHelper.XmlDeserializeFromFile<List<MyCommand>>(XmlFileName, Encoding.UTF8);
     6 
     7     if( list.Count > 0 )
     8         MessageBox.Show(list[0].CommandName + ": " + list[0].CommandText,
     9             this.Text, MessageBoxButtons.OK, MessageBoxIcon.Information);
    10 
    11 }
    12 
    13 private void btnWriteXml_Click(object sender, EventArgs e)
    14 {
    15     MyCommand command = new MyCommand();
    16     command.CommandName = "InsretCustomer";
    17     command.Database = "MyTestDb";
    18     command.CommandText = "insret into .....";
    19     command.Parameters.Add(new MyCommandParameter { ParamName = "Name", ParamType = "DbType.String" });
    20     command.Parameters.Add(new MyCommandParameter { ParamName = "Address", ParamType = "DbType.String" });
    21 
    22     List<MyCommand> list = new List<MyCommand>(1);
    23     list.Add(command);
    24 
    25     XmlHelper.XmlSerializeToFile(list, XmlFileName, Encoding.UTF8);
    26 }
    View Code

    小结: 1. 读写整个XML最方便的方法是使用序列化反序列化。 2. 如果您希望某个参数以Xml Property的形式出现,那么需要使用[XmlAttribute]修饰它。 3. 如果您希望某个参数以Xml Element的形式出现,那么需要使用[XmlElement]修饰它。 4. 如果您希望为某个List的项目指定ElementName,则需要[XmlArrayItem] 5. 以上3个Attribute都可以指定在XML中的映射别名。 6. 写XML的操作是通过XmlSerializer.Serialize()来实现的。 7. 读取XML文件是通过XmlSerializer.Deserialize来实现的。 8. List或Array项,请不要使用[XmlElement],否则它们将以内联的形式提升到当前类,除非你再定义一个容器类。

    XmlHelper的实现如下:

     1 public static class XmlHelper
     2 {
     3     private static void XmlSerializeInternal(Stream stream, object o, Encoding encoding)
     4     {
     5         if( o == null )
     6             throw new ArgumentNullException("o");
     7         if( encoding == null )
     8             throw new ArgumentNullException("encoding");
     9 
    10         XmlSerializer serializer = new XmlSerializer(o.GetType());
    11 
    12         XmlWriterSettings settings = new XmlWriterSettings();
    13         settings.Indent = true;
    14         settings.NewLineChars = "\r\n";
    15         settings.Encoding = encoding;
    16         settings.IndentChars = "    ";
    17 
    18         using( XmlWriter writer = XmlWriter.Create(stream, settings) ) {
    19             serializer.Serialize(writer, o);
    20             writer.Close();
    21         }
    22     }
    23 
    24     /// <summary>
    25     /// 将一个对象序列化为XML字符串
    26     /// </summary>
    27     /// <param name="o">要序列化的对象</param>
    28     /// <param name="encoding">编码方式</param>
    29     /// <returns>序列化产生的XML字符串</returns>
    30     public static string XmlSerialize(object o, Encoding encoding)
    31     {
    32         using( MemoryStream stream = new MemoryStream() ) {
    33             XmlSerializeInternal(stream, o, encoding);
    34 
    35             stream.Position = 0;
    36             using( StreamReader reader = new StreamReader(stream, encoding) ) {
    37                 return reader.ReadToEnd();
    38             }
    39         }
    40     }
    41 
    42     /// <summary>
    43     /// 将一个对象按XML序列化的方式写入到一个文件
    44     /// </summary>
    45     /// <param name="o">要序列化的对象</param>
    46     /// <param name="path">保存文件路径</param>
    47     /// <param name="encoding">编码方式</param>
    48     public static void XmlSerializeToFile(object o, string path, Encoding encoding)
    49     {
    50         if( string.IsNullOrEmpty(path) )
    51             throw new ArgumentNullException("path");
    52 
    53         using( FileStream file = new FileStream(path, FileMode.Create, FileAccess.Write) ) {
    54             XmlSerializeInternal(file, o, encoding);
    55         }
    56     }
    57 
    58     /// <summary>
    59     /// 从XML字符串中反序列化对象
    60     /// </summary>
    61     /// <typeparam name="T">结果对象类型</typeparam>
    62     /// <param name="s">包含对象的XML字符串</param>
    63     /// <param name="encoding">编码方式</param>
    64     /// <returns>反序列化得到的对象</returns>
    65     public static T XmlDeserialize<T>(string s, Encoding encoding)
    66     {
    67         if( string.IsNullOrEmpty(s) )
    68             throw new ArgumentNullException("s");
    69         if( encoding == null )
    70             throw new ArgumentNullException("encoding");
    71 
    72         XmlSerializer mySerializer = new XmlSerializer(typeof(T));
    73         using( MemoryStream ms = new MemoryStream(encoding.GetBytes(s)) ) {
    74             using( StreamReader sr = new StreamReader(ms, encoding) ) {
    75                 return (T)mySerializer.Deserialize(sr);
    76             }
    77         }
    78     }
    79 
    80     /// <summary>
    81     /// 读入一个文件,并按XML的方式反序列化对象。
    82     /// </summary>
    83     /// <typeparam name="T">结果对象类型</typeparam>
    84     /// <param name="path">文件路径</param>
    85     /// <param name="encoding">编码方式</param>
    86     /// <returns>反序列化得到的对象</returns>
    87     public static T XmlDeserializeFromFile<T>(string path, Encoding encoding)
    88     {
    89         if( string.IsNullOrEmpty(path) )
    90             throw new ArgumentNullException("path");
    91         if( encoding == null )
    92             throw new ArgumentNullException("encoding");
    93 
    94         string xml = File.ReadAllText(path, encoding);
    95         return XmlDeserialize<T>(xml, encoding);
    96     }
    97 }
    View Code

     回到顶部

    xml配置文件 - CDATA

    在前面的演示中,有个不完美的地方,我将SQL脚本以普通字符串的形式输出到XML中了:

    <CommandText>insret into .....</CommandText>
    
    

    显然,现实中的SQL脚本都是比较长的,而且还可能会包含一些特殊的字符,这种做法是不可取的,好的处理方式应该是将它以CDATA的形式保存, 为了实现这个目标,我们就不能直接按照普通字符串的方式来处理了,这里我定义了一个类 MyCDATA:

     1 public class MyCDATA : IXmlSerializable
     2 {
     3     private string _value;
     4 
     5     public MyCDATA() { }
     6 
     7     public MyCDATA(string value)
     8     {
     9         this._value = value;
    10     }
    11 
    12     public string Value
    13     {
    14         get { return _value; }
    15     }
    16 
    17     XmlSchema IXmlSerializable.GetSchema()
    18     {
    19         return null;
    20     }
    21 
    22     void IXmlSerializable.ReadXml(XmlReader reader)
    23     {
    24         this._value = reader.ReadElementContentAsString();
    25     }
    26 
    27     void IXmlSerializable.WriteXml(XmlWriter writer)
    28     {
    29         writer.WriteCData(this._value);
    30     }
    31 
    32     public override string ToString()
    33     {
    34         return this._value;
    35     }
    36 
    37     public static implicit operator MyCDATA(string text)
    38     {
    39         return new MyCDATA(text);
    40     }
    41 }
    View Code

    我将使用这个类来控制CommandText在XML序列化及反序列化的行为,让它写成一个CDATA形式, 因此,我还需要修改CommandText的定义,改成这个样子:

    public MyCDATA CommandText;
    
    

    最终,得到的结果是:

     1 <?xml version="1.0" encoding="utf-8"?>
     2 <ArrayOfMyCommand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     3                   xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     4   <MyCommand Name="InsretCustomer" Database="MyTestDb">
     5     <Parameters>
     6       <Parameter Name="Name" Type="DbType.String" />
     7       <Parameter Name="Address" Type="DbType.String" />
     8     </Parameters>
     9     <CommandText><![CDATA[insret into .....]]></CommandText>
    10   </MyCommand>
    11 </ArrayOfMyCommand>

    xml文件读写注意事项

    通常,我们使用使用XmlSerializer.Serialize()得到的XML字符串的开头处,包含一段XML声明元素:

    <?xml version="1.0" encoding="utf-8"?>
    
    

    由于各种原因,有时候可能不需要它。为了让这行字符消失,我见过有使用正则表达式去删除它的,也有直接分析字符串去删除它的。 这些方法,要么浪费程序性能,要么就要多写些奇怪的代码。总之,就是看起来很别扭。 其实,我们可以反过来想一下:能不能在序列化时,不输出它呢? 不输出它,不就达到我们期望的目的了吗?

    在XML序列化时,有个XmlWriterSettings是用于控制写XML的一些行为的,它有一个OmitXmlDeclaration属性,就是专门用来控制要不要输出那行XML声明的。 而且,这个XmlWriterSettings还有其它的一些常用属性。请看以下演示代码:

    1 using( MemoryStream stream = new MemoryStream() ) {
    2     XmlWriterSettings settings = new XmlWriterSettings();
    3     settings.Indent = true;
    4     settings.NewLineChars = "\r\n";
    5     settings.OmitXmlDeclaration = true;
    6     settings.IndentChars = "\t";
    7     XmlWriter writer = XmlWriter.Create(stream, settings);
    8 }

    使用上面这段代码,我可以: 1. 不输出XML声明。 2. 指定换行符。 3. 指定缩进字符。 如果不使用这个类,恐怕还真的不能控制XmlSerializer.Serialize()的行为。

      前面介绍了读写XML的方法,可是,如何开始呢? 由于没有XML文件,程序也没法读取,那么如何得到一个格式正确的XML呢? 答案是:先写代码,创建一个要读取的对象,随便输入一些垃圾数据,然后将它写入XML(反序列化), 然后,我们可以参考生成的XML文件的具体格式,或者新增其它的节点(列表), 或者修改前面所说的垃圾数据,最终得到可以使用的,有着正确格式的XML文件。

    配置参数的建议保存方式

    经常见到有很多组件或者框架,都喜欢把配置参数放在config文件中, 那些设计者或许认为他们的作品的参数较复杂,还喜欢搞自定义的配置节点。 结果就是:config文件中一大堆的配置参数。最麻烦的是:下次其它项目还要使用这个东西时,还得继续配置!

    .net一直提倡XCOPY,但我发现遵守这个约定的组件或者框架还真不多。 所以,我想建议大家在设计组件或者框架的时候: 1. 请不要把你们的参数放在config文件中,那种配置真的不方便【复用】。 2. 能不能同时提供配置文件以及API接口的方式公开参数,由用户来决定如何选择配置参数的保存方式。

    config文件与XML文件的差别

    从本质上说,config文件也是XML文件,但它们有一点差别,不仅仅是因为.net framework为config文件预定义了许多配置节。 对于ASP.NET应用程序来说,如果我们将参数放在web.config中,那么,只要修改了web.config,网站也将会重新启动, 此时有一个好处:我们的代码总是能以最新的参数运行。另一方面,也有一个坏处:或许由于种种原因,我们并不希望网站被重启, 毕竟重启网站会花费一些时间,这会影响网站的响应。 对于这个特性,我只能说,没有办法,web.config就是这样。

    然而,当我们使用XML时,显然不能直接得到以上所说的特性。因为XML文件是由我们自己来维护的。

    到这里,您有没有想过:我如何在使用XML时也能拥有那些优点呢? 我希望在用户修改了配置文件后,程序能立刻以最新的参数运行,而且不用重新网站。

    回到顶部

  • 相关阅读:
    selenium(六)Page Object模式(使用selenium的PageFactory)
    CodeForces 1325C Ehab and Path-etic MEXs(思维)
    CodeForces 1325D Ehab the Xorcist(异或和+算数和)
    家庭房产(模拟)
    取硬币(思维)
    Xor and Sum(异或和+算术和)
    一元三次方程求解(数学、二分)
    最大最小公倍数 (数学、贪心)
    天梯---球队“食物链”(DFS+剪枝)
    HDU-4857 逃生(逆向拓扑排序)
  • 原文地址:https://www.cnblogs.com/powerzhang/p/3130519.html
Copyright © 2020-2023  润新知