深入剖析 ASP.NET 1.x 中 Forms 身份验证

.NET 2.0 中的自定义配置处理

——编程模型

发布日期：2006-8-21 § 更新日期：2006-8-21

...

目录

1. 引言
2. 概述
3. 配置声明
4. 节点映射
5. 节点集合
6. 总结
7. 下载
8. 其他资源

引言

现代软件开发中，各种技术、技巧越来越依赖配置，譬如客户端对用户体验的个性化设置、系统的各种运行时参数设置、可插拔的插件机制、基于配置的IoC架构模式等。配置方式也从最初的二进制存储格式逐步过度到INI文本格式直至今时所广泛使用的Xml格式。使用Xml格式进行配置，大大提高了对设置数据的表现能力，但是在 .NET 1.x 中对Xml配置的操控还有诸多不便，尤其是对Xml配置的存储同步机制很不完善，而从 .NET 2.0 开始，框架提供了更丰富和易于操控使用的机制。

.NET 中的配置文件(Xml)必须以“<configuration>”为根节点，配置文件分为两大部分：配置声明区和数据设置区。

• 配置声明区：位于<configuration><configSections>内，通过<section>节点进行声明定义。
• 数据设置区：位于<configuration>根节点内除<configSections>以外的任意节点。

数据设置区可以是用户定义的任意结构层次，但是其“根节点”必须预先在设置声明区定义，运行时会进行有效性检测，一旦发现没有声明的配置节点则会产生一个运行时配置异常。

概述

在.NET 2.0中实现自定义配置，可以使用编程或声明性（属性化）代码编写模型创建自定义配置节。

• 编程模型。此模型要求为每个节属性 (Attribute) 创建一个用于获取和/或设置其值的属性 (Property)，并将其添加到基础 ConfigurationElement 基类的内部属性 (Property) 包中。
• 声明模型。这种比较简单的模型也称为属性 (Attribute) 化模型，允许您通过使用属性 (Property) 来定义节属性 (Attribute)，并使用属性 (Attribute) 对其进行修饰。

配置文件中的元素称为 基本XML元素 或 节。基本元素只是具有相关属性（如果有）的简单 XML 标记。节最简单的形式与基本元素一致。而复杂的节可以包括一个或多个基本元素、元素的集合以及其他节。

ConfigurationProperty 类表示配置节点中的特性(Attribute)或它的子元素，我们要做的就是通过 ConfigurationProperty 类将配置实体类中的属性(Property)映射到对应的节点特性(Attribute)。

配置声明

要在配置文件中使用自定义的配置数据，必须在声明区通过<section>节点对自定义配置节处理程序进行声明，该节点有两个必需属性：name 和 type。

• name 属性：指定与 type 属性中指定的配置节处理程序关联的配置节或元素的名称。这是该元素在配置文件的设置区中使用的名称。
• type 属性：指定用来处理 name 属性所指定的设置节的处理程序。使用如下格式：
  type="ConfigurationSectionHandlerClass, AssemblyFileName, Version, Culture, PublicKeyToken"
  如果对处理程序的版本没要求，或者其为无区域和强签名的程序集，则可以省略后面的三项，否则必须严格匹配版本。注意：程序集文件名不要带其扩展文件名（通常为.dll）。

范例配置文件中的配置声明定义如： <section name="dataSystems" type="SWSystem.Data.Configuration.DataSystemsSection, SWSystem.Data" /> 则表示数据设置区中的<dataSystems>节点由 SWSystem.Data.Configuration.DataSystemsSection 类进行处理，并且该类位于 SWSystem.Data 程序集中。

在 .NET 1.x 中要实现自定义的配置处理程序类，其必须实现 IConfigurationSectionHandler 接口，现在 .NET 2.0 中只需要将你的处理程序类继承自 ConfigurationSection 类即可。其处理步骤大致如下：

