閱讀目錄

• 開始

• config檔案 - 自定義配置節點

• config檔案 - Property

• config檔案 - Element

• config檔案 - CDATA

• config檔案 - Collection

• config檔案 - 讀與寫

• 讀寫 .net framework中已經定義的節點

• xml配置檔案

• xml配置檔案 - CDATA

• xml檔案讀寫注意事項

• 配置引數的建議儲存方式

• config檔案與XML檔案的差別

今天談談在.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種自定義配置節點的方式，最終的配置檔案如下：

同時，我還提供所有的示例程式碼（文章結尾處可供下載），演示程式的介面如下：

回到頂部

config檔案 - Property

先來看最簡單的自定義節點，每個配置值以屬性方式存在：

實現程式碼如下：

public class MySection1 : ConfigurationSection{    [ConfigurationProperty("username", IsRequired = true)]    public string UserName    {        get { return this["username"].ToString(); }        set { this["username"] = value; }    }    [ConfigurationProperty("url", IsRequired = true)]    public string Url    {        get { return this["url"].ToString(); }        set { this["url"] = value; }    }}

小結：
1. 自定義一個類，以ConfigurationSection為基類，各個屬性要加上[ConfigurationProperty] ，ConfigurationProperty的建構函式中傳入的name字串將會用於config檔案中，表示各引數的屬性名稱。
2. 屬性的值的讀寫要呼叫this[]，由基類去儲存，請不要自行設計Field來儲存。
3. 為了能使用配置節點能被解析，需要在中註冊：

說明：下面將要介紹另三種配置節點，雖然複雜一點，但是一些基礎的東西與這個節點是一樣的，所以後面我就不再重複說明了。

回到頂部

config檔案 - Element

再來看個複雜點的，每個配置項以XML元素的方式存在：

實現程式碼如下：

public class MySection2 : ConfigurationSection{    [ConfigurationProperty("users", IsRequired = true)]    public MySectionElement Users    {        get { return (MySectionElement)this["users"]; }    }}public class MySectionElement : ConfigurationElement{    [ConfigurationProperty("username", IsRequired = true)]    public string UserName    {        get { return this["username"].ToString(); }        set { this["username"] = value; }    }    [ConfigurationProperty("password", IsRequired = true)]    public string Password    {        get { return this["password"].ToString(); }        set { this["password"] = value; }    }}

小結：
1. 自定義一個類，以ConfigurationSection為基類，各個屬性除了要加上[ConfigurationProperty]
2. 型別也是自定義的，具體的配置屬性寫在ConfigurationElement的繼承類中。

回到頂部

config檔案 - CDATA

有時配置引數包含較長的文字，比如：一段SQL指令碼，或者一段HTML程式碼，那麼，就需要CDATA節點了。假設要實現一個配置，包含二段SQL指令碼：

實現程式碼如下：

public class MySection3 : ConfigurationSection{    [ConfigurationProperty("Command1", IsRequired = true)]    public MyTextElement Command1    {        get { return (MyTextElement)this["Command1"]; }    }    [ConfigurationProperty("Command2", IsRequired = true)]    public MyTextElement Command2    {        get { return (MyTextElement)this["Command2"]; }    }}public class MyTextElement : ConfigurationElement{    protected override void DeserializeElement(System.Xml.XmlReader reader, bool serializeCollectionKey)    {        CommandText = reader.ReadElementContentAs(typeof(string), null) as string;    }    protected override bool SerializeElement(System.Xml.XmlWriter writer, bool serializeCollectionKey)    {        if( writer != null )            writer.WriteCData(CommandText);        return true;    }    [ConfigurationProperty("data", IsRequired = false)]    public string CommandText    {        get { return this["data"].ToString(); }        set { this["data"] = value; }    }}

小結：
1. 在實現上大體可參考MySection2，
2. 每個ConfigurationElement由我們來控制如何讀寫XML，也就是要過載方法SerializeElement，DeserializeElement

回到頂部

config檔案 - Collection

這種類似的配置方式，在ASP.NET的HttpHandler, HttpModule中太常見了，想不想知道如何實現它們？ 程式碼如下：

