天天看點

C# 讀寫App.config配置檔案的方法

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

常見配置檔案模式:

<configuration>

<configSections>                    //配置節聲明區域,包含配置節和命名空間聲明

<section>                         //配置節聲明

<sectionGroup>                //定義配置節組

<section>                        //配置節組中的配置節聲明

<appSettings>                       //預定義配置節

<Custom element for configuration section>   //配置節設定區域

下面是一個最常見的應用程式配置檔案的例子,隻有appSettings節:

C# 讀寫App.config配置檔案的方法
C# 讀寫App.config配置檔案的方法

在預定義的 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,請往下看。

c#添加了Configuration;後,竟然找不到 ConfigurationManager 這個類,後來才發現:雖然引用了using System.Configuration;這個包,但是還是不行的。

後來終于找到一個解決方法,就是在解決方案資料總管裡找到類檔案選擇“引用”,然後右擊選擇“添加引用”,并且從 .net 中找到System.Configuration把它加上去就OK啦

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

如果希望寫入配置檔案,可以使用ConfigurationManager對象執行打開配置檔案的操作後,将會傳回一個Configuration的對象,利用該對象進行操作(增删改查都可以哦)。

下面給出實作的代碼(增加引用using System.Configuration名稱空間)

C# 讀寫App.config配置檔案的方法
C# 讀寫App.config配置檔案的方法

需要注意的是:

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檔案的方法來讀寫。這當然是可以的!隻不過我認為這樣就失去了VS提供app.config檔案的意義了,還不如自己定義一個配置檔案友善。