读取应用程序/类库配置文件(比如***.dll.config)的方法小结

最新推荐文章于 2024-01-24 22:07:09 发布

戴誉杰

最新推荐文章于 2024-01-24 22:07:09 发布

阅读量865

点赞数

分类专栏： asp.net

asp.net 专栏收录该内容

31 篇文章 0 订阅

订阅专栏

[总结]读取应用程序/类库配置文件(比如***.dll.config)的方法小结

0.引子

读取应用程序配置文件(比如***.exe.config)的方法有很多, .NET自带的ConfigurationManager也很方便. 这篇文章主要探讨类库生成的dll文件的配置信息的读取——特别地, 用户自定义SectionGroupName和SectionName(这里是指不同于appSettings的形式), 这种方式配置信息的读取. 配置文件格式举例(其实通过添加"设置文件", 注意:不是"应用程序配置文件")

 
     
   
 
    <? 
    xml version="1.0" encoding="utf-8"  
    ?> 
    
  
    < 
    configuration 
    > 
    
    
    < 
    configSections 
    > 
    
      
    < 
    sectionGroup  
    name 
    ="userSettings" 
     type 
    ="System.Configuration.UserSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" 
      
    > 
    
        
    < 
    section  
    name 
    ="TestDllConfig.Test" 
     type 
    ="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" 
     allowExeDefinition 
    ="MachineToLocalUser" 
     requirePermission 
    ="false" 
      
    /> 
    
      
    </ 
    sectionGroup 
    > 
    
      
    < 
    sectionGroup  
    name 
    ="applicationSettings" 
     type 
    ="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" 
      
    > 
    
        
    < 
    section  
    name 
    ="TestDllConfig.Test" 
     type 
    ="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" 
     requirePermission 
    ="false" 
      
    /> 
    
      
    </ 
    sectionGroup 
    > 
    
    
    </ 
    configSections 
    > 
    
    
    < 
    userSettings 
    > 
    
      
    < 
    TestDllConfig.Test 
    > 
    
        
    < 
    setting  
    name 
    ="ACCESSORY_TYPE" 
     serializeAs 
    ="String" 
    > 
    
          
    < 
    value 
    > 
    ACCESSORY 
    </ 
    value 
    > 
    
        
    </ 
    setting 
    > 
    
      
    </ 
    TestDllConfig.Test 
    > 
    
    
    </ 
    userSettings 
    > 
    
    
    < 
    applicationSettings 
    > 
    
      
    < 
    TestDllConfig.Test 
    > 
    
        
    < 
    setting  
    name 
    ="APPLICATION_NAME" 
     serializeAs 
    ="String" 
    > 
    
          
    < 
    value 
    > 
    JGPT 
    </ 
    value 
    > 
    
        
    </ 
    setting 
    > 
    
        
    < 
    setting  
    name 
    ="DATABASE_NAME" 
     serializeAs 
    ="String" 
    > 
    
          
    < 
    value 
    > 
    JGPT 
    </ 
    value 
    > 
    
        
    </ 
    setting 
    > 
    
        
    < 
    setting  
    name 
    ="APP_ATTACHMENT_PATH" 
     serializeAs 
    ="String" 
    > 
    
          
    < 
    value 
    > 
    ~//APP_ATTACHMENT// 
    </ 
    value 
    > 
    
        
    </ 
    setting 
    > 
    
      
    </ 
    TestDllConfig.Test 
    > 
    
    
    </ 
    applicationSettings 
    > 
    
  
    </ 
    configuration 
    > 
   
 
     
   

首先, 交代一些东西. 1.不讨论为类库dll文件设置配置文件是否有必要, 我主要的出发点是, 一些参数可以通过读取配置文件得到, 从而不用重新编译类库; 2.本文实现的环境是: visual studio 2005/.net 2.0;3.dll配置信息类库内部要用到, 外部也可能用到.

1.首先, 新建一个空的项目解决方案. 并添加一个类库项目(空的即可, 示例中命名为TestDllConfig). 然后再添加一个空的控制台项目(测试输出用途, 示例中命名为ReadDllConfig).

