Comment puis-je définir web personnalisé.sections de configuration avec le potentiel de l'enfant des éléments et des attributs pour les propriétés?

À l'aide d'attributs, enfant sections de configuration et les contraintes

Il y a aussi la possibilité d'utiliser des attributs qui prend automatiquement soin de la plomberie, ainsi que la fourniture de la capacité de facilement ajouter des contraintes.

Je présente ici un exemple de code que j'utilise moi-même dans un de mes sites. Avec une contrainte, je dictent la quantité maximale d'espace disque un utilisateur est autorisé à utiliser.

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

Cela est mis en place dans le web.config comme

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

Éléments enfants

L'enfant de l'élément xml mail est créé dans le même .cs fichier comme celui ci-dessus. Ici j'ai ajouté des contraintes sur le port. Si le port est affecté d'une valeur n'est pas dans cette gamme, le moteur d'exécution de se plaindre quand la config est chargé.

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

Utilisation

Pour ensuite les utiliser en pratique dans le code, tout ce que vous avez à faire est de créer une instance de la MailCenterConfigurationObject, ce sera automatiquement lire les sections pertinentes du 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);
}

De vérifier la validité

Je l'ai mentionné précédemment que le runtime de se plaindre quand la configuration est chargée et certaines données ne respectent pas les règles que vous avez mis en place (par exemple dans MailCenterConfiguration.cs). J'ai tendance à vouloir en savoir ces choses dès que possible quand mon site s'allume. Une façon de résoudre ce problème consiste à charger la configuration dans _Global.asax.cx.Application_Start_ , si la configuration n'est pas valide, vous en serez informé dans les moyens d'une exception. Votre site ne démarre pas et à la place vous sera présenté détaillée exception de l'information dans le Le jaune de l'écran de la mort.

Mondiale.asax.cs

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

Il y a un excellent exemple sur MSDN à l'aide de ConfigurationCollection et .NET 4.5 pour ce qui est des rubriques personnalisées dans le web.config qui a une liste de config éléments.

Vous pouvez accomplir cela avec les Gestionnaires de Section. Il y a une vue d'ensemble de la façon d'écrire une à http://www.codeproject.com/KB/aspnet/ConfigSections.aspx cependant, il se réfère à l'application.config qui serait à peu près la même que l'écriture de l'un pour web.config. Cela vous permettra de l'essentiel de disposer de votre propre arborescence XML dans le fichier de config et faire un peu plus de la configuration avancée.