public class MySection4 : ConfigurationSection    // 所有配置節點都要選擇這個基類{    private static readonly ConfigurationProperty s_property        = new ConfigurationProperty(string.Empty, typeof(MyKeyValueCollection), null,                                         ConfigurationPropertyOptions.IsDefaultCollection);        [ConfigurationProperty("", Options = ConfigurationPropertyOptions.IsDefaultCollection)]    public MyKeyValueCollection KeyValues    {        get        {            return (MyKeyValueCollection)base[s_property];        }    }}[ConfigurationCollection(typeof(MyKeyValueSetting))]public class MyKeyValueCollection : ConfigurationElementCollection        // 自定義一個集合{    // 基本上，所有的方法都只要簡單地呼叫基類的實現就可以了。    public MyKeyValueCollection() : base(StringComparer.OrdinalIgnoreCase)    // 忽略大小寫    {    }    // 其實關鍵就是這個索引器。但它也是呼叫基類的實現，只是做下型別轉就行了。    new public MyKeyValueSetting this[string name]    {        get        {            return (MyKeyValueSetting)base.BaseGet(name);        }    }    // 下面二個方法中抽象類中必須要實現的。    protected override ConfigurationElement CreateNewElement()    {        return new MyKeyValueSetting();    }    protected override object GetElementKey(ConfigurationElement element)    {        return ((MyKeyValueSetting)element).Key;    }    // 說明：如果不需要在程式碼中修改集合，可以不實現Add, Clear, Remove    public void Add(MyKeyValueSetting setting)    {        this.BaseAdd(setting);    }    public void Clear()    {        base.BaseClear();    }    public void Remove(string name)    {        base.BaseRemove(name);    }}public class MyKeyValueSetting : ConfigurationElement    // 集合中的每個元素{    [ConfigurationProperty("key", IsRequired = true)]    public string Key    {        get { return this["key"].ToString(); }        set { this["key"] = value; }    }    [ConfigurationProperty("value", IsRequired = true)]    public string Value    {        get { return this["value"].ToString(); }        set { this["value"] = value; }    }}

小結：
1. 為每個集合中的引數項建立一個從ConfigurationElement繼承的派生類，可參考MySection1
2. 為集合建立一個從ConfigurationElementCollection繼承的集合類，具體在實現時主要就是呼叫基類的方法。
3. 在建立ConfigurationSection的繼承類時，建立一個表示集合的屬性就可以了，注意[ConfigurationProperty]的各引數。

回到頂部

config檔案 - 讀與寫

前面我逐個介紹了4種自定義的配置節點的實現類，下面再來看一下如何讀寫它們。

讀取配置引數：

MySection1 mySectioin1 = (MySection1)ConfigurationManager.GetSection("MySection111");txtUsername1.Text = mySectioin1.UserName;txtUrl1.Text = mySectioin1.Url;MySection2 mySectioin2 = (MySection2)ConfigurationManager.GetSection("MySection222");txtUsername2.Text = mySectioin2.Users.UserName;txtUrl2.Text = mySectioin2.Users.Password;MySection3 mySection3 = (MySection3)ConfigurationManager.GetSection("MySection333");txtCommand1.Text = mySection3.Command1.CommandText.Trim();txtCommand2.Text = mySection3.Command2.CommandText.Trim();MySection4 mySection4 = (MySection4)ConfigurationManager.GetSection("MySection444");txtKeyValues.Text = string.Join("rn",                        (from kv in mySection4.KeyValues.Cast()                         let s = string.Format("{0}={1}", kv.Key, kv.Value)                         select s).ToArray());

小結：在讀取自定節點時，我們需要呼叫ConfigurationManager.GetSection()得到配置節點，並轉換成我們定義的配置節點類，然後就可以按照強型別的方式來訪問了。

