（转摘）c#读写App.config,ConfigurationManager.AppSettings 不生效

.Net开发中，我们向程序写入一些配置信息如数据库配置等，都是利用了App.config配置文件，本文我们来讨论一下c#读写App.config,ConfigurationManager.AppSettings失效如何解决。

你可能知道在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=;Initial
Catalog=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 = "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、在项目进行编译后，在运行目录binDebuge文件下，将出现两个配置文件，一个名为“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文件。

C#读写app.config中的数据详细实例教程



读语句：
          String str = ConfigurationManager.AppSettings["DemoKey"];

写语句：

           Configuration cfa = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
           cfa.AppSettings.Settings["DemoKey"].Value = "DemoValue";
           cfa.Save();

配置文件内容格式：(app.config)

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
    <add key="DemoKey" value="*" />
</appSettings>
</configuration>

System.Configuration.ConfigurationSettings.AppSettings["Key"];
但是现在FrameWork2.0已经明确表示此属性已经过时。并建议改为ConfigurationManager或WebConfigurationManager。并且AppSettings属性是只读的，并不支持修改属性值．

但是要想调用ConfigurationManager必须要先在工程里添加system.configuration.dll程序集的引用。(在解决方案管理器中右键点击工程名称，在右键菜单中选择添加引用，.net TablePage下即可找到)添加引用后可以用 String str = ConfigurationManager.AppSettings["Key"]来获取对应的值了。

更新配置文件：
Configuration cfa = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
cfa.AppSettings.Settings.Add("key", "Name") ||　cfa.AppSettings.Settings["BrowseDir"].Value = "name";

最后调用
cfa.Save();
当前的配置文件更新成功。


读写配置文件app.config
在.Net中提供了配置文件，让我们可以很方面的处理配置信息，这个配置是XML格式的。而且.Net中已经提供了一些访问这个文件的功能。

1.读取配置信息

下面是一个配置文件的具体内容：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<appSettings>
   <add key="ConnenctionString" value="*" />
   <add key="TmpPath" value="C:Temp" />
   </appSettings>
</configuration>

.net提供了可以直接访问<appsettings>（注意大小写）元素的方法，在这元素中有很多的子元素，这些子元素名称都是“add”，有两个属性分别是“key”和“value”。一般情况下我们可以将自己的配置信息写在这个区域中，通过下面的方式进行访问：

string ConString=System.Configuration.ConfigurationSettings.AppSettings["ConnenctionString"];

在appsettings后面的是子元素的key属性的值，例如appsettings["connenctionstring"]，我们就是访问<add key="ConnenctionString" value="*" />这个子元素，它的返回值就是“*”，即value属性的值。

2.设置配置信息

如果配置信息是静态的，我们可以手工配置，要注意格式。如果配置信息是动态的，就需要我们写程序来实现。在.Net中没有写配置文件的功能，我们可以使用操作XML文件的方式来操作配置文件。下面就是一个写配置文件的例子。
     

 private void SaveConfig(string ConnenctionString)
         {
             XmlDocument doc=new XmlDocument();
             //获得配置文件的全路径
             string strFileName=AppDomain.CurrentDomain.BaseDirectory.ToString()+"Code.exe.config";
             doc.LOAd(strFileName);
             //找出名称为“add”的所有元素
             XmlNodeList nodes=doc.GetElementsByTagName("add");
             for(int i=0;i<nodes.Count;i++)
             {
                 //获得将当前元素的key属性
                 XmlAttribute att=nodes[i].Attributes["key"];
                 //根据元素的第一个属性来判断当前的元素是不是目标元素
                 if (att.Value=="ConnectionString")
                 {
                     //对目标元素中的第二个属性赋值
                     att=nodes[i].Attributes["value"];
                     att.Value=ConnenctionString;
                     break;
                 }
             }
             //保存上面的修改
             doc.Save(strFileName);
         }


VS2005中读写配置文件

VS2003中对于应用程序配置文件(app.config或者web.config)只提供了读取的功能。而在VS2005中，对于配置文件的功能有了很大的加强。在VS2005中，对于应用程序配置文件的读写一般使用Configuration,ConfigurationManager两个类。ConfigurationManager类为客户应用程序提供了一个访问的功能。使用ConfigurationManager对象执行打开配置文件的操作后，将会返回一个Configuration的对象。通过程序实现读写配置文件的代码如下所示：

