我們經常會希望在程序中寫入一些配置信息,例如版本號,以及數據庫的連接字符串等。你可能知道在WinForm應用程序中可以利用Properties.Settings來進行類似的工作,但這些其實都利用了App.config配置文件。
本文探討用代碼的方式訪問 App.config 的方法。關于 App.config 的使用遠比上面提到的用途復雜,因此僅討論最基本的 appSettings 配置節。
一、配置文件概述:
應用程序配置文件是標準的 XML 文件,XML 標記和屬性是區分大小寫的。
它是可以按需要更改的,開發人員可以使用配置文件來更改設置,而不必重編譯應用程序。
配置文件的根節點是configuration。我們經常訪問的是appSettings,它是由.Net預定義的配置節。我們經常使用的配置文件的架構是客訴下面的形式。
先大概有個印象,通過后面的實例會有一個比較清楚的認識。下面的“配置節”可以理解為進行配置一個XML的節點。
<configuration> <configSections>//配置節聲明區域,包含配置節和命名空間聲明 <section>//配置節聲明 <sectionGroup>//定義配置節組 <section> //配置節組中的配置節聲明 <appSettings>//預定義配置節 <Custom element for configuration section>//配置節設置區域
下面是一個最常見的應用程序配置文件的例子,只有appSettings節:
<?xml version="1.0" encoding="utf-8"?> <configuration> <appSettings> <add key="connectionstring" value="User Source=.;Password=;InitialCatalog=test;Provider=SQLOLEDB.1;" /> <add key="TemplatePATH" value="Template" /> </appSettings> </configuration>
在預定義的 appSettings 節(注意大小寫),有很多的元素,這些元素名稱都是“add”,有兩個屬性分別是“key”和“value”。
.NET 提供了對appSettings節的訪問方法。在 .NET 1.0 和 1.1 版本中,可以使用 System.Configuration.ConfigurationSettings.AppSettings["Key"] 來對 key = "Key" 的<add>元素的 value屬性 進行訪問。
注意:現在.Net FrameWork 2.0中已經明確表示此ConfigurationSettings屬性已經廢棄,建議改為 ConfigurationManager 或 WebConfigurationManager。
使用 System.Configuration.ConfigurationManager,需要在工程里添加對 system.configuration.dll 程序集的引用。(在解決方案管理器中右鍵點擊工程名稱,在右鍵菜單中選擇添加引用,在.NET選項卡下即可找到。)
添加引用后,就可以用 ConfigurationManager.AppSettings["Key"] 來讀取對應的值了。
但是,ConfigurationManager.AppSettings 屬性是只讀的,并不支持修改屬性值。這是因為據說微軟不太建議我們動態寫入app.config文件,而是建議手工配置后,在程序運行時只做靜態訪問。
如果實在需要在程序中進行修改,也即寫入App.Config,請往下看。
二、appSettings配置節的讀寫操作
讀取App.config文件的appSettings節的方法比較簡單,可以通過上文中 System.Configuration.ConfigurationManager.AppSettings["Key"]的方法進行訪問,但前面也已經說了,該方法不提供寫入。
如果希望寫入配置文件,可以使用ConfigurationManager對象執行打開配置文件的操作后,將會返回一個Configuration的對象,利用該對象進行操作(增刪改查都可以哦)。
下面給出實現的代碼(增加引用using System.Configuration名稱空間)
private void AccessAppSettings() { //獲取Configuration對象 Configuration config = System.Configuration.ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); //根據Key讀取<add>元素的Value string name = config.AppSettings.Settings["name"].Value; //寫入<add>元素的Value config.AppSettings.Settings["name"].Value = "zcl"; //增加<add>元素 config.AppSettings.Settings.Add("Name", "Config"); //刪除<add>元素 config.AppSettings.Settings.Remove("name"); //一定要記得保存,寫不帶參數的config.Save()也可以 config.Save(ConfigurationSaveMode.Modified); //刷新,否則程序讀取的還是之前的值(可能已裝入內存) System.Configuration.ConfigurationManager.RefreshSection("appSettings"); }
需要注意的是:
1、根據并不存在的Key值訪問<add>元素,甚至使用remove()方法刪除不存在的元素,都不會導致異常,前者會返回null。
2、add已經存在的<add>元素也不會導致異常,而是concat了已有的Value和新的Value,用","分隔,例如:"olldvalue,newvalue"。
3、在項目進行編譯后,在運行目錄bin\Debuge文件下,將出現兩個配置文件,一個名為“ProjectName.EXE.config”,另一個名為“ProjectName.vshost.exe.config”。第一個文件為項目實際使用的配置文件,在程序運行中所做的更改都將被保存于此;第二個文件其實為原代碼中“App.config”的同步文件,在程序運行中不會發生更改。
4、特別注意大小寫(XML文件是區分大小寫的),例如appSettings配置節。
文章列表