到目前为止, 做好了准备工作. 接下来为类库添加配置文件. 右键类库项目, 选择添加-新建项-选择"设置文件"-命名为Test.settings. 如下图所示:

接着, 双击新添加的设置文件, 添加参数和值. 如下图:

都是测试用的参数数据. 例子中用到的范围为Application, 范围中Application和User的选择会导致SectionGroup不一样. 保存, .NET就会自动生成一个app.config. 另外可以看到有个Test.Designer.cs 文件, 是保存的时候自动生成的(这个文件后面会说到). 打开app.config, 会看到和上面的xml代码一样.

到目前为止, 我们已经完成了搭架子的工作, 我们还没手工写一行代码. 下面就通过往类库里添加读取配置信息的代码, 和测试项目中控制台输出测试结果代码.

2. 往类库中添加读取配置信息的代码

首先大家可以读下园子里这两篇博文:

http://www.cnblogs.com/bearhand/archive/2008/09/07/1279087.html

http://www.cnblogs.com/rosanshao/archive/2008/09/07/1286191.html

这两篇说到了.NET 2.0下新增读取配置文件的方法: ConfigurationManager类

下面先给出读取配置文件路径的帮助方法(至于为什么要封装一遍, 注释里有写; 同时为了测试方便):

 
    /// 
      
    <summary> 
    
    /// 
     封装多一遍, 确保调用本方法的方法为Dll内部方法, 从而取得正确的Dll配置文件路径
          
    /// 
     否则可能取得的是执行程序(主程序)的路径
          
    /// 
     详细参考Assembly.GetCallingAssembly()的原理
          
    /// 
      
    </summary> 
    
    private 
      
    static 
      
    string 
     DllConfigFilePath
         {
              
    get 
    
             {
                 Assembly t_assembly  
    = 
     Assembly.GetCallingAssembly();
                 Uri t_uri  
    = 
      
    new 
     Uri(Path.GetDirectoryName(t_assembly.CodeBase));
 
    // 
    NOTE: 这个时候读取的路径是应用程序/网站下面的bin目录, 或者应用程序/网站编译运行dll的目录(自定义输出路径的情况)
                  
    // 
    而不是类库的生成dll的输出路径! 
                  
    // 
    所以, 如果采用引用项目的方式引用, 要将配置文件一同复制到和dll同个目录(bin目录), 否则读取不到配置信息; 修改配置
                  
    // 
    文件后同样记得此目录下覆盖原文件 
    
    return 
     Path.Combine(t_uri.LocalPath, t_assembly.GetName().Name  
    + 
      
    " 
    .dll.config 
    " 
    );
             }
         }

下面这段代码是常用的读取自定义配置信息的方法, 返回Configuration类型:

 
  代码

通过查看程序自动生成的配置文件, 知道SectionGroupName和SectionName, 定义属性:

 
  代码

对于以上代码, 网上常见都是如此处理(.NET 1.1一般XML操作, 后面也会说到). 现在开始我们的各种情况说明了.

2.1 直接使用Configuration.AppSettings方式读取配置的情况

 
  代码

说明: 上面的参数名"DATABASE_NAME_By_AppSettings" 直接拷贝项目代码, 大家可以换成自动生成的设置文件中有的名称:

"DATABASE_NAME ". 结果是一样的.

很显然, 直接在控制台项目中

System.Console.WriteLine(TestDllConfig.DllConfig.DATABASE_NAME_By_AppSettings);

Debug可以发现CurrentDllConfiguration.AppSettings.Settings 不为null, 但是CurrentDllConfiguration.AppSettings.Settings.Count == 0; 通过多次debug以及在配置文件中添加以下代码:

再次运行就可以读取到数据了. 说明AppSettings默认读取的是<appSettings></appSettings>内的配置信息. 如果我们要读取类似程序自动生成的配置信息怎么办呢? 先不急, 先提醒下大家一个小问题. 用这种方式读取数据, 需要注意和平常读取Web.Config配置信息不太一样(平时可以直接通过[]读取)

