c#讀寫配置文件

.net Framework 2.0 專門提供了配置文件的操作。

namespace System.Configuration;

1. 創建配置節類

必須創建繼承自ConfigurationSection的對象才能進行配置數據讀寫操作，ConfigurationSection提供了索引器用來獲取和設置配置數據，需要注意的是擁有ConfigurationProperty特性的屬性才會被存儲，並且名稱要保持大小寫完全一致，如下面的代碼中，所有的"id"必須保持一樣。
 

class ConfigSectionData : ConfigurationSection
{
  [ConfigurationProperty("id")]
  public int Id
  {
    get { return (int)this["id"]; }
    set { this["id"] = value; }
  }

  [ConfigurationProperty("time")]
  public DateTime Time
  {
    get { return (DateTime)this["time"]; }
    set { this["time"] = value; }
  }
}

2. 創建配置文件操作對象
　   

Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);

ConfigSectionData data = new ConfigSectionData();
data.Id = 1000;
data.Time = DateTime.Now;

config.Sections.Add("add", data);
config.Save(ConfigurationSaveMode.Minimal);

上面的例子是操作 app.config，在根節點(configuration)下寫入名稱為"add"的配置數據。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="add" type="ConsoleApplication1.ConfigSectionData,  />
  </configSections>
  <add id="1000" time="02/18/2006 21:51:06" />
</configuration>

需要注意的 VS2005 在IDE模式下會將信息寫入 *.vshost.exe.config，並且在程序關閉時覆寫該文件，因此您可能看不到您寫入的配置數據，只要在資源管理其中執行 *.exe 文件，您就可以在 *.exe.config 文件中看到結果了。

如果我們需要操作非缺省配置文件，可以使用ExeConfigurationFileMap對象。

ExeConfigurationFileMap file = new ExeConfigurationFileMap();
file.ExeConfigFilename = "test.config";
Configuration config = ConfigurationManager.OpenMappedExeConfiguration(file, ConfigurationUserLevel.None);

ConfigSectionData data = new ConfigSectionData();
data.Id = 1000;
data.Time = DateTime.Now;

config.Sections.Add("add", data);
config.Save(ConfigurationSaveMode.Minimal);

如果我們不希望在根節點下寫入配置數據，可以使用ConfigurationSectionGroup對象。

ExeConfigurationFileMap file = new ExeConfigurationFileMap();
file.ExeConfigFilename = "test.config";
Configuration config = ConfigurationManager.OpenMappedExeConfiguration(file, ConfigurationUserLevel.None);

ConfigSectionData data = new ConfigSectionData();
data.Id = 1000;
data.Time = DateTime.Now;

config.SectionGroups.Add("group1", new ConfigurationSectionGroup());
config.SectionGroups["group1"].Sections.Add("add", data);

config.Save(ConfigurationSaveMode.Minimal);

下面就是生成的配置文件。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <sectionGroup name="group1" type="System.Configuration.ConfigurationSectionGroup,  >
      <section name="add" type="ConsoleApplication1.ConfigSectionData,  />
    </sectionGroup>
  </configSections>
  <group1>
    <add id="1000" time="02/18/2006 22:01:02" />
  </group1>
</configuration>

3. 讀取配置文件

ExeConfigurationFileMap file = new ExeConfigurationFileMap();
file.ExeConfigFilename = "test.config";
Configuration config = ConfigurationManager.OpenMappedExeConfiguration(file, ConfigurationUserLevel.None);

ConfigSectionData data = config.SectionGroups["group1"].Sections["add"] as ConfigSectionData;
//ConfigSectionData data = config.Sections["add"] as ConfigSectionData; // 從根節讀取

if (data != null)
{
  Console.WriteLine(data.Id);
  Console.WriteLine(data.Time);
}

4. 寫配置文件

在寫入 ConfigurationSectionGroup 和 ConfigurationSection 前要判斷同名配置是否已經存在，否則會寫入失敗。
另外如果配置文件被其他Configuration對象修改，則保存會失敗，並拋出異常。建議采用Singleton模式。

ExeConfigurationFileMap file = new ExeConfigurationFileMap();
file.ExeConfigFilename = "test.config";
Configuration config = ConfigurationManager.OpenMappedExeConfiguration(file, ConfigurationUserLevel.None);

ConfigSectionData data = new ConfigSectionData();
data.Id = 2000;
data.Time = DateTime.Now;

ConfigurationSectionGroup group1 = config.SectionGroups["group1"];
if (group1 == null)
  config.SectionGroups.Add("group1", new ConfigurationSectionGroup());

ConfigurationSection data = group1.Sections["add"] as config;
if (add == null)
  config.SectionGroups["group1"].Sections.Add("add", data);
else
{
  group1.Sections.Remove("add");
  group1.Sections.Add("add", data);

  // 或者直接修改原配置對象，前提是類型轉換要成功。
  //ConfigSectionData configData = add as ConfigSectionData;
  //configData.Id = data.Id;
  //configData.Time = data.Time;
}

config.Save(ConfigurationSaveMode.Minimal);

5. 刪除配置節

刪除ConfigurationSectionGroup

config.SectionGroups.Remove("group1");
//config.SectionGroups.Clear();

config.Save(ConfigurationSaveMode.Minimal);

刪除ConfigurationSection
config.Sections.Remove("add1");
//config.Sections.Clear();

if (config.SectionGroups["group1"] != null)
{
  config.SectionGroups["group1"].Sections.Remove("add2");
  //config.SectionGroups["group1"].Sections.Clear();
}

config.Save(ConfigurationSaveMode.Minimal);

6. 其他

可以使用 ConfigurationManager.OpenMachineConfiguration() 來操作 Machine.config 文件。
或者使用 System.Web.Configuration 名字空間中的 WebConfigurationManager 類來操作 ASP.net 配置文件。
ConfigurationManager還提供了AppSettings、ConnectionStrings、GetSection()等便捷操作。