net2.0中對config文件的操作方法總結

 在.net編程中，我們經常用到config文件來保存一些常用的應用程序配置信息，在WinForm中這個文件名字是app.config，在asp.net中叫web.config。這個.config文件其實就是一個xml文件，對它的讀操作微軟已經提供了一個類來實現了，這個類就是System.Configuration.ConfigurationManager，下面分別是例子：

1. //讀取config里名稱爲“conn”數據庫連接信息
2.      connectionString = System.Configuration.ConfigurationManager.ConnectionStrings["conn"].ConnectionString;
3. //讀取config里名稱爲"Font_Size"的應用程序配置信息
4. System.Configuration.ConfigurationManager.AppSettings["Font-Size"] = 9;

不過利用這個類卻不能對config文件進行寫操作。對於config文件的寫操作，很多人通過xml的方式來進行，按照xml的方式進行寫操作在WinForm下雖然繁瑣點，但是畢竟能完成。以下是按照xml文件進行寫的例子。

1. #region 保存配置
2.             XmlDocument document = LoadXml();
3.             XmlNode root = document.DocumentElement;
4.             XmlNodeList nodeList = root.FirstChild.ChildNodes;
5.             for (int i = 0; i < nodeList.Count; i++)
6.             {
7.                 string key = nodeList[i].Attributes["key"].Value;
8.                 if (key == "FilterOption")
9.                 {
10.                     nodeList[i].Attributes["value"].Value = ((int)container.FilterOption).ToString();
11.                 }
12.             }
13.             document.Save(configPath);
14.             #endregion

但是在WebForm下，往往會因爲權限不足而報錯。如下圖：

本文提供了另外一種方式，利用.net2.0類庫裏面的Configuration來進行寫操作。詳細介紹請看下面的詳細介紹。

 

Configuration 是允許進行編程訪問以編輯配置文件的類。對於WebForm的config文件，可以用如下代碼得到Configuration類的實例：

1. Configuration config = System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath);

對於WinForm的config文件，可以用如下代碼得到Configuration類的實例：

 

1. Configuration config = System.Configuration.ConfigurationManager.OpenExeConfiguration(configPath);

需要注意的是，對文件進行寫操作之後，需要調用Save()方法保存結果。整個程序的源代碼如下，並附有詳細代碼註釋。