寫配置檔案：

Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);MySection1 mySectioin1 = config.GetSection("MySection111") as MySection1;mySectioin1.UserName = txtUsername1.Text.Trim();mySectioin1.Url = txtUrl1.Text.Trim();MySection2 mySection2 = config.GetSection("MySection222") as MySection2;mySection2.Users.UserName = txtUsername2.Text.Trim();mySection2.Users.Password = txtUrl2.Text.Trim();MySection3 mySection3 = config.GetSection("MySection333") as MySection3;mySection3.Command1.CommandText = txtCommand1.Text.Trim();mySection3.Command2.CommandText = txtCommand2.Text.Trim();MySection4 mySection4 = config.GetSection("MySection444") as MySection4;mySection4.KeyValues.Clear();(from s in txtKeyValues.Lines     let p = s.IndexOf('=')     where p > 0     select new MyKeyValueSetting { Key = s.Substring(0, p), Value = s.Substring(p + 1) }).ToList().ForEach(kv => mySection4.KeyValues.Add(kv));config.Save();

小結：在修改配置節點前，我們需要呼叫ConfigurationManager.OpenExeConfiguration()，然後呼叫config.GetSection()在得到節點後，轉成我們定義的節點型別，然後就可以按照強型別的方式來修改我們定義的各引數項，最後呼叫config.Save();即可。

注意：
1. .net為了最佳化配置節點的讀取操作，會將資料快取起來，如果希望使用修改後的結果生效，您還需要呼叫ConfigurationManager.RefreshSection(".....")
2. 如果是修改web.config，則需要使用 WebConfigurationManager

回到頂部

讀寫 .net framework中已經定義的節點

前面一直在演示自定義的節點，那麼如何讀取.net framework中已經定義的節點呢？

假如我想讀取下面配置節點中的發件人。

讀取配置引數：

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

寫配置檔案：

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

回到頂部

xml配置檔案

前面演示在config檔案中建立自定義配置節點的方法，那些方法也只適合在app.config或者web.config中，如果您的配置引數較多，或者打算將一些資料以配置檔案的形式單獨儲存，那麼，直接讀寫整個XML將會更方便。比如：我有一個實體類，我想將它儲存在XML檔案中，有可能是多條記錄，也可能是一條。
這次我來反過來說，假如我們先定義了XML的結構，是下面這個樣子的，那麼我將怎麼做呢？

                          insret into .....  

對於上面的這段XML結構，我們可以在C#中先定義下面的類，然後透過序列化及反序列化的方式來實現對它的讀寫。

C#類的定義如下：

public class MyCommand{    [XmlAttribute("Name")]    public string CommandName;    [XmlAttribute]    public string Database;    [XmlArrayItem("Parameter")]    public List Parameters = new List();    [XmlElement]    public string CommandText;}public class MyCommandParameter{    [XmlAttribute("Name")]    public string ParamName;    [XmlAttribute("Type")]    public string ParamType;}

有了這二個C#類，讀寫這段XML就非常容易了。以下就是相應的讀寫程式碼：

private void btnReadXml_Click(object sender, EventArgs e){    btnWriteXml_Click(null, null);        List list = XmlHelper.XmlDeserializeFromFile>(XmlFileName, Encoding.UTF8);    if( list.Count > 0 )        MessageBox.Show(list[0].CommandName + ": " + list[0].CommandText,            this.Text, MessageBoxButtons.OK, MessageBoxIcon.Information);}private void btnWriteXml_Click(object sender, EventArgs e){    MyCommand command = new MyCommand();    command.CommandName = "InsretCustomer";    command.Database = "MyTestDb";    command.CommandText = "insret into .....";    command.Parameters.Add(new MyCommandParameter { ParamName = "Name", ParamType = "DbType.String" });    command.Parameters.Add(new MyCommandParameter { ParamName = "Address", ParamType = "DbType.String" });    List list = new List(1);    list.Add(command);    XmlHelper.XmlSerializeToFile(list, XmlFileName, Encoding.UTF8);}