NOTE2: 读取指定key的值value必须使用appConfig.AppSettings.Settings["APPLICATION_NAME"].Value方式;
不能使用appConfig.AppSettings["APPLICATION_NAME"]方式, 否则编译器会提示
"错误“System.Configuration.ConfigurationElement.this[System.Configuration.ConfigurationProperty]”不可访问，因为它受保护级别限制"

2.2 Configuration类型转换为KeyValueConfigurationCollection 或者 NameValueCollection 类型的情况

这个没什么好说的, 编译器报错.

 
    /// 
      
    <summary> 
    
    /// 
     以下方式编译器会报错
          
    /// 
     cs as KeyValueConfigurationCollection 或者 cs as NameValueCollection 编译器会提示:
          
    /// 
     错误    无法通过内置转换将类型“System.Configuration.ConfigurationSection”转换为 ***类型
          
    /// 
      
    </summary> 
    
    // 
    public static KeyValueConfigurationCollection DllSettings_NameValueCollection
          
    // 
    {
          
    // 
        get
          
    // 
        {
          
    // 
            ConfigurationSection cs = CurrentDllConfiguration.GetSection(FullSectionName);
          
    // 
            return cs as KeyValueConfigurationCollection;  
    // 
    或者 cs as NameValueCollection 
          
    // 
        }
          
    // 
    }

2.3 Configuration类型转换为AppSettingsSection类型的情况

这个和上面稍微有点不同, 编译无提示错误, 但转换后为null.

 
  代码

2.4 Configuration类型转换为自定义配置信息数据结构的情况

这段代码也是很常见的啦. 不多说了, 结果和转换为AppSettingsSection的情形一样: 编译无提示错误, 但转换后为null.

这种做法可以参考

http://stackoverflow.com/questions/204695/storing-values-in-the-web-config-appsettings-or-configsection-which-is-more-e

http://haacked.com/archive/2007/03/12/custom-configuration-sections-in-3-easy-steps.aspx

看以上例子, 发现人家能测试成功, 就是不知道为什么我的例子失败 :-(. anyway, 挫折多点也好, 可以学到更多东西, 特别是对于执着的人.

 
  代码

2.5 Configuration类型转换为ClientSettingsSection类型的情况

经过以上测试, 用google查找很多关于dll.config的设置文件读取的资料, 发现有例子将配置信息类型Configuration转换为ClientSettingsSection操作. 但是我测试发现还是有问题, 下面是代码:

 
  代码

不提示错误而且转换后也不为null, 但调用 .Settings["APPLICATION_NAME"] 提示:
错误 “System.Configuration.ConfigurationElement.this[System.Configuration.ConfigurationProperty]”不可访问，因为它受保护级别限制

这个错误很郁闷, 因为遇到很多次, 上次就是AppSettings["参数名"], 改为AppSettings.Settings["参数名"].Value就可以, 但是这里不行. 还是会有错误. 到这里, 再次查找很多资料, 发现不少老外也遇到这个问题没解决. 今天一个偶然机会, 看到帖子:

http://social.msdn.microsoft.com/forums/en-US/netfxbcl/thread/ec237df4-f05e-4711-a230-fb089c395c73/?prof=required

(根据微软网站以往的情况, 这个链接很可能以后会改变...)

OK. 下面就提出这个帖子中提到的3种可行的解决方案.

2.6 参考上面帖子nrolland的回复
接着2.5的问题,

转换为ClientSettingsSection类型后, 采用以下方式可以读取出数据:
System.Console.WriteLine(TestDllConfig.DllConfig.DllSettings_ClientSettingsSection.Settings.Get("APPLICATION_NAME").Value.ValueXml.InnerText);

很显然, 这种方案在类似ConfigurationManager的方式下调用, 但是还是有很明显的XML操作痕迹. 没办法, XML才是老本根, 谁叫设置文件采用xml格式呢.

2.7 经典的XML解决方案

上面的帖子回帖中就有人写了一段代码: (下面这段基本上是直接手工照敲一遍, 就是处理叶子节点稍微修改了下, 因为配置文件不一样嘛)