c#讀寫App.config,ConfigurationManager.AppSettings 不生效的解決方法
我們經(jīng)常會(huì)希望在程序中寫入一些配置信息,例如版本號(hào),以及數(shù)據(jù)庫(kù)的連接字符串等。你可能知道在WinForm應(yīng)用程序中可以利用Properties.Settings來進(jìn)行類似的工作,但這些其實(shí)都利用了App.config配置文件。
本文探討用代碼的方式訪問 App.config 的方法。關(guān)于 App.config 的使用遠(yuǎn)比上面提到的用途復(fù)雜,因此僅討論最基本的 appSettings 配置節(jié)。
一、配置文件概述:
應(yīng)用程序配置文件是標(biāo)準(zhǔn)的 XML 文件,XML 標(biāo)記和屬性是區(qū)分大小寫的。它是可以按需要更改的,開發(fā)人員可以使用配置文件來更改設(shè)置,而不必重編譯應(yīng)用程序。配置文件的根節(jié)點(diǎn)是configuration。我們經(jīng)常訪問的是appSettings,它是由.Net預(yù)定義的配置節(jié)。我們經(jīng)常使用的配置文件的架構(gòu)是客訴下面的形式。先大概有個(gè)印象,通過后面的實(shí)例會(huì)有一個(gè)比較清楚的認(rèn)識(shí)。下面的“配置節(jié)”可以理解為進(jìn)行配置一個(gè)XML的節(jié)點(diǎn)。
常見配置文件模式:
<configuration>
<configSections> //配置節(jié)聲明區(qū)域,包含配置節(jié)和命名空間聲明
<section> //配置節(jié)聲明
<sectionGroup> //定義配置節(jié)組
<section> //配置節(jié)組中的配置節(jié)聲明
<appSettings> //預(yù)定義配置節(jié)
<Custom element for configuration section> //配置節(jié)設(shè)置區(qū)域
下面是一個(gè)最常見的應(yīng)用程序配置文件的例子,只有appSettings節(jié):
<?xml version="1.0" encoding="utf-8"?> <configuration> <appSettings> <add key="connectionstring" value="User Source=.;Password=;Initial Catalog=test;Provider=SQLOLEDB.1;" /> <add key="TemplatePATH" value="Template" /> </appSettings> </configuration>
在預(yù)定義的 appSettings 節(jié)(注意大小寫),有很多的元素,這些元素名稱都是“add”,有兩個(gè)屬性分別是“key”和“value”。
.NET 提供了對(duì)appSettings節(jié)的訪問方法。在 .NET 1.0 和 1.1 版本中,可以使用 System.Configuration.ConfigurationSettings.AppSettings["Key"] 來對(duì) key = "Key" 的<add>元素的 value屬性 進(jìn)行訪問。
注意:現(xiàn)在.Net FrameWork 2.0中已經(jīng)明確表示此ConfigurationSettings屬性已經(jīng)廢棄,建議改為 ConfigurationManager 或 WebConfigurationManager。
使用 System.Configuration.ConfigurationManager,需要在工程里添加對(duì) system.configuration.dll 程序集的引用。(在解決方案管理器中右鍵點(diǎn)擊工程名稱,在右鍵菜單中選擇添加引用,在.NET選項(xiàng)卡下即可找到。)
添加引用后,就可以用 ConfigurationManager.AppSettings["Key"] 來讀取對(duì)應(yīng)的值了.
但是,ConfigurationManager.AppSettings 屬性是只讀的,并不支持修改屬性值。這是因?yàn)閾?jù)說微軟不太建議我們動(dòng)態(tài)寫入app.config文件,而是建議手工配置后,在程序運(yùn)行時(shí)只做靜態(tài)訪問。
如果實(shí)在需要在程序中進(jìn)行修改,也即寫入App.Config,請(qǐng)往下看。
二、appSettings配置節(jié)的讀寫操作
讀取App.config文件的appSettings節(jié)的方法比較簡(jiǎn)單,可以通過上文中 System.Configuration.ConfigurationManager.AppSettings["Key"]的方法進(jìn)行訪問,但前面也已經(jīng)說了,該方法不提供寫入。
如果希望寫入配置文件,可以使用ConfigurationManager對(duì)象執(zhí)行打開配置文件的操作后,將會(huì)返回一個(gè)Configuration的對(duì)象,利用該對(duì)象進(jìn)行操作(增刪改查都可以哦)。
下面給出實(shí)現(xiàn)的代碼(增加引用using System.Configuration名稱空間)
private void AccessAppSettings() { //獲取Configuration對(duì)象 Configuration config = System.Configuration.ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); //根據(jù)Key讀取<add>元素的Value string name = config.AppSettings.Settings["name"].Value; //寫入<add>元素的Value config.AppSettings.Settings["name"].Value = "xieyc"; //增加<add>元素 config.AppSettings.Settings.Add("url", "http://www.dbjr.com.cn"); //刪除<add>元素 config.AppSettings.Settings.Remove("name"); //一定要記得保存,寫不帶參數(shù)的config.Save()也可以 config.Save(ConfigurationSaveMode.Modified); //刷新,否則程序讀取的還是之前的值(可能已裝入內(nèi)存) System.Configuration.ConfigurationManager.RefreshSection("appSettings"); }
需要注意的是:
1、根據(jù)并不存在的Key值訪問<add>元素,甚至使用remove()方法刪除不存在的元素,都不會(huì)導(dǎo)致異常,前者會(huì)返回null。
2、add已經(jīng)存在的<add>元素也不會(huì)導(dǎo)致異常,而是concat了已有的Value和新的Value,用","分隔,例如:"olldvalue,newvalue"。
3、在項(xiàng)目進(jìn)行編譯后,在運(yùn)行目錄bin\Debuge文件下,將出現(xiàn)兩個(gè)配置文件,一個(gè)名為“ProjectName.EXE.config”,另一個(gè)名為“ProjectName.vshost.exe.config”。第一個(gè)文件為項(xiàng)目實(shí)際使用的配置文件,在程序運(yùn)行中所做的更改都將被保存于此;第二個(gè)文件其實(shí)為原代碼中“App.config”的同步文件,在程序運(yùn)行中不會(huì)發(fā)生更改。
4、特別注意大小寫(XML文件是區(qū)分大小寫的),例如appSettings配置節(jié)。
5、可能有讀者會(huì)想到,既然app.config是標(biāo)準(zhǔn)XML,當(dāng)然也可以用操縱一般XML文件的方法來讀寫。這當(dāng)然是可以的!具體可以看文末參考文獻(xiàn)[2]和[3]中的代碼,只不過我認(rèn)為這樣就失去了VS提供app.config文件的意義了,還不如自己定義一個(gè)配置文件方便。
本文只是粗略地講了app.config文件中appSettings配置節(jié)的訪問方法,connectionStrings配置節(jié)的操作基本是類似的,也可以自定義配置節(jié)。這些高級(jí)的用法可以自己體會(huì),VS對(duì)app.config這個(gè)配置文件的管理還是很強(qiáng)大的,例如WinForm應(yīng)用程序的Settings設(shè)置(可以在IDE中或者通過代碼訪問)其實(shí)也是利用了app.config文件。
參考資料:
[1] Read/Write App.Config File with .NET 2.0(這篇文章從.NET 1.0 過渡到 2.0,因此額外講了很多兩個(gè)版本間的變化)
[2] C#讀寫app.config中的數(shù)據(jù)(作者不知從哪兒復(fù)制的一堆相關(guān)內(nèi)容的大雜燴,也沒好好整理,不過還蠻有用)
相關(guān)文章
深入理解c# checked unchecked 關(guān)鍵字
本篇文章是對(duì)c#中的checked unchecked 關(guān)鍵字進(jìn)行了詳細(xì)的分析介紹,需要的朋友參考下2013-05-05C#中HttpClient使用注意(預(yù)熱與長(zhǎng)連接)
本文主要介紹了C#中HttpClient使用,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-02-02C#微信公眾平臺(tái)開發(fā)之a(chǎn)ccess_token的獲取存儲(chǔ)與更新
這篇文章主要介紹了C#微信公眾平臺(tái)開發(fā)之a(chǎn)ccess_token的獲取存儲(chǔ)與更新的相關(guān)資料,需要的朋友可以參考下2016-03-03C#實(shí)現(xiàn)添加多行文本水印到Word文檔
一般情況下,在Word中添加文字水印僅支持添加一個(gè)文本字樣的水印,由于對(duì)不同文檔的設(shè)計(jì)要求,需要在Word文檔中添加平鋪水印效果。本文將介紹如何來實(shí)現(xiàn)該水印效果的方法,感興趣的可以了解一下2022-07-07