1. 首先定义并创建一个 ConfigurationPropertyCollection 类的实例，用以保存配置节点的特性(Attribute)以及它的所有子元素映射，当然你也可以使用 ConfigurationElement 基类中的 Properties 属性。
2. 然后创建 ConfigurationProperty 类以映射到对应的节点特性(Attribute)或子元素。
3. 在类型构造函数或实例构造函数中，将创建的 ConfigurationProperty 类实例加入到已创建好的 ConfigurationPropertyCollection 集合中。

最终，我们的范例配置处理程序类看起来可能是这样（如果你使用声明模式则代码看起来没有这么麻烦，这些配置属性类将由框架运行时帮你反射生成，正因为如此，所以它的运行时效率要差些。）：

public class DataSystemsSection : ConfigurationSection
{
  private static readonly ConfigurationProperty _dataSystems = new ConfigurationProperty(null, typeof(DataSystemElementCollection), null, ConfigurationPropertyOptions.IsDefaultCollection);
  private static ConfigurationPropertyCollection _properties = new ConfigurationPropertyCollection();

  static DataSystemsSection()
  {
    _properties.Add(_dataSystems);
  }

  public DataSystemElementCollection DataSystems
  {
    get
    {
      return (DataSystemElementCollection)base[_dataSystems];
    }
  }

  protected override ConfigurationPropertyCollection Properties
  {
    get
    {
      return _properties;
    }
  }
}

节点映射/配置实体

为所有的配置节点创建对应的配置实体类，该类中的属性(Property)对应节点中的特性(Attribute)和子元素(集合)。其编写步骤和开发方式与处理程序类似，只是这时我们的基类变成了 ConfigurationElement。

public class DataSystemElement : ConfigurationElement
{
  private static readonly ConfigurationProperty _name = new ConfigurationProperty("name", typeof(string), null, null, new StringValidator(1), ConfigurationPropertyOptions.IsKey | ConfigurationPropertyOptions.IsRequired);
  private static readonly ConfigurationProperty _currentProvider = new ConfigurationProperty("currentProvider", typeof(string), string.Empty, ConfigurationPropertyOptions.IsRequired);
  private static readonly ConfigurationProperty _dataModules = new ConfigurationProperty("dataModules", typeof(DataModuleElementCollection), null, ConfigurationPropertyOptions.None);
  private static readonly ConfigurationProperty _dataProviders = new ConfigurationProperty(null, typeof(DataProviderElementCollection), null, ConfigurationPropertyOptions.IsRequired | ConfigurationPropertyOptions.IsDefaultCollection);

  private static ConfigurationPropertyCollection _properties = new ConfigurationPropertyCollection();

  #region 类型构造函数
  static DataSystemElement()
  {
    _properties.Add(_name);
    _properties.Add(_currentProvider);
    _properties.Add(_dataProviders);
    _properties.Add(_dataModules);
  }
  #endregion

  #region 构造函数
  public DataSystemElement()
  {
  }

  public DataSystemElement(string name)
  {
    this.Name = name;
  }

  public DataSystemElement(string name, string currentProvider)
  {
    this.Name = name;
    this.CurrentProviderName = currentProvider;
  }
  #endregion

  #region 公共属性
  public string Name
  {
    get
    {
      return (string)base[_name];
    }
    set
    {
      base[_name] = value;
    }
  }

  public String CurrentProviderName
  {
    get
    {
      return (string)this[_currentProvider];
    }
    set
    {
      this[_currentProvider] = value;
    }
  }

  public DataModuleElementCollection DataModules
  {
    get
    {
      return (DataModuleElementCollection)base[_dataModules];
    }
  }

  public DataProviderElementCollection DataProviders
  {
    get
    {
      return (DataProviderElementCollection)base[_dataProviders];
    }
  }
  #endregion
}

需要注意的是，<dataProvider> 和 <dataModules> 子元素处理方式的差异。

