C#读取自定义配置节点
应用程序配置文件是标准的 XML 文件,XML 标记和属性是区分大小写的。它是可以按需要更改的,开发人员可以使用配置文件来更改设置,而不必重编译应用程序。配置文件的根节点是 configuration。我们经常访问的是appSettings,它是由.Net预定义配置节。我们经常使用的配置文件的架构是象下面的形式。先大 概有个印象,通过后面的实例会有一个比较清楚的认识。下面的“配置节”可以理解为进行配置一个XML的节点。常见配置文件模式:
﹤configuration﹥
﹤configSections﹥//配置节声明区域,包含配置节和命名空间声明
﹤section﹥//配置节声明
﹤sectionGroup﹥//定义配置节组
﹤section﹥//配置节组中的配置节声明
﹤appSettings﹥//预定义配置节
﹤Custom element for configuration section﹥ //配置节设置区域
﹤connectionString﹥ //数据库连接字符串
下面是一个最常见的应用程序配置文件的例子,只有appSettings节。
﹤?xml version="1.0" encoding="utf-8"?﹥
﹤configuration﹥
﹤appSettings﹥
﹤add key="connectionstring" value="User ID=sa;Data Source=.;Password=;/﹥
﹤add key="TemplatePATH" value="Template" /﹥
﹤/appSettings﹥
﹤/configuration﹥
下面看看如何用C#代码读取自定义节点:
_connectionString=ConfigurationSettings.AppSettings["connectionstring"];
使用ConfigurationSettings类的静态属性AppSettings就可以直接方法配置文件中的配置信息。这个属性的类型是NameValueCollection。
用户自定义配置节点
一个用户自定义的配置节,在配置文件中分为两部分:一是在﹤configSections﹥﹤/ configSections﹥配置节中声明配置节(上面配置文件模式中的“﹤section﹥”),另外是在﹤ configSections﹥﹤/ configSections ﹥之后设置配置节(上面配置文件模式中的“﹤Custom element for configuration section﹥”),有点类似一个变量先声明,后使用一样。声明一个配置文件的语句如下:
﹤section name=" " 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 name="Test1" type="System.Configuration.SingleTagSectionHandler"/﹥
﹤section name="Test2" type="System.Configuration.DictionarySectionHandler"/﹥
﹤section name="Test3" 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 name="Test1" type="System.Configuration.SingleTagSectionHandler"/﹥声明了一个配置节它的名字叫 Test1,类型为SingleTagSectionHandler。在设置配置节部分使用﹤Test1 setting1="Hello" setting2="World"/﹥设置了一个配置节,它的第一个设置的值是Hello,第二个值是World,当然还可以有更多。其它的两个配 置节和这个类似。
下面我们看在程序中如何访问这些自定义的配置节。我们用过ConfigurationSettings类的静态方法GetConfig来获取自定义配置节的信息。
public static object GetConfig(string sectionName);
C#读取配置文件之访问配置节的代码:
//访问配置节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返回的类型不同,具体获得配置内容的方式也不一样。 配置节处理程序
返回类型
1. SingleTagSectionHandler
2. Systems.Collections.IDictionary
3.
4. DictionarySectionHandler
5. Systems.Collections.IDictionary
6.
7. NameValueSectionHandler
8. Systems.Collections.Specialized.NameValueCollection
3.2 自定义配置节组
配置节组是使用﹤sectionGroup﹥元素,将类似的配置节分到同一个组中。配置节组声明部分将创建配置节的包含元素,在﹤configSections﹥元素中声明配置节组,并将属于该组的节置于﹤ sectionGroup﹥元素中。下面是一个包含配置节组的配置文件的例子:
1. ﹤?xml version="1.0" encoding="utf-8" ?﹥
2. ﹤configuration﹥
3. ﹤configSections﹥
4. ﹤sectionGroup name="TestGroup"﹥
5. ﹤section name="Test" type="System.Configuration.NameValueSectionHandler"/﹥
6. ﹤/sectionGroup﹥
7. ﹤/configSections﹥
8.
9. ﹤TestGroup﹥
10.﹤Test﹥
11.﹤add key="Hello" value="World"/﹥
12.﹤/Test﹥
- ﹤/TestGroup﹥
14.﹤/configuration﹥
C#读取配置文件之访问配置节组的代码:
1. NameValueCollection nc=(NameValueCollection)ConfigurationSettings.GetConfig("TestGroup/Test");
MessageBox.Show(nc.AllKeys[0].ToString()+" "+nc["Hello"]);
我们对上面的自定义配置节进行说明。在声明部分使用﹤section name="Test1" type="System.Configuration.SingleTagSectionHandler"/﹥声明了一个配置节它的名字叫 Test1,类型为SingleTagSectionHandler。在设置配置节部分使用﹤Test1 setting1="Hello" setting2="World"/﹥设置了一个配置节,它的第一个设置的值是Hello,第二个值是World,当然还可以有更多。其它的两个配 置节和这个类似。
下面我们看在程序中如何访问这些自定义的配置节。我们用过ConfigurationSettings类的静态方法GetConfig来获取自定义配置节的信息。
1. public static object GetConfig(string sectionName);
C#读取配置文件之访问配置节的代码:
1. //访问配置节Test1
2. IDictionary IDTest1 = (IDictionary)ConfigurationSettings.GetConfig("Test1");
3. string str = (string)IDTest1["setting1"] +" "+(string)IDTest1["setting2"];
4. MessageBox.Show(str);//输出Hello World
5.
6. //访问配置节Test1的方法2
7. string[] values1=new string[IDTest1.Count];
8. IDTest1.Values.CopyTo(values1,0);
9. MessageBox.Show(values1[0]+" "+values1[1]); //输出Hello World
10.
11.//访问配置节Test2
12.IDictionary IDTest2 = (IDictionary)ConfigurationSettings.GetConfig("Test2");
13.string[] keys=new string[IDTest2.Keys.Count];
14.string[] values=new string[IDTest2.Keys.Count];
15.IDTest2.Keys.CopyTo(keys,0);
16.IDTest2.Values.CopyTo(values,0);
17.MessageBox.Show(keys[0]+" "+values[0]);
18.
19.//访问配置节Test3
20.NameValueCollection nc=(NameValueCollection)ConfigurationSettings.GetConfig("Test3");
21.MessageBox.Show(nc.AllKeys[0].ToString()+" "+nc["Hello"]); //输出Hello World
通过上面的代码我们可以看出,不同的type通过GetConfig返回的类型不同,具体获得配置内容的方式也不一样。 配置节处理程序
返回类型
1. SingleTagSectionHandler
2. Systems.Collections.IDictionary
3.
4. DictionarySectionHandler
5. Systems.Collections.IDictionary
6.
7. NameValueSectionHandler
8. Systems.Collections.Specialized.NameValueCollection
3.2 自定义配置节组
配置节组是使用﹤sectionGroup﹥元素,将类似的配置节分到同一个组中。配置节组声明部分将创建配置节的包含元素,在﹤configSections﹥元素中声明配置节组,并将属于该组的节置于﹤ sectionGroup﹥元素中。下面是一个包含配置节组的配置文件的例子:
1. ﹤?xml version="1.0" encoding="utf-8" ?﹥
2. ﹤configuration﹥
3. ﹤configSections﹥
4. ﹤sectionGroup name="TestGroup"﹥
5. ﹤section name="Test" type="System.Configuration.NameValueSectionHandler"/﹥
6. ﹤/sectionGroup﹥
7. ﹤/configSections﹥
8.
9. ﹤TestGroup﹥
10.﹤Test﹥
11.﹤add key="Hello" value="World"/﹥
12.﹤/Test﹥
13. ﹤/TestGroup﹥
14.﹤/configuration﹥
C#读取配置文件之访问配置节组的代码:
1. NameValueCollection nc=(NameValueCollection)ConfigurationSettings.GetConfig("TestGroup/Test");
MessageBox.Show(nc.AllKeys[0].ToString()+" "+nc["Hello"]);