1.创建配置文件中的配置节所对应的类。该类必须继承自ConfigurationSection
 

  public sealed class ConfigurationSections : ConfigurationSection
     {
         [ConfigurationProperty("filename", DefaultValue = "default.txt")]
         public string FileName
         {
             get
             {
                 return (string)this["filename"];
             }
             set
             {
                 this["filename"] = value;
             }
         }
     }
     public sealed class BusinessSpaceConfiguration : ConfigurationSection
     {
         [ConfigurationProperty("filename")]
         public string FileName
         {
             get
             {
                 return (string)this["filename"];
             }
             set
             {
                 this["filename"] = value;
             }
         }
     }


 

2.创建配置文件代码
   

 private static void WriteAppConfiguration()
         {
             try
             {
                 ConfigurationSections configData = new ConfigurationSections();
                 configData.FileName = "abc.txt";
                 System.Configuration.Configuration   config =

ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
                 config.Sections.Remove("ConfigurationSections");
                 config.Sections.Add("ConfigurationSections", configData);
                 config.Save();

                 BusinessSpaceConfiguration bsconfigData = new BusinessSpaceConfiguration();
                 bsconfigData.FileName = "def.txt";
                 System.Configuration.Configuration config1 =

ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
                 config1.Sections.Remove("BusinessSpaceConfiguration");
                 config1.Sections.Add("BusinessSpaceConfiguration", bsconfigData);
                 config1.Save();                      
             }
             catch (Exception err)
             {
                 Console.Write(err.Message);
             }
         }


 

3.生成的配置文件格式如下所示：


<?xml version="1.0" encoding="utf-8"?>
<configuration>
     <configSections>
         <section

type="ConsoleApplication1.BusinessSpaceConfiguration, ConsoleApplication1, Version=1.0.0.0,

Culture=neutral, PublicKeyToken=null" />
         <section type="ConsoleApplication1.ConfigurationSections,

ConsoleApplication1, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
     </configSections>
     <BusinessSpaceConfiguration filename="def.txt" />
     <ConfigurationSections filename="abc.txt" />
</configuration>



4.读取应用程序配置文件
    


private static void ReadAppConfiguration()
         {
             ConfigurationSections obj1 = ConfigurationManager.GetSection("ConfigurationSections")

as ConfigurationSections;
             BusinessSpaceConfiguration obj2 = ConfigurationManager.GetSection

("BusinessSpaceConfiguration") as BusinessSpaceConfiguration;
             Console.WriteLine(obj1.FileName);
             Console.WriteLine(obj2.FileName);

         }


 

自定义应用程序配置文件(app.config)

1. 配置文件概述：

应用程序配置文件是标准的 XML 文件，XML 标记和属性是区分大小写的。它是可以按需要更改的，开发人员可以使用配置文件来更改设置，而不必重编译应用程序。配置文件的根节点是configuration。我们经常访问的是appSettings，它是由.Net预定义配置节。我们经常使用的配置文件的架构是象下面的形式。先大概有个印象，通过后面的实例会有一个比较清楚的认识。下面的“配置节”可以理解为进行配置一个XML的节点。

常见配置文件模式：

<configuration>
         <configSections>                    //配置节声明区域，包含配置节和命名空间声明
                 <section>                   //配置节声明
             <sectionGroup>                  //定义配置节组
                 <section>                   //配置节组中的配置节声明
         <appSettings>                       //预定义配置节
<Custom element for configuration section>   //配置节设置区域

2.只有appSettings节的配置文件及访问方法

下面是一个最常见的应用程序配置文件的例子，只有appSettings节。


<?xml version="1.0" encoding="utf-8"?>
<configuration>
     <appSettings>
         <add key="connectionstring" value="User Source=.;Password=;Initial
Catalog=test;Provider=SQLOLEDB.1;" />
         <add key="TemplatePATH" value="Template" />
     </appSettings>
</configuration>



下面来看看这样的配置文件如何方法。

string _connectionString=ConfigurationSettings.AppSettings["connectionstring"];

使用ConfigurationSettings类的静态属性AppSettings就可以直接方法配置文件中的配置信息。这个属性的类型是NameValueCollection。

3.自定义配置文件

3.1 自定义配置节

一个用户自定义的配置节，在配置文件中分为两部分：一是在<configSections></configSections>配置节中声明配置节(上面配置文件模式中的“<section>”)，另外是在<configSections></configSections >之后设置配置节(上面配置文件模式中的“<Custom element for configuration section>”)，有点类似一个变量先声明，后使用一样。声明一个配置文件的语句如下：
<section " type=" "/>
<section>：声明新配置节，即可创建新配置节。

