一个关于ConfigurationManager.GetSecion方法的小问题

昨天在进行Code Review的时候,发现一个关于配置节读取的问题。虽然这是一个很小的问题,还是它已经存在在项目里面很久了,直到今天才被发现,所以觉得具有一定分享的价值。

闲话少说,我们直接通过一个小例子来模拟发现的这个Bug。项目中自定义了一个配置节(ConfigurationSection),作为模拟,我们定义了如下一个简单TestConfigurationSection类。TestConfigurationSection继承自ConfigurationSection,具有唯一的一个必需(IsRequired=true)配置属性Type,我们在这里设置一个类型的有效名称。

   1: public class TestConfigurationSection : ConfigurationSection
   2: {
   3:     [ConfigurationProperty("type", IsRequired = true)]
   4:     public string Type
   5:     {
   6:         get { return (string)this["type"]; }
   7:     }
   8: }

在程序中,需要读取配置,根据type配置项动态创建对应的实例。为了确保配置节的存在,我们对通过ConfigurationManager.GetSection方法获取出来的对象进行了空值校验。程序很简单,貌似没有什么问题。

   1: static void Main(string[] args)
   2: {
   3:     var config = ConfigurationManager.GetSection("artech.testSettings") as TestConfigurationSection;
   4:     if(null == config)
   5:     {
   6:         throw new ConfigurationErrorsException("Miss configuration...");
   7:     }
   8:     var instance = Activator.CreateInstance(Type.GetType(config.Type));
   9: }

下面是我们的配置:我们仅仅在<configSections/>节点添加了我们自定义的TestConfigurationSection配置节类型,并没有进行真正的配置(被注释掉的那部分)。

   1: <?xml version="1.0"?>
   2: <configuration>
   3:   <configSections>
   4:     <section name="artech.testSettings" type="Artech.CustomConfig.TestConfigurationSection, Artech.CustomConfig"/>
   5:   </configSections>
   6:   <!--<artech.testSettings type="System.Int32"/>-->
   7: </configuration>

现在运行上面的程序,抛出如下一个ArgumentNullExcption异常,从异常消息我们不难看出,是由于config的Type属性为Null导致的(因为没有配置)。

image

 

也就是说,只要<configSections/>存在具有指定名称的配置节配置,它就认为是配置节存在。ConfigurationManager.GetSection方法也会真正返回一个对应的类型的ConfigurationSection对象。在这种情况下,配置元素的默认值(通过ConfigurationPropertyAttribute的DefaultValue属性定义)会反映在该ConfigurationSection对象上,所以不会有什么问题。比较麻烦就是例子中的那些必需(通过ConfigurationPropertyAttribute的IsRequired属性定义)配置属性,你认为一定有个确定的值,那么的程序可能就因为这个而不能运行。

各位可以发表各自的看法,ConfigurationManager的GetSection方法是否应该在真正的配置元素不存在的时候返回Null呢?

posted @ 2011-01-15 15:27  Artech  阅读(...)  评论(...编辑  收藏