Configuration Manager 随笔

     一直习惯于用xml的Xpath来管理配置文件,最近看了下ConfigurationManager的文档,感觉还是很不错,用Configuration Manager 没有直接处理xml自由,但更方便快捷.封装了很多基本读写功能.省时省力.

     Configuration Manager需要用到库,system.Configuration,如果没有的话,需要先去引用.Net组件System.Configuration

     初始化Config

//这里为默认的app.config Configuration config = ConfigurationManager.OpenExeConfiguration() //如果要初始化自定义的configfile则采用 string filePath; ExeConfigurationFileMap file=new ExeConfigurationFileMap (); file.ExeConfigFilename =filePath ; config = ConfigurationManager.OpenMappedExeConfiguration(file,ConfigurationUserLevel.None);

   

 

    定义节点

    configuration 是把config文件里的element定义为一个section,然后把这个section实例化为定义好的section类,element里的属性在程序里调用就是调用section类,十分简单.如下,为一个示范section类

    public class DbConnectSection:ConfigurationSection { [ConfigurationProperty("dataConnection")] public string DataConnection { get { return this["dataConnection"].ToString (); } set { this["dataConnection"] = value; } } [ConfigurationProperty("test")] public int Test { get { return (int)this["test"]; } set { this["test"] = value; } } }

  这里需要注意的是ConfigurationProperty里的字符要跟属性里的字符一摸一样,区分大小写.

调用节点

   根据section name来判断section有没有已存在,如果不存在的话就添加一个section.存在的话就调用它,代码如下:

string sectionName="dbConnect1"; DbConnectSection sec=null; try { sec = config.Sections[sectionName]; } catch { config.Sections.Remove(sectionName); } if (sec == null) { DbConnectSection db = new DbConnectSection (); config.Sections.Add(sectionName, db); sec = db; } return sec;

如果需要把section放在sectionGroup里面的话,就定义一个SectionGroup,并add到config里.

 

读写节点

    读写节点就更简单了,section作为1个class,我们调用节点的时候就是获得了这个class的实例,象普通的类一样,我们直接读写里面的属性,类似 sec.Test=123; int i=sec.Test ;   保存的时候调用config.Save()就可以了;

   注意:如果config在读写的时候有其他程序修改了config,将会引起出错,所以我们最好使用singleton模式.

具体使用

    最后还是来段简单的代码来看下Configuration Manager的实用

 

   4个类SettingConfig 对应config文件,DbconnectionSection对应config上的一个section以及ConfigManager和program类

    DbconnectionSection.cs:

   class DbConnectSection:ConfigurationSection { [ConfigurationProperty("dataConnection")] public string DataConnection { get { return this["dataConnection"].ToString (); } set { this["dataConnection"] = value; } } [ConfigurationProperty("test")] public int Test { get { return (int)this["test"]; } set { this["test"] = value; } } }  

   ConfigManager.cs

   class ConfigManager { public static Configuration GetConfigFile(string filePath) { ExeConfigurationFileMap file = new ExeConfigurationFileMap(); file.ExeConfigFilename = filePath; Configuration config = ConfigurationManager.OpenMappedExeConfiguration(file, ConfigurationUserLevel.None); return config; } public static T GetConfigSection<T>(Configuration config, string sectionName)where T:ConfigurationSection ,new() { ConfigurationSection sec=null; try { sec = config.Sections[sectionName]; } catch { config.Sections.Remove(sectionName); } if (sec == null) { T t = new T(); config.Sections.Add(sectionName, t); sec = t; } return sec as T; } }

SettingConfig.cs 实用singleton模式,

   class SettingConfig { const string configPath=@"Config/Setting.Config"; const string DbConnectSectionName = "DbConnect"; Configuration configFile; private static SettingConfig _currentConfig; public static SettingConfig CurrentConfig { get { if (_currentConfig == null) _currentConfig = new SettingConfig(); return _currentConfig; } } public DbConnectSection DbConnectSection { get { DbConnectSection sec = ConfigManager.GetConfigSection<DbConnectSection>(configFile, DbConnectSectionName); return sec; } } private SettingConfig() { configFile = ConfigManager.GetConfigFile(configPath); } public void Save() { if (configFile != null) configFile.Save(); } }

program.cs 运行读写.

  public class Program { public static void Main() { //write SettingConfig sets = SettingConfig.CurrentConfig; sets.DbConnectSection.Test = 2009; sets.DbConnectSection.DataConnection = "Data source=.;Initial Catalog=Common;Integrated Security=true"; sets.Save(); //read Console.WriteLine(sets.DbConnectSection.Test); } }

 

 

总结

   Configuration Manager真的很简单易用,没什么可写的.我用的时候感觉有一点需要注意的 就是如果程序版本升级的时候,section class把某个旧的属性去掉,而config文件还是旧的的话,将会报错,找不到section.