name：自定义配置节的名称。
type：自定义配置节的类型，主要包括System.Configuration.SingleTagSectionHandler、System.Configuration.DictionarySectionHandler、System.Configuration.NameValueSectionHandler。

不同的type不但设置配置节的方式不一样，最后访问配置文件的操作上也有差异。下面我们就举一个配置文件的

例子，让它包含这三个不同的type。


<?xml version="1.0" encoding="utf-8" ?>
<configuration>
     <configSections>
         <section type="System.Configuration.SingleTagSectionHandler"/>
         <section type="System.Configuration.DictionarySectionHandler"/>
         <section type="System.Configuration.NameValueSectionHandler" />
     </configSections>
    
     <Test1 setting1="Hello" setting2="World"/>
     <Test2>
         <add key="Hello" value="World" />
     </Test2>
     <Test3>
         <add key="Hello" value="World" />
     </Test3>    
</configuration>



我们对上面的自定义配置节进行说明。在声明部分使用<section type="System.Configuration.SingleTagSectionHandler"/>声明了一个配置节它的名字叫Test1，类型为SingleTagSectionHandler。在设置配置节部分使用 <Test1 setting1="Hello" setting2="World"/>设置了一个配置节，它的第一个设置的值是Hello，第二个值是World，当然还可以有更多。其它的两个配置节和这个类似。
下面我们看在程序中如何访问这些自定义的配置节。我们用过ConfigurationSettings类的静态方法GetConfig来获取自定义配置节的信息。

public static object GetConfig(string sectionName);

下面是访问这三个配置节的代码：


//访问配置节Test1
IDictionary IDTest1 = (IDictionary)ConfigurationSettings.GetConfig("Test1");
string str = (string)IDTest1["setting1"] +" "+(string)IDTest1["setting2"];
MessageBox.Show(str);         //输出Hello World

//访问配置节Test1的方法2
string[] values1=new string[IDTest1.Count];
IDTest1.Values.CopyTo(values1,0);
MessageBox.Show(values1[0]+" "+values1[1]);     //输出Hello World

//访问配置节Test2
IDictionary IDTest2 = (IDictionary)ConfigurationSettings.GetConfig("Test2");
string[] keys=new string[IDTest2.Keys.Count];
string[] values=new string[IDTest2.Keys.Count];
IDTest2.Keys.CopyTo(keys,0);
IDTest2.Values.CopyTo(values,0);
MessageBox.Show(keys[0]+" "+values[0]);

//访问配置节Test3
NameValueCollection nc=(NameValueCollection)ConfigurationSettings.GetConfig("Test3");
MessageBox.Show(nc.AllKeys[0].ToString()+" "+nc["Hello"]);     //输出Hello World
通过上面的代码我们可以看出，不同的type通过GetConfig返回的类型不同，具体获得配置内容的方式也不一样。

配置节处理程序
返回类型

SingleTagSectionHandler
Systems.Collections.IDictionary

DictionarySectionHandler
Systems.Collections.IDictionary

NameValueSectionHandler
Systems.Collections.Specialized.NameValueCollection


3.2 自定义配置节组
配置节组是使用<sectionGroup>元素，将类似的配置节分到同一个组中。配置节组声明部分将创建配置节的包含元素，在<configSections>元素中声明配置节组，并将属于该组的节置于<sectionGroup>元素中。下面是一个包含配置节组的配置文件的例子：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
     <configSections>
         <sectionGroup >
             <section type="System.Configuration.NameValueSectionHandler"/>
         </sectionGroup>
     </configSections>
    
     <TestGroup>
         <Test>
             <add key="Hello" value="World"/>
         </Test>
     </TestGroup>
</configuration>
下面是访问这个配置节组的代码：
NameValueCollection nc=(NameValueCollection)ConfigurationSettings.GetConfig("TestGroup/Test");
MessageBox.Show(nc.AllKeys[0].ToString()+" "+nc["Hello"]);     //输出Hello World

配置App.config


1. 向项目添加app.config文件：

右击项目名称，选择“添加”→“添加新建项”，在出现的“添加新项”对话框中，选择“添加应用程序配置文件”；如果项目以前没有配置文件，则默认的文件名称为“app.config”，单击“确定”。出现在设计器视图中的app.config文件为：

<?xmlversion="1.0"encoding="utf-8" ?>
<configuration>
</configuration>

