關於App.config設定檔

標籤：

今天在做複習的時候，突然發現自己無法讀取設定檔中的資料庫連接字串，而且檢查了半天也沒找出原因，最後求助萬能的度娘才得以解決——

1.App.config設定檔在項目中添加後不要修改名稱，否則會出現應用程式找不到該檔案的情況，看清楚了，不要改名字~~

2.常見用途：

       我們一般都是用來做資料庫訪問的，現在有兩種比較常見的方式，如下——

       （1）.key 、value方式

        例子：設定檔部分：

<?xml version="1.0" encoding="utf-8" ?> <configuration>   <appSettings>     <add key="con" value="server=testName\SQL2000;uid=sa;pwd=123;database=Test"/>//這裡的server、uid、pwd和database不區分大小寫，資料庫名稱Test也不區分大小寫，例如你可以寫成DATABASE=test
   </appSettings>
 </configuration>

cs部分：

string access_str = ConfigurationManager.AppSettings["con"];

 

         （2）.name、connectionString方式

         例子：

設定檔部分：

<?xml version="1.0" encoding="utf-8" ?><configuration>  <connectionStrings>    <add name="con" connectionString="server=testName\SQL2000;uid=sa;pwd=123;database=Test"/> 
  </connectionStrings> 
</configuration>

cs部分：

 string access_str = ConfigurationManager.ConnectionStrings["con"].ConnectionString;

 

3.App.config設定檔介紹 (轉載自 http://blog.xieyc.com/csharp-read-and-write-configuration-file-app-config/ )

我們經常會希望在程式中寫入一些配置資訊，例如版本號碼，以及資料庫的連接字串等。你可能知道在WinForm應用程式中可以利用Properties.Settings來進行類似的工作，但這些其實都利用了App.config設定檔。本文探討用代碼的方式訪問 App.config 的方法。關於 App.config 的使用遠比上面提到的用途複雜，因此僅討論最基本的 appSettings 配置節。

(1)設定檔概述：

應用程式設定檔是標準的 XML 檔案，XML 標記和屬性是區分大小寫。它是可以按需要更改的，開發人員可以使用設定檔來更改設定，而不必重編譯應用程式。設定檔的根節點是configuration。我們經常訪問的是appSettings，它是由.Net預定義的配置節。我們經常使用的設定檔的架構是客訴下面的形式。先大概有個印象，通過後面的執行個體會有一個比較清楚的認識。下面的“配置節”可以理解為進行配置一個XML的節點。

常見設定檔模式：

<configuration>
<configSections>                //配置節聲明地區，包含配置節和命名空間聲明
<section>                         //配置節聲明
<sectionGroup>                //定義配置節組
<section>                        //配置節組中的配置節聲明
<appSettings>                   //預定義配置節
<Custom element for configuration section>   //配置節設定地區

 

  

下面是一個最常見的應用程式設定檔的例子，只有appSettings節：

12345678

<?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，請往下看。

 

(2)appSettings配置節的讀寫操作

讀取App.config檔案的appSettings節的方法比較簡單，可以通過上文中 System.Configuration.ConfigurationManager.AppSettings["Key"]的方法進行訪問，但前面也已經說了，該方法不提供寫入。

如果希望寫入設定檔，可以使用ConfigurationManager對象執行開啟設定檔的操作後，將會返回一個Configuration的對象，利用該對象進行操作（增刪改查都可以哦）。

下面給出實現的代碼（增加引用using System.Configuration名稱空間）

            //擷取Configuration對象            Configuration config = System.Configuration.ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);            //根據Key讀取<add>元素的Value            string name = config.AppSettings.Settings["con"].Value;            //寫入<add>元素的Value            config.AppSettings.Settings["con"].Value = "xieyc";            //增加<add>元素            config.AppSettings.Settings.Add("url", "http://www.xieyc.com");            //刪除<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配置節。

5、可能有讀者會想到，既然app.config是標準XML，當然也可以用操縱一般XML檔案的方法來讀寫。這當然是可以的！具體可以看文末參考文獻[2]和[3]中的代碼，只不過我認為這樣就失去了VS提供app.config檔案的意義了，還不如自己定義一個設定檔方便。

 

本文只是粗略地講了app.config檔案中appSettings配置節的存取方法，connectionStrings配置節的操作基本是類似的，也可以自訂配置節。這些進階的用法可以自己體會，VS對app.config這個設定檔的管理還是很強大的，例如WinForm應用程式的Settings設定（可以在IDE中或者通過代碼訪問）其實也是利用了app.config檔案。

 

關於App.config設定檔