在.net中读写config文件的各种方法（转载）
閱讀目錄
- 開始
- config文件 - 自定義配置節(jié)點(diǎn)
- config文件 - Property
- config文件 - Element
- config文件 - CDATA
- config文件 - Collection
- config文件 - 讀與寫
- 讀寫 .net framework中已經(jīng)定義的節(jié)點(diǎn)
- xml配置文件
- xml配置文件 - CDATA
- xml文件讀寫注意事項(xiàng)
- 配置參數(shù)的建議保存方式
- config文件與XML文件的差別
今天談?wù)勗?net中讀寫config文件的各種方法。 在這篇博客中，我將介紹各種配置文件的讀寫操作。 由于內(nèi)容較為直觀，因此沒有過多的空道理，只有實(shí)實(shí)在在的演示代碼， 目的只為了再現(xiàn)實(shí)戰(zhàn)開發(fā)中的各種場景。希望大家能喜歡。
通常，我們在.NET開發(fā)過程中，會接觸二種類型的配置文件：config文件，xml文件。 今天的博客示例也將介紹這二大類的配置文件的各類操作。 在config文件中，我將主要演示如何創(chuàng)建自己的自定義的配置節(jié)點(diǎn)，而不是介紹如何使用appSetting 。
請明：本文所說的config文件特指app.config或者web.config，而不是一般的XML文件。 在這類配置文件中，由于.net framework已經(jīng)為它們定義了一些配置節(jié)點(diǎn)，因此我們并不能簡單地通過序列化的方式去讀寫它。
回到頂部config文件 - 自定義配置節(jié)點(diǎn)
為什么要自定義的配置節(jié)點(diǎn)？
確實(shí)，有很多人在使用config文件都是直接使用appSetting的，把所有的配置參數(shù)全都塞到那里，這樣做雖然不錯， 但是如果參數(shù)過多，這種做法的缺點(diǎn)也會明顯地暴露出來：appSetting中的配置參數(shù)項(xiàng)只能按key名來訪問，不能支持復(fù)雜的層次節(jié)點(diǎn)也不支持強(qiáng)類型， 而且由于全都只使用這一個集合，你會發(fā)現(xiàn)：完全不相干的參數(shù)也要放在一起！
想擺脫這種困擾嗎？自定義的配置節(jié)點(diǎn)將是解決這個問題的一種可行方法。
首先，我們來看一下如何在app.config或者web.config中增加一個自定義的配置節(jié)點(diǎn)。 在這篇博客中，我將介紹4種自定義配置節(jié)點(diǎn)的方式，最終的配置文件如下：
<?xml version="1.0" encoding="utf-8" ?> <configuration><configSections><section name="MySection111" type="RwConfigDemo.MySection1, RwConfigDemo" /><section name="MySection222" type="RwConfigDemo.MySection2, RwConfigDemo" /><section name="MySection333" type="RwConfigDemo.MySection3, RwConfigDemo" /><section name="MySection444" type="RwConfigDemo.MySection4, RwConfigDemo" /></configSections><MySection111 username="fish-li" url="http://www.cnblogs.com/fish-li/"></MySection111><MySection222><users username="fish" password="liqifeng"></users></MySection222><MySection444><add key="aa" value="11111"></add><add key="bb" value="22222"></add><add key="cc" value="33333"></add></MySection444><MySection333><Command1><![CDATA[create procedure ChangeProductQuantity(@ProductID int,@Quantity int)asupdate Products set Quantity = @Quantity where ProductID = @ProductID;]]></Command1><Command2><![CDATA[create procedure DeleteCategory(@CategoryID int)asdelete from Categorieswhere CategoryID = @CategoryID;]]></Command2></MySection333> </configuration>同時，我還提供所有的示例代碼（文章結(jié)尾處可供下載），演示程序的界面如下：
回到頂部config文件 - Property
先來看最簡單的自定義節(jié)點(diǎn)，每個配置值以屬性方式存在：
<MySection111 username="fish-li" url="http://www.cnblogs.com/fish-li/"></MySection111>實(shí)現(xiàn)代碼如下：
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; }} }小結(jié)：
1. 自定義一個類，以ConfigurationSection為基類，各個屬性要加上[ConfigurationProperty] ，ConfigurationProperty的構(gòu)造函數(shù)中傳入的name字符串將會用于config文件中，表示各參數(shù)的屬性名稱。
2. 屬性的值的讀寫要調(diào)用this[]，由基類去保存，請不要自行設(shè)計(jì)Field來保存。
3. 為了能使用配置節(jié)點(diǎn)能被解析，需要在<configSections>中注冊：?<section?name="MySection111"?type="RwConfigDemo.MySection1, RwConfigDemo"?/>?，且要注意name="MySection111"要與<MySection111 ..... >是對應(yīng)的。
說明：下面將要介紹另三種配置節(jié)點(diǎn)，雖然復(fù)雜一點(diǎn)，但是一些基礎(chǔ)的東西與這個節(jié)點(diǎn)是一樣的，所以后面我就不再重復(fù)說明了。
回到頂部config文件 - Element
再來看個復(fù)雜點(diǎn)的，每個配置項(xiàng)以XML元素的方式存在：
<MySection222><users username="fish" password="liqifeng"></users> </MySection222>實(shí)現(xiàn)代碼如下：
小結(jié)：
1. 自定義一個類，以ConfigurationSection為基類，各個屬性除了要加上[ConfigurationProperty]?
2. 類型也是自定義的，具體的配置屬性寫在ConfigurationElement的繼承類中。
config文件 - CDATA
有時配置參數(shù)包含較長的文本，比如：一段SQL腳本，或者一段HTML代碼，那么，就需要CDATA節(jié)點(diǎn)了。假設(shè)要實(shí)現(xiàn)一個配置，包含二段SQL腳本：
<MySection333><Command1><![CDATA[create procedure ChangeProductQuantity(@ProductID int,@Quantity int)asupdate Products set Quantity = @Quantity where ProductID = @ProductID;]]></Command1><Command2><![CDATA[create procedure DeleteCategory(@CategoryID int)asdelete from Categorieswhere CategoryID = @CategoryID;]]></Command2> </MySection333>實(shí)現(xiàn)代碼如下：
小結(jié)：
1. 在實(shí)現(xiàn)上大體可參考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中太常見了，想不想知道如何實(shí)現(xiàn)它們？ 代碼如下：?
小結(jié)：
1. 為每個集合中的參數(shù)項(xiàng)創(chuàng)建一個從ConfigurationElement繼承的派生類，可參考MySection1
2. 為集合創(chuàng)建一個從ConfigurationElementCollection繼承的集合類，具體在實(shí)現(xiàn)時主要就是調(diào)用基類的方法。
3. 在創(chuàng)建ConfigurationSection的繼承類時，創(chuàng)建一個表示集合的屬性就可以了，注意[ConfigurationProperty]的各參數(shù)。
config文件 - 讀與寫
前面我逐個介紹了4種自定義的配置節(jié)點(diǎn)的實(shí)現(xiàn)類，下面再來看一下如何讀寫它們。
讀取配置參數(shù)：
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("\r\n",(from kv in mySection4.KeyValues.Cast<MyKeyValueSetting>()let s = string.Format("{0}={1}", kv.Key, kv.Value)select s).ToArray());小結(jié)：在讀取自定節(jié)點(diǎn)時，我們需要調(diào)用ConfigurationManager.GetSection()得到配置節(jié)點(diǎn)，并轉(zhuǎn)換成我們定義的配置節(jié)點(diǎn)類，然后就可以按照強(qiáng)類型的方式來訪問了。
寫配置文件：
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.Lineslet p = s.IndexOf('=')where p > 0select new MyKeyValueSetting { Key = s.Substring(0, p), Value = s.Substring(p + 1) } ).ToList() .ForEach(kv => mySection4.KeyValues.Add(kv));config.Save();小結(jié)：在修改配置節(jié)點(diǎn)前，我們需要調(diào)用ConfigurationManager.OpenExeConfiguration()，然后調(diào)用config.GetSection()在得到節(jié)點(diǎn)后，轉(zhuǎn)成我們定義的節(jié)點(diǎn)類型， 然后就可以按照強(qiáng)類型的方式來修改我們定義的各參數(shù)項(xiàng)，最后調(diào)用config.Save();即可。
注意：
1. .net為了優(yōu)化配置節(jié)點(diǎn)的讀取操作，會將數(shù)據(jù)緩存起來，如果希望使用修改后的結(jié)果生效，您還需要調(diào)用ConfigurationManager.RefreshSection(".....")
2. 如果是修改web.config，則需要使用 WebConfigurationManager
讀寫 .net framework中已經(jīng)定義的節(jié)點(diǎn)
前面一直在演示自定義的節(jié)點(diǎn)，那么如何讀取.net framework中已經(jīng)定義的節(jié)點(diǎn)呢？
假如我想讀取下面配置節(jié)點(diǎn)中的發(fā)件人。
<system.net><mailSettings><smtp from="Fish.Q.Li@newegg.com"><network /></smtp></mailSettings> </system.net>讀取配置參數(shù)：
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文件中創(chuàng)建自定義配置節(jié)點(diǎn)的方法，那些方法也只適合在app.config或者web.config中，如果您的配置參數(shù)較多， 或者打算將一些數(shù)據(jù)以配置文件的形式單獨(dú)保存，那么，直接讀寫整個XML將會更方便。 比如：我有一個實(shí)體類，我想將它保存在XML文件中，有可能是多條記錄，也可能是一條。
這次我來反過來說，假如我們先定義了XML的結(jié)構(gòu)，是下面這個樣子的，那么我將怎么做呢？
對于上面的這段XML結(jié)構(gòu)，我們可以在C#中先定義下面的類，然后通過序列化及反序列化的方式來實(shí)現(xiàn)對它的讀寫。
C#類的定義如下：
有了這二個C#類，讀寫這段XML就非常容易了。以下就是相應(yīng)的讀寫代碼：
private void btnReadXml_Click(object sender, EventArgs e) {btnWriteXml_Click(null, null);List<MyCommand> list = XmlHelper.XmlDeserializeFromFile<List<MyCommand>>(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<MyCommand> list = new List<MyCommand>(1);list.Add(command);XmlHelper.XmlSerializeToFile(list, XmlFileName, Encoding.UTF8); }小結(jié)：
1. 讀寫整個XML最方便的方法是使用序列化反序列化。
2. 如果您希望某個參數(shù)以Xml Property的形式出現(xiàn)，那么需要使用[XmlAttribute]修飾它。
3. 如果您希望某個參數(shù)以Xml Element的形式出現(xiàn)，那么需要使用[XmlElement]修飾它。
4. 如果您希望為某個List的項(xiàng)目指定ElementName，則需要[XmlArrayItem]
5. 以上3個Attribute都可以指定在XML中的映射別名。
6. 寫XML的操作是通過XmlSerializer.Serialize()來實(shí)現(xiàn)的。
7. 讀取XML文件是通過XmlSerializer.Deserialize來實(shí)現(xiàn)的。
8. List或Array項(xiàng)，請不要使用[XmlElement]，否則它們將以內(nèi)聯(lián)的形式提升到當(dāng)前類，除非你再定義一個容器類。
XmlHelper的實(shí)現(xiàn)如下：?
回到頂部xml配置文件 - CDATA
在前面的演示中，有個不完美的地方，我將SQL腳本以普通字符串的形式輸出到XML中了：
<CommandText>insret into .....</CommandText>顯然，現(xiàn)實(shí)中的SQL腳本都是比較長的，而且還可能會包含一些特殊的字符，這種做法是不可取的，好的處理方式應(yīng)該是將它以CDATA的形式保存， 為了實(shí)現(xiàn)這個目標(biāo)，我們就不能直接按照普通字符串的方式來處理了，這里我定義了一個類 MyCDATA：?
我將使用這個類來控制CommandText在XML序列化及反序列化的行為，讓它寫成一個CDATA形式， 因此，我還需要修改CommandText的定義，改成這個樣子：
public MyCDATA CommandText;最終，得到的結(jié)果是：
<?xml version="1.0" encoding="utf-8"?> <ArrayOfMyCommand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><MyCommand Name="InsretCustomer" Database="MyTestDb"><Parameters><Parameter Name="Name" Type="DbType.String" /><Parameter Name="Address" Type="DbType.String" /></Parameters><CommandText><![CDATA[insret into .....]]></CommandText></MyCommand> </ArrayOfMyCommand> 回到頂部xml文件讀寫注意事項(xiàng)
通常，我們使用使用XmlSerializer.Serialize()得到的XML字符串的開頭處，包含一段XML聲明元素：
<?xml version="1.0" encoding="utf-8"?>由于各種原因，有時候可能不需要它。為了讓這行字符消失，我見過有使用正則表達(dá)式去刪除它的，也有直接分析字符串去刪除它的。 這些方法，要么浪費(fèi)程序性能，要么就要多寫些奇怪的代碼。總之，就是看起來很別扭。 其實(shí)，我們可以反過來想一下：能不能在序列化時，不輸出它呢？ 不輸出它，不就達(dá)到我們期望的目的了嗎？
在XML序列化時，有個XmlWriterSettings是用于控制寫XML的一些行為的，它有一個OmitXmlDeclaration屬性，就是專門用來控制要不要輸出那行XML聲明的。 而且，這個XmlWriterSettings還有其它的一些常用屬性。請看以下演示代碼：
using( MemoryStream stream = new MemoryStream() ) {XmlWriterSettings settings = new XmlWriterSettings();settings.Indent = true;settings.NewLineChars = "\r\n";settings.OmitXmlDeclaration = true;settings.IndentChars = "\t";XmlWriter writer = XmlWriter.Create(stream, settings);使用上面這段代碼，我可以：
1. 不輸出XML聲明。
2. 指定換行符。
3. 指定縮進(jìn)字符。
如果不使用這個類，恐怕還真的不能控制XmlSerializer.Serialize()的行為。
?
前面介紹了讀寫XML的方法，可是，如何開始呢？ 由于沒有XML文件，程序也沒法讀取，那么如何得到一個格式正確的XML呢？ 答案是：先寫代碼，創(chuàng)建一個要讀取的對象，隨便輸入一些垃圾數(shù)據(jù)，然后將它寫入XML（反序列化）， 然后，我們可以參考生成的XML文件的具體格式，或者新增其它的節(jié)點(diǎn)（列表）， 或者修改前面所說的垃圾數(shù)據(jù)，最終得到可以使用的，有著正確格式的XML文件。
回到頂部配置參數(shù)的建議保存方式
經(jīng)常見到有很多組件或者框架，都喜歡把配置參數(shù)放在config文件中， 那些設(shè)計(jì)者或許認(rèn)為他們的作品的參數(shù)較復(fù)雜，還喜歡搞自定義的配置節(jié)點(diǎn)。 結(jié)果就是：config文件中一大堆的配置參數(shù)。最麻煩的是：下次其它項(xiàng)目還要使用這個東西時，還得繼續(xù)配置！
.net一直提倡XCOPY，但我發(fā)現(xiàn)遵守這個約定的組件或者框架還真不多。 所以，我想建議大家在設(shè)計(jì)組件或者框架的時候：
1. 請不要把你們的參數(shù)放在config文件中，那種配置真的不方便【復(fù)用】。
2. 能不能同時提供配置文件以及API接口的方式公開參數(shù)，由用戶來決定如何選擇配置參數(shù)的保存方式。
?
?
回到頂部config文件與XML文件的差別
從本質(zhì)上說，config文件也是XML文件，但它們有一點(diǎn)差別，不僅僅是因?yàn)?net framework為config文件預(yù)定義了許多配置節(jié)。 對于ASP.NET應(yīng)用程序來說，如果我們將參數(shù)放在web.config中，那么，只要修改了web.config，網(wǎng)站也將會重新啟動， 此時有一個好處：我們的代碼總是能以最新的參數(shù)運(yùn)行。另一方面，也有一個壞處：或許由于種種原因，我們并不希望網(wǎng)站被重啟， 畢竟重啟網(wǎng)站會花費(fèi)一些時間，這會影響網(wǎng)站的響應(yīng)。 對于這個特性，我只能說，沒有辦法，web.config就是這樣。
然而，當(dāng)我們使用XML時，顯然不能直接得到以上所說的特性。因?yàn)閄ML文件是由我們自己來維護(hù)的。
到這里，您有沒有想過：我如何在使用XML時也能擁有那些優(yōu)點(diǎn)呢？
我希望在用戶修改了配置文件后，程序能立刻以最新的參數(shù)運(yùn)行，而且不用重新網(wǎng)站。
如果希望知道這個答案，請關(guān)注我的后續(xù)博客，我是Fish Li 。
?
本文的所有示例代碼可以點(diǎn)擊此處下載。
轉(zhuǎn)載于:https://www.cnblogs.com/ruiati/archive/2013/02/01/2889008.html
總結(jié)
以上是生活随笔為你收集整理的在.net中读写config文件的各种方法（转载）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： [转]Github 中被 Fork 最多
- 下一篇： WORD2010自动编号后，目录那里编号