如何定义具有潜在子元素和属性属性的自定义web.config节?

时间:2008-08-05 12:13:41

标签: asp.net

我开发的Web应用程序通常需要相互依赖的配置设置,并且还有一些设置必须在我们在每个环境之间移动时进行更改。

我们所有的设置目前都是简单的键值对,但是创建自定义配置部分非常有用,这样当两个值需要一起更改或者需要针对环境进行更改时,显而易见。

创建自定义配置文件的最佳方法是什么,检索值时是否需要特别注意?

6 个答案:

答案 0 :(得分:78)

使用属性,子配置部分和约束

还可以使用自动处理管道的属性,并提供轻松添加约束的功能。

我在这里提供了一个代码我在我的一个网站中使用自己的例子。使用约束,我指定允许任何一个用户使用的最大磁盘空间量。

MailCenterConfiguration.cs:

namespace Ani {

    public sealed class MailCenterConfiguration : ConfigurationSection
    {
        [ConfigurationProperty("userDiskSpace", IsRequired = true)]
        [IntegerValidator(MinValue = 0, MaxValue = 1000000)]
        public int UserDiskSpace
        {
            get { return (int)base["userDiskSpace"]; }
            set { base["userDiskSpace"] = value; }
        }
    }
}

这是在web.config中设置的,如此

<configSections>
    <!-- Mailcenter configuration file -->
    <section name="mailCenter" type="Ani.MailCenterConfiguration" requirePermission="false"/>
</configSections>
...
<mailCenter userDiskSpace="25000">
    <mail
     host="my.hostname.com"
     port="366" />
</mailCenter>

子元素

子xml元素 mail 是在与上面相同的.cs文件中创建的。在这里,我添加了对端口的约束。如果为端口分配的值不在此范围内,则运行时将在加载配置时发出警告。

MailCenterConfiguration.cs:

public sealed class MailCenterConfiguration : ConfigurationSection
{
    [ConfigurationProperty("mail", IsRequired=true)]
    public MailElement Mail
    {
        get { return (MailElement)base["mail"]; }
        set { base["mail"] = value; }
    }

    public class MailElement : ConfigurationElement
    {
        [ConfigurationProperty("host", IsRequired = true)]
        public string Host
        {
            get { return (string)base["host"]; }
            set { base["host"] = value; }
        }

        [ConfigurationProperty("port", IsRequired = true)]
        [IntegerValidator(MinValue = 0, MaxValue = 65535)]
        public int Port
        {
            get { return (int)base["port"]; }
            set { base["port"] = value; }
        }

使用

然后在代码中实际使用它,您只需要实例化MailCenterConfigurationObject,这将自动从web.config中读取相关部分。

MailCenterConfiguration.cs

private static MailCenterConfiguration instance = null;
public static MailCenterConfiguration Instance
{
    get
    {
        if (instance == null)
        {
            instance = (MailCenterConfiguration)WebConfigurationManager.GetSection("mailCenter");
        }

        return instance;
    }
}

AnotherFile.cs

public void SendMail()
{
    MailCenterConfiguration conf = MailCenterConfiguration.Instance;
    SmtpClient smtpClient = new SmtpClient(conf.Mail.Host, conf.Mail.Port);
}

检查有效性

我之前提到过,运行时会在加载配置并且某些数据不符合您设置的规则时抱怨(例如在MailCenterConfiguration.cs中)。当我的网站启动时,我倾向于想尽快知道这些事情。解决此问题的一种方法是在_Global.asax.cx.Application_Start_中加载配置,如果配置无效,您将通过异常方式通知此情况。您的网站无法启动,而是会在Yellow screen of death中显示详细的例外信息。

的Global.asax.cs

protected void Application_ Start(object sender, EventArgs e)
{
    MailCenterConfiguration.Instance;
}

答案 1 :(得分:12)

Quick'n Dirty:

首先创建 ConfigurationSection ConfigurationElement 类:

public class MyStuffSection : ConfigurationSection
{
    ConfigurationProperty _MyStuffElement;

    public MyStuffSection()
    {
        _MyStuffElement = new ConfigurationProperty("MyStuff", typeof(MyStuffElement), null);

        this.Properties.Add(_MyStuffElement);
    }

    public MyStuffElement MyStuff
    {
        get
        {
            return this[_MyStuffElement] as MyStuffElement;
        }
    }
}

public class MyStuffElement : ConfigurationElement
{
    ConfigurationProperty _SomeStuff;

    public MyStuffElement()
    {
        _SomeStuff = new ConfigurationProperty("SomeStuff", typeof(string), "<UNDEFINED>");

        this.Properties.Add(_SomeStuff);
    }

    public string SomeStuff
    {
        get
        {
            return (String)this[_SomeStuff];
        }
    }
}

然后让框架知道如何在 web.config 中处理配置类:

<configuration>
  <configSections>
    <section name="MyStuffSection" type="MyWeb.Configuration.MyStuffSection" />
  </configSections>
  ...

实际上在下面添加您自己的部分:

  <MyStuffSection>
    <MyStuff SomeStuff="Hey There!" />
  </MyStuffSection>

然后你可以在你的代码中使用它:

MyWeb.Configuration.MyStuffSection configSection = ConfigurationManager.GetSection("MyStuffSection") as MyWeb.Configuration.MyStuffSection;

if (configSection != null && configSection.MyStuff != null)
{
    Response.Write(configSection.MyStuff.SomeStuff);
}

答案 2 :(得分:5)

对于web.config中的自定义部分,使用ConfigurationCollection和.NET 4.5有一个很好的example on MSDN,其中包含配置项列表。

答案 3 :(得分:4)

自定义配置非常方便,通常应用程序最终需要可扩展的解决方案。

对于.NET 1.1,请参阅文章http://aspnet.4guysfromrolla.com/articles/020707-1.aspx

注意:上述解决方案也适用于.NET 2.0。

对于.NET 2.0特定解决方案,请参阅文章http://aspnet.4guysfromrolla.com/articles/032807-1.aspx

答案 4 :(得分:3)

您可以使用Section Handlers完成此操作。有一个基本的概述,如何在http://www.codeproject.com/KB/aspnet/ConfigSections.aspx写一个,但它引用的app.config与编写一个用于web.config的几乎相同。这将允许您在配置文件中实际拥有自己的XML树,并进行更高级的配置。

答案 5 :(得分:2)

我发现最简单的方法是使用appSettings section

  1. 将以下内容添加到Web.config:

    <appSettings>
        <add key="MyProp" value="MyVal"/>
    </appSettings>
    

  2. 从您的代码访问

    NameValueCollection appSettings = ConfigurationManager.AppSettings;
    string myPropVal = appSettings["MyProp"];