首页 > 代码库 > App.Config详解
App.Config详解
配置文件的根节点是configuration。我们经常访问的是appSettings,它是由.Net预定义配置节。我们经常使用的配置文件的架构是象下面的形式。
先大概有个印象,通过后面的实例会有一个比较清楚的认识。下面的“配置节”可以理解为进行配置一个XML的节点。
1. 向项目添加 app.config 文件:
<!-- 数据库连接串 --> < connectionStrings > < clear /> < add name = "conJxcBook " connectionString = "Data Source=localhost;Initial Catalog=jxcbook;User
ID=sa;password=******** " providerName = "System.Data.SqlClient " /> </ connectionStrings >
< appSettings > < clear /> < add key = "userName "value = http://www.mamicode.com/"" /> < add key = "password "value = http://www.mamicode.com/"" /> < add key = "Department "value = http://www.mamicode.com/"" /> < add key = "returnValue "value = http://www.mamicode.com/"" /> < add key = "pwdPattern "value = http://www.mamicode.com/"" /> < add key = "userPattern "value = http://www.mamicode.com/"" /></ appSettings >
/// <summary>/// 依据连接串名字connectionName返回数据连接字符串/// </summary>/// <param name="connectionName"></param>/// <returns></returns>private static string GetConnectionStringsConfig(string connectionName){string connectionString = ConfigurationManager .ConnectionStrings[connectionName].ConnectionString.ToString(); Console .WriteLine(connectionString); return connectionString;}
/// <summary>/// 更新连接字符串/// </summary>/// <param name="newName"> 连接字符串名称 </param>/// <param name="newConString"> 连接字符串内容 </param>/// <param name="newProviderName"> 数据提供程序名称 </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" );}
/// <summary>/// 返回*.exe.config文件中appSettings配置节的value项/// </summary>/// <param name="strKey"></param>/// <returns></returns>private static string GetAppConfig(string strKey){ foreach (string key in ConfigurationManager .AppSettings) { if (key == strKey) { return ConfigurationManager .AppSettings[strKey]; } } return null ;}
/// <summary>/// 在*.exe.config文件中appSettings配置节增加一对键、值对/// </summary>/// <param name="newKey"></param>/// <param name="newValue"></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" );}
读语句:
String str = ConfigurationManager.AppSettings["DemoKey"];
写语句:
Configuration cfa = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);cfa.AppSettings.Settings["DemoKey"].Value = http://www.mamicode.com/"DemoValue";cfa.Save();
配置文件内容格式:(app.config)
<?xml version="1.0" encoding="utf-8" ?><configuration><appSettings><add key="DemoKey" value=http://www.mamicode.com/"*" /></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 = http://www.mamicode.com/"name";
等等...
最后调用
cfa.Save();
当前的配置文件更新成功。
*****************************************************************************************************************
读写配置文件app.config
在.Net中提供了配置文件,让我们可以很方面的处理配置信息,这个配置是XML格式的。而且.Net中已经提供了一些访问这个文件的功能。
1、读取配置信息
下面是一个配置文件的具体内容:
<?xml version="1.0" encoding="utf-8"?><configuration><appSettings><add key="ConnenctionString" value=http://www.mamicode.com/"*" /><add key="TmpPath" value=http://www.mamicode.com/"C:\Temp" /></appSettings></configuration>
.net提供了可以直接访问<appsettings>(注意大小写)元素的方法,在这元素中有很多的子元素,这些子元素名称都是 “add”,有两个属性分别是“key”和“value”。一般情况下我们可以将自己的配置信息写在这个区域中,通过下面的方式进行访问:
string ConString=System.Configuration .ConfigurationSettings.AppSettings["ConnenctionString"];
在appsettings后面的是子元素的key属性的值,例如appsettings["connenctionstring"],我们就是访 问<add key="ConnenctionString" value="http://www.mamicode.com/*" />这个子元素,它的返回值就是“*”,即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=http://www.mamicode.com/="ConnectionString") { //对目标元素中的第二个属性赋值 att=nodes[i].Attributes["value"]; att.Value=ConnenctionString; break; } } //保存上面的修改 doc.Save(strFileName);}
<?xmlversion="1.0"encoding="utf-8" ?><configuration></configuration>
<!--数据库连接串--> <connectionStrings> <clear /> <addname="conJxcBook" connectionString="Data Source=localhost;Initial Catalog=jxcbook;User ID=sa;password=********" providerName="System.Data.SqlClient" /> </connectionStrings>
<appSettings> <clear /> <addkey="userName"value=http://www.mamicode.com/"" /> <addkey="password"value=http://www.mamicode.com/"" /> <addkey="Department"value=http://www.mamicode.com/"" /> <addkey="returnValue"value=http://www.mamicode.com/"" /> <addkey="pwdPattern"value=http://www.mamicode.com/"" /> <addkey="userPattern"value=http://www.mamicode.com/"" /></appSettings>
///<summary>///依据连接串名字connectionName返回数据连接字符串///</summary>///<param name="connectionName"></param>///<returns></returns>private static string GetConnectionStringsConfig(string connectionName){string connectionString = ConfigurationManager.ConnectionStrings[connectionName].ConnectionString.ToString(); Console.WriteLine(connectionString); return connectionString;}
///<summary>///更新连接字符串///</summary>///<param name="newName">连接字符串名称</param>///<param name="newConString">连接字符串内容</param>///<param name="newProviderName">数据提供程序名称</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");}
///<summary>///返回*.exe.config文件中appSettings配置节的value项///</summary>///<param name="strKey"></param>///<returns></returns>private static string GetAppConfig(string strKey){ foreach (string key in ConfigurationManager.AppSettings) { if (key == strKey) { return ConfigurationManager.AppSettings[strKey]; } } return null;}
///<summary>///在*.exe.config文件中appSettings配置节增加一对键、值对///</summary>///<param name="newKey"></param>///<param name="newValue"></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");}
Win应用程序下调用App.config
新建一个winform应用程序,类似webform下有个web.config,winform下也有个app.config;不过app.config不是自动生成的需要手动添加,鼠标右健解决方案—〉添加—〉添加新项—〉添加app.config文件。
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="connString" value=http://www.mamicode.com/" server=local;uid=sa;pwd=sa;database=Northwind" /> </appSettings></configuration>
using System;using System.Drawing;using System.Collections;using System.ComponentModel;using System.Windows.Forms;using System.Data;using System.Configuration;
private void btnMessage_Click(object sender, System.EventArgs e) { string message=ConfigurationSettings.AppSettings["connString"]; MessageBox.Show(message); }
App.Config详解