1. using System;
2. using System.Configuration;
3. using System.Web;
4. using System.Windows.Forms;
6. namespace NetSkycn.Common
7. {
8.     /// <summary>
9.     /// 說明：Config文件類型枚舉，
10.    /// 分別爲asp.net網站的config文件和WinForm的config文件
11.     /// 作者：周公
12.     /// 日期：2008-08-23
13.     /// 首發地址：http://blog.csdn.net/zhoufoxcn/archive/2008/08/24/2823508.aspx
14.     /// </summary>
15.     public enum ConfigType
16.     {
17.         /// <summary>
18.         /// asp.net網站的config文件
19.         /// </summary>
20.         WebConfig = 1,
21.         /// <summary>
22.         /// Windows應用程序的config文件
23.         /// </summary>
24.         ExeConfig = 2
25.     }
27.     /// <summary>
28.     /// 說明：本類主要負責對程序配置文件(.config)進行修改的類，
29.     /// 可以對網站和應用程序的配置文件進行修改
30.     /// 作者：周公
31.     /// 日期：2008-08-23
32.     /// 首發地址：http://blog.csdn.net/zhoufoxcn/archive/2008/08/24/2823508.aspx
33.     /// </summary>
34.     public class ConfigurationOperator
35.     {
36.         private Configuration config;
37.         private string configPath;
38.         private ConfigType configType;
40.         /// <summary>
41.         /// 對應的配置文件
42.         /// </summary>
43.         public Configuration Configuration
44.         {
45.             get { return config; }
46.             set { config = value; }
47.         }
48.         /// <summary>
49.         /// 構造函數
50.         /// </summary>
51.         /// <param name="configType">.config文件的類型，只能是網站配置文件或者應用程序配置文件</param>
52.         public ConfigurationOperator(ConfigType configType)
53.         {
54.             this.configType = configType;
55.             if (configType == ConfigType.ExeConfig)
56.             {
57.                 configPath = Application.ExecutablePath; //AppDomain.CurrentDomain.BaseDirectory;
58.             }
59.             else
60.             {
61.                 configPath = HttpContext.Current.Request.ApplicationPath;
62.             }
63.             Initialize();
64.         }
65.         /// <summary>
66.         /// 構造函數
67.         /// </summary>
68.         /// <param name="path">.config文件的位置</param>
69.         /// <param name="type">.config文件的類型，只能是網站配置文件或者應用程序配置文件</param>
70.         public ConfigurationOperator(string configPath, ConfigType configType)
71.         {
72.             this.configPath = configPath;
73.             this.configType = configType;
74.             Initialize();
75.         }
76.         //實例化configuration,根據配置文件類型的不同，分別採取了不同的實例化方法
77.         private void Initialize()
78.         {
79.             //如果是WinForm應用程序的配置文件
80.             if (configType == ConfigType.ExeConfig)
81.             {
82.                 config = System.Configuration.ConfigurationManager.OpenExeConfiguration(configPath);
83.             }
84.             else//WebForm的配置文件
85.             {
86.                 config = System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath);
87.             }
88.         }
90.         /// <summary>
91.         /// 添加應用程序配置節點，如果已經存在此節點，則會修改該節點的值
92.         /// </summary>
93.         /// <param name="key">節點名稱</param>
94.         /// <param name="value">節點值</param>
95.         public void AddAppSetting(string key, string value)
96.         {
97.             AppSettingsSection appSetting = (AppSettingsSection)config.GetSection("appSettings");
98.             if (appSetting.Settings[key] == null)//如果不存在此節點，則添加
99.             {
100.                 appSetting.Settings.Add(key, value);
101.             }
102.             else//如果存在此節點，則修改
103.             {
104.                 ModifyAppSetting(key, value);
105.             }
106.         }
107.         /// <summary>
108.         /// 添加數據庫連接字符串節點，如果已經存在此節點，則會修改該節點的值
109.         /// </summary>
110.         /// <param name="key">節點名稱</param>
111.         /// <param name="value">節點值</param>
112.         public void AddConnectionString(string key, string connectionString)
113.         {
114.             ConnectionStringsSection connectionSetting = (ConnectionStringsSection)config.GetSection("connectionStrings");
115.             if (connectionSetting.ConnectionStrings[key] == null)//如果不存在此節點，則添加
116.             {
117.                 ConnectionStringSettings connectionStringSettings = new ConnectionStringSettings(key, connectionString);
118.                 connectionSetting.ConnectionStrings.Add(connectionStringSettings);
119.             }
120.             else//如果存在此節點，則修改
121.             {
122.                 ModifyConnectionString(key, connectionString);
123.             }
124.         }
125.         /// <summary>
126.         /// 修改應用程序配置節點，如果不存在此節點，則會添加此節點及對應的值
127.         /// </summary>
128.         /// <param name="key">節點名稱</param>
129.         /// <param name="value">節點值</param>
130.         public void ModifyAppSetting(string key, string newValue)
131.         {
132.             AppSettingsSection appSetting = (AppSettingsSection)config.GetSection("appSettings");
133.             if (appSetting.Settings[key] != null)//如果存在此節點，則修改
134.             {
135.                 appSetting.Settings[key].Value = newValue;
136.             }
137.             else//如果不存在此節點，則添加
138.             {
139.                 AddAppSetting(key, newValue);
140.             }
141.         }
142.         /// <summary>
143.         /// 修改數據庫連接字符串節點，如果不存在此節點，則會添加此節點及對應的值
144.         /// </summary>
145.         /// <param name="key">節點名稱</param>
146.         /// <param name="value">節點值</param>
147.         public void ModifyConnectionString(string key, string connectionString)
148.         {
149.             ConnectionStringsSection connectionSetting = (ConnectionStringsSection)config.GetSection("connectionStrings");
150.             if (connectionSetting.ConnectionStrings[key] != null)//如果存在此節點，則修改
151.             {
152.                 connectionSetting.ConnectionStrings[key].ConnectionString = connectionString;
153.             }
154.             else//如果不存在此節點，則添加
155.             {
156.                 AddConnectionString(key, connectionString);
157.             }
158.         }
159.         /// <summary>
160.         /// 保存所作的修改
161.         /// </summary>
162.         public void Save()
163.         {
164.             config.Save();
165.         }
166.     }
167. }

 

用法實例：
（一）WebForm中的用法

 

1. ConfigurationOperator co = new ConfigurationOperator(ConfigType.WebConfig);
2.         string key = txtConnectionStringKey.Text;
3.         string value = txtConnectionStringValue.Text;
4.         co.AddConnectionString(key, value);
5.         co.Save();

（二）WinForm中的用法

1. ConfigurationOperator co = new ConfigurationOperator(ConfigType.ExeConfig);
2.             co.AddAppSetting("Font-Size", "9");
3.             co.AddAppSetting("WebSite", "http://blog.csdn.net/zhoufoxcn");
4.             co.AddConnectionString("Connection", "test");
5.             co.Save();//保存寫入結果

我在WinForm里加入了一個空白的app.config文件，經過上面的操作得到如下結果（這個文件是和最後生成的exe文件在同一個目錄下，而不是和源代碼在同一文件夾下的那個config文件）：

1. <?xml version="1.0" encoding="utf-8" ?>
2. <configuration>
3.     <appSettings>
4.         <add key="Font-Size" value="9" />
5.         <add key="WebSite" value="http://blog.csdn.net/zhoufoxcn" />
6.     </appSettings>
7.     <connectionStrings>
8.         <add name="Connection" connectionString="test" />
9.     </connectionStrings>
10. </configuration>

經過這個封裝類可以簡化對config配置文件的操作，僅僅是需要在實例化Configuration類的實例時指明打開的是網站還是應用程序的config文件，並且在進行了所有修改和增加操作之後調用Save()方法保存所做的修改即可。需要注意的是：要想把上面的程序作爲類庫編譯，需要添加對System.Web.dll和System.Windows.Forms.dll和System.Configuration.dll類庫的引用。