小結：
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的實現如下：

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 = "rn";        settings.Encoding = encoding;        settings.IndentChars = "    ";        using( XmlWriter writer = XmlWriter.Create(stream, settings) ) {            serializer.Serialize(writer, o);            writer.Close();        }    }    /// 
    /// 將一個物件序列化為XML字串    /// 
    /// 要序列化的物件    /// 編碼方式    /// 序列化產生的XML字串    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();            }        }    }    /// 
    /// 將一個物件按XML序列化的方式寫入到一個檔案    /// 
    /// 要序列化的物件    /// 儲存檔案路徑    /// 編碼方式    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);        }    }    /// 
    /// 從XML字串中反序列化物件    /// 
    /// 結果物件型別    /// 包含物件的XML字串    /// 編碼方式    /// 反序列化得到的物件    public static T XmlDeserialize(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);            }        }    }    /// 
    /// 讀入一個檔案，並按XML的方式反序列化物件。    /// 
    /// 結果物件型別    /// 檔案路徑    /// 編碼方式    /// 反序列化得到的物件    public static T XmlDeserializeFromFile(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(xml, encoding);    }}

回到頂部

xml配置檔案 - CDATA

在前面的演示中，有個不完美的地方，我將SQL指令碼以普通字串的形式輸出到XML中了：

insret into .....

顯然，現實中的SQL指令碼都是比較長的，而且還可能會包含一些特殊的字元，這種做法是不可取的，好的處理方式應該是將它以CDA他的形式儲存，為了實現這個目標，我們就不能直接按照普通字串的方式來處理了，這裡我定義了一個類 MyCDATA：

public class MyCDATA : IXmlSerializable{    private string _value;    public MyCDATA() { }    public MyCDATA(string value)    {        this._value = value;    }    public string Value    {        get { return _value; }    }    XmlSchema IXmlSerializable.GetSchema()    {        return null;    }    void IXmlSerializable.ReadXml(XmlReader reader)    {        this._value = reader.ReadElementContentAsString();    }    void IXmlSerializable.WriteXml(XmlWriter writer)    {        writer.WriteCData(this._value);    }    public override string ToString()    {        return this._value;    }    public static implicit operator MyCDATA(string text)    {        return new MyCDATA(text);    }}

我將使用這個類來控制CommandText在XML序列化及反序列化的行為，讓它寫成一個CDATA形式，因此，我還需要修改CommandText的定義，改成這個樣子：

public MyCDATA CommandText;

最終，得到的結果是：

回到頂部

xml檔案讀寫注意事項

通常，我們使用使用XmlSerializer.Serialize()得到的XML字串的開頭處，包含一段XML宣告元素：

由於各種原因，有時候可能不需要它。為了讓這行字元消失，我見過有使用正規表示式去刪除它的，也有直接分析字串去刪除它的。這些方法，要麼浪費程式效能，要麼就要多寫些奇怪的程式碼。總之，就是看起來很彆扭。其實，我們可以反過來想一下：能不能在序列化時，不輸出它呢？ 不輸出它，不就達到我們期望的目的了嗎？

在XML序列化時，有個XmlWriterSettings是用於控制寫XML的一些行為的，它有一個OmitXmlDeclaration屬性，就是專門用來控制要不要輸出那行XML宣告的。而且，這個XmlWriterSettings還有其它的一些常用屬性。請看以下演示程式碼：

using( MemoryStream stream = new MemoryStream() ) {    XmlWriterSettings settings = new XmlWriterSettings();    settings.Indent = true;    settings.NewLineChars = "rn";    settings.OmitXmlDeclaration = true;    settings.IndentChars = "t";    XmlWriter writer = XmlWriter.Create(stream, settings);

使用上面這段程式碼，我可以：
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時也能擁有那些優點呢？
我希望在使用者修改了配置檔案後，程式能立刻以最新的引數執行，而且不用重新網站。
如果希望知道這個答案，請關注我的後續部落格，我是Fish Li 。

本文的所有示例程式碼可以點選此處下載。

如果，您認為閱讀這篇部落格讓您有些收穫，不妨點選一下右下角的【推薦】按鈕。
如果，您希望更容易地發現我的新部落格，不妨點選一下右下角的【關注 Fish Li】。
因為，我的寫作熱情也離不開您的肯定支援。

感謝您的閱讀，如果您對我的部落格所講述的內容有興趣，請繼續關注我的後續部落格，我是Fish Li 。