• <dataModules> 是个嵌套的集合节点，它下面有标准的 <add>, <remove>, <clear> 子元素，且 <dataModules> 元素不能在同一个 <dataSystem> 节点下出现多次。
• <dataProvider> 是 <dataSystem> 节点下的直接子节点集合，<dataProvider> 是可以在同一个父节点下出现多次的集合项节点，故需要对其映射的 ConfigurationProperty 类构造函数中的 options 参数包含 ConfigurationPropertyOptions.IsDefaultCollection 枚举项（它指示.NET框架构造一个嵌套节），另外，不能指定它对应的配置节点的名字，即必须保持构造函数中 name 参数的值为空引用([C#]null/[VB.net]Nothing)或空字符串(String.Empty/"")。

节点集合

创建派生自 ConfigurationElementCollection 的类，在派生类中必须重写(override)的抽象方法：

• protected abstract ConfigurationElement CreateNewElement()
• 在从配置文件加载集合时，会调用该方法以创建各个元素。重写该方法以创建特定类型的自定义 ConfigurationElement 对象。
• protected abstract object GetElementKey(ConfigurationElement element)
• 在派生类中重写时获取指定配置元素的键值。

对于非默认的节点集合类，还必须重写 CollectionType 和 ElementName 只读属性的getter，其代码可能如下：

protected override string ElementName
{
    get
    {
        return "dataProvider"; //"dataProvider" replace with your elementName in collection.
    }
}

public override ConfigurationElementCollectionType CollectionType
{
    get
    {
        return ConfigurationElementCollectionType.BasicMap;
    }
}

可以重写 ThrowOnDuplicate 只读属性的getter，以指示当向 ConfigurationElementCollection 添加重复的 ConfigurationElement 是否会导致引发异常。默认情况，只有当该元素的 CollectionType 值为 AddRemoveClearMap 或 AddRemoveClearMapAlternate 时才会引发异常，如果希望非默认节点集合不接受重复项(通常如此)，那么就必须重写该属性的getter，始终返回真(true)。

请注意，键和值都相同的元素不会被视为重复元素，而是接受此类元素且不出现提示，只有键相同而值不同的元素才被视为是重复元素。原因是这些元素不会进行竞争。但是，无法添加键相同而值不同的元素，因为无法从逻辑上确定哪个竞争值有效。

索引器的设计模式

通常需要定义索引器的两个重载(overloads)，一个接受整型数下标的可读写的索引器；一个是接受字符串键值的只读索引器。

public DataProviderElement this[int index]
{
    get
    {
        return (DataProviderElement)BaseGet(index);
    }
    set
    {
        if(BaseGet(index) != null)
            BaseRemoveAt(index);

        BaseAdd(index, value);
    }
}

public new DataProviderElement this[string name]
{
    get
    {
        return (DataProviderElement)BaseGet(name);
    }
}

其他事项

通常还需要公开一些对集合操作的方法，大致如下：

public int IndexOf(DataProviderElement value)
{
    return BaseIndexOf(value);
}

public void Add(DataProviderElement value)
{
    BaseAdd(value);
}

public void Remove(DataProviderElement value)
{
    if(BaseIndexOf(value) >= 0)
        BaseRemove(value.Name);
}

public void Remove(string name)
{
    BaseRemove(name);
}

public void RemoveAt(int index)
{
    BaseRemoveAt(index);
}

public void Clear()
{
    BaseClear();
}

总结

这只是我想要撰写的有关 .NET 2.0 中的基础技术篇文章中的第一篇。在这篇文章中，我介绍了有关配置方面的一些基本概念，并阐述了在 .NET 2.0 中如何定制你自己的配置处理程序，以及这过程中需要注意的一些细节问题。您已经看到，通过对 .NET 2.0 中提供的基础架构的扩展，我们可以很容易完成特性化的配置定制。

下载

您可以从以下网址之一选择下载本文附带的源码：

1. 中汉软件：http://www.Zongsoft.com/Tech/Documents/TD20060821-src.zip
2. 车来车网：http://www.totogogo.com/Zongsoft/Tech/Documents/TD20060821-src.zip

其他资源

可能某些转载的格式不利于阅读，那么请从以下的原版位置之一查看本文：

1. 中汉软件：http://www.Zongsoft.com/Tech/Documents/TD20060821.htm
2. 车来车网：http://www.totogogo.com/Zongsoft/Tech/Documents/TD20060821.htm

作者：钟峰(Popeye Zhong)目前是 北大青鸟（深圳中青）培训中心 的讲师，负责讲授.NET和SQL数据库开发课程。他曾经使用 C 语言做过图形程序设计，在相当长的一段时期内从事 COM/COM+ 组件的开发和设计工作，并且短暂的做过 Lotus/Notes 和 Dialogic 语音卡程序的开发，从2003年初开始使用.NET这个充满趣味和挑战的开发平台。感兴趣的除了企业应用架构设计、组件开发、安全、图像处理外还对汽车和枪械模型有浓厚的兴趣。如果希望与他联系，可访问 http://sw515.cnblogs.com 或者Email SW515#21cn.com 。

引 言

　　在以前的公司就曾推荐在项目组中用 BugTracker.net（错误跟踪管理 ★开源★ 直到现在他们仍然在使用），最近自己需要对一个网站项目进行错误跟踪管理，自然就又想到了它。上网下载了个最新版本2.1.4(2005/10/22)。

　　因为现在需要将其部署在公共Web服务器上让普通用户使用 BugTracker 来报告错误，所以必须将其进行汉化并调整其默认的安全策略。

简 介

　　BugTracker.net 是用C#写的一个基于ASP.net的开源项目，是一款简单易用的错误跟踪管理软件。

安 装

1. 将下载的压缩文件全部解压缩到某个文件夹中（譬如“E:\BugTracker”）。
2. 创建数据库（譬如“BugTracker”），然后打开『SQL查询分析器』执行下载压缩文件内的“setup.sql”既可。
3. 打开『IIS信息服务管理器』在“默认网站”下面创建虚拟目录（譬如“BugTracker”），并对应到你的物理目录（譬如“E:\BugTracker”）。将“default.aspx”添加到默认文件列表中。
4. 打开浏览器在地址栏输入“http://127.0.0.1/BugTracker”，使用默认的系统管理员（Admin）帐号登录使用。

汉 化

　　BugTracker 项目的源代码和页面标签是混合在一起的而没有使用Codebehind，就像又回到了ASP时代一样。所以你千万不要像我一样到处找代码文件，我一度还以为它没提供源代码呢。坦白说，该项目的设计和代码实现都不咋的（看来，老外也不尽都是强人啊），远没有 ASP.net Forums（中文版） 来得漂亮，当然也可能是因为这两个项目的复杂度相差太大而导致设计思路不同罢。

　　该项目没有使用资源文档，各种显示文本/链接资源等均是硬编码在ASPX页面文件中的，所以我们必须一个个打开相关的ASPX文件，找到显示的英文内容后将其一一修改成中文，然后保存就可以了。因为是使用代码混合的方式，所以连编译这个步骤都可省略了（“可见即可得”）。

　　该项目中包含两个可能导致安全隐患的页面：

1. query.aspx 页面是用来直接运行SQL语句的，这会导致非常严重的安全隐患，尤其是将该项目部署到公共服务器上面，一定要将该页面文件删除，否则不怀好意的人就可以利用其执行危险的SQL命令了！！！
2. view_web_config.aspx 页面通过它能查看 Web.config 内容，这实在是个非常糟糕的事情。因为数据库连接字符串都是未经加密就直接保存在 Web.config 文件中的，如果你未删除该页面那后果可想而知了罢？！

其 他

　　本人英文水平很菜，如果有翻译的辞不达意的地方敬请各位来信告知：SW515@21cn.com，我将及时更正！

　　下载 BugTracker.NET 2.1.4(汉化版)：

• http://www.zongsoft.com/Download/BugTracker(2.1.4)cn.rar
• http://www.totogogo.com/Zongsoft/Download/BugTracker(2.1.4)cn.rar

声明：本人对该汉化版本不承担任何法律上的责任和义务，如果因为该系统造成您的一切损失都与本人无关，敬请自酌！