在项目进行编译后，在binDebuge文件下，将出现两个配置文件(以本项目为例)，一个名为“JxcManagement.EXE.config”，另一个名为“JxcManagement.vshost.exe.config”。第一个文件为项目实际使用的配置文件，在程序运行中所做的更改都将被保存于此；第二个文件为原代码“app.config”的同步文件，在程序运行中不会发生更改。

2.  connectionStrings配置节：

请注意：如果您的SQL版本为2005 Express版，则默认安装时SQL服务器实例名为localhostSQLExpress，须更改以下实例中“Data Source=localhost;”一句为“Data Source=localhostSQLExpress;”，在等于号的两边不要加上空格。

<!--数据库连接串-->
     <connectionStrings>
         <clear />
         <addname="conJxcBook" connectionString="Data Source=localhost;Initial Catalog=jxcbook;User                                     providerName="System.Data.SqlClient" />
     </connectionStrings>

3. appSettings配置节：

appSettings配置节为整个程序的配置，如果是对当前用户的配置，请使用userSettings配置节，其格式与以下配置书写要求一样。

<!--进销存管理系统初始化需要的参数-->
     <appSettings>
         <clear />
         <addkey="userName"value="" />
         <addkey="password"value="" />
         <addkey="Department"value="" />
         <addkey="returnValue"value="" />
         <addkey="pwdPattern"value="" />
         <addkey="userPattern"value="" />
</appSettings>

4.读取与更新app.config

请注意：要使用以下的代码访问app.config文件，除添加引用System.Configuration外，还必须在项目添加对System.Configuration.dll的引用。

4.1 读取connectionStrings配置节

///<summary>
///依据连接串名字connectionName返回数据连接字符串
///</summary>
///<param ></param>
///<returns></returns>
private static string GetConnectionStringsConfig(string connectionName)
{
string connectionString =
        ConfigurationManager.ConnectionStrings[connectionName].ConnectionString.ToString();
    Console.WriteLine(connectionString);
    return connectionString;
}

4.2 更新connectionStrings配置节

///<summary>
///更新连接字符串
///</summary>
///<param >连接字符串名称</param>
///<param >连接字符串内容</param>
///<param >数据提供程序名称</param>
private static void UpdateConnectionStringsConfig(string newName, string newConString, string newProviderName)
{
    bool isModified = false;    //记录该连接串是否已经存在
    //如果要更改的连接串已经存在
    if (ConfigurationManager.ConnectionStrings[newName] != null)
    {
        isModified = true;
    }
    //新建一个连接字符串实例
    ConnectionStringSettings mySettings =
        new ConnectionStringSettings(newName, newConString, newProviderName);
    // 打开可执行的配置文件*.exe.config
    Configuration config =
        ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
    // 如果连接串已存在，首先删除它
    if (isModified)
    {
        config.ConnectionStrings.ConnectionStrings.Remove(newName);
    }
    // 将新的连接串添加到配置文件中.
    config.ConnectionStrings.ConnectionStrings.Add(mySettings);
    // 保存对配置文件所作的更改
    config.Save(ConfigurationSaveMode.Modified);
    // 强制重新载入配置文件的ConnectionStrings配置节
    ConfigurationManager.RefreshSection("ConnectionStrings");
}

4.3 读取appStrings配置节

///<summary>
///返回＊.exe.config文件中appSettings配置节的value项
///</summary>
///<param ></param>
///<returns></returns>
private static string GetAppConfig(string strKey)
{
    foreach (string key in ConfigurationManager.AppSettings)
    {
        if (key == strKey)
        {
            return ConfigurationManager.AppSettings[strKey];
        }
    }
    return null;
}

4.4 更新connectionStrings配置节

///<summary>
///在＊.exe.config文件中appSettings配置节增加一对键、值对
///</summary>
///<param ></param>
///<param ></param>
private static void UpdateAppConfig(string newKey, string newValue)
{
    bool isModified = false;    
    foreach (string key in ConfigurationManager.AppSettings)
    {
       if(key==newKey)
        {    
            isModified = true;
        }
    }

    // Open App.Config of executable
    Configuration config =
        ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
    // You need to remove the old settings object before you can replace it
    if (isModified)
    {
        config.AppSettings.Settings.Remove(newKey);
    }    
    // Add an Application Setting.
    config.AppSettings.Settings.Add(newKey,newValue);   
    // Save the changes in App.config file.
    config.Save(ConfigurationSaveMode.Modified);
    // Force a reload of a changed section.
    ConfigurationManager.RefreshSection("appSettings");
}