Jak zdefiniować własną stronę internetową.sekcje config z potencjalnymi elementami potomnymi i atrybutami dla właściwości?

Używanie atrybutów, podrzędnych sekcji konfiguracyjnych i ograniczeń

Istnieje również możliwość korzystania z atrybutów, które automatycznie dbają o instalację wodno-kanalizacyjną, a także zapewniają możliwość łatwego dodawania ograniczeń.

Przedstawiam tutaj przykład z kodu, którego używam na jednej z moich stron. Z ograniczeniem dyktuję maksymalną ilość miejsca na dysku, z którego może korzystać każdy użytkownik.

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; }
        }
    }
}

To jest ustawione w sieci.config like so

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

Elementy potomne

Potomny element xml mail jest tworzony w tym samym .plik cs jak wyżej. Tutaj dodałem ograniczenia dotyczące portu. Jeśli portowi zostanie przypisana wartość nie mieszcząca się w tym zakresie, runtime będzie narzekać podczas ładowania konfiguracji.

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; }
        }

Użyj

Aby użyć go praktycznie w kodzie, wystarczy utworzyć instancję obiektu MailCenterConfigurationObject, spowoduje to automatycznie odczytaj odpowiednie sekcje z sieci.config.

MailCenterConfiguration.cs

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

        return instance;
    }
}

Kolejny plik.cs

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

Sprawdź ważność

Wspomniałem wcześniej, że runtime będzie narzekać, gdy konfiguracja zostanie załadowana, a niektóre dane nie będą zgodne z ustawionymi regułami (np. w MailCenterConfiguration.cs). Zazwyczaj chcę wiedzieć te rzeczy tak szybko, jak to możliwe, gdy moja strona się uruchomi. Jednym ze sposobów rozwiązania tego problemu jest załadowanie konfiguracja w _Global.asax. CX. Application_Start_, jeśli konfiguracja jest nieprawidłowa, zostaniesz o tym powiadomiony za pomocą wyjątku. Twoja strona nie uruchomi się, a zamiast tego pojawią się szczegółowe informacje o wyjątkach w żółtym ekranie śmierci .

Globalny.asax.cs

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