Oxxigeno Networks España

Una práctica habitual en desarrollos asp net es utilizar el fichero de configuración (o el app config en aplicativos de escritorio) como almacén de valores configurables que luego se utilizarán en el aplicativo para uno u otro propósito.

Lo que en principio se nos antoja como una buena práctica, en la mayoría de las ocasiones, debido a una utilización mal estructurada del fichero de configuración, se convierte en una lista incontrolable y sin organización alguna de entradas en el nodo appSettings.

Para evitar esto existe una solución alternativa, más elegante, más clara y, más optima. Las clases ConfigurationSection, ConfigurationElement y ConfigurationElementCollection permiten definir secciones, elementos y colecciones de elementos en el fichero de configuración y utilizarlas como cualquier otro objeto en nuestro aplicativo.

Vamos a definir una pequeña sección en el fichero de configuración y comentamos un poquito cómo realizarla.

La clase EjemploData heredará de ConfigurationElement y tendrá dos propiedades Name y PropiedadBooleana, de tipo string y bool respectivamente. Las propiedades de ambas deberán tener el atributo ConfigurationProperty con el nombre que tomará en el fichero de configuración, su valor por defecto (si queremos especificarlo) y si es obligatoria.

public class EjemploData : ConfigurationElement
    {
        #region Public Properties
 
        private const string NamePropertyName = "name";
 
        [ConfigurationProperty(NamePropertyName, IsRequired = true)]
        public string Name
        {
            get { return this[NamePropertyName].ToString(); }
            set { this[NamePropertyName] = value; }
        }
 
        private const string PropiedadBooleanaPropertyName = "propiedadBooleana";
        [ConfigurationProperty(PropiedadBooleanaPropertyName, DefaultValue = "true", IsRequired = false)]
        public bool PropiedadBooleana
        {
            get { return (bool)this[PropiedadBooleanaPropertyName]; }
            set { this[PropiedadBooleanaPropertyName] = value; }
        }
 
        #endregion
    }

Crearemos una clase EjemploDataCollection que herede de ConfigurationElementCollection, tal y como se muestra, no requiere mucha explicación

public class EjemploDataCollection : ConfigurationElementCollection
{
#region ConfigurationElementCollection Members
 
protected override ConfigurationElement CreateNewElement()
{
return new EjemploData();
}
 
protected override object GetElementKey(ConfigurationElement element)
{
return ((EjemploData)element).Name;
}
 
public EjemploData this[int index]
{
get
{
return (EjemploData)BaseGet(index);
}
set
{
if (BaseGet(index) != null)
{
BaseRemoveAt(index);
}
BaseAdd(index, value);
}
}
 
#endregion
}

Finalmente, crearemos la clase que nos permita manejar este tipo de objetos. Esta clase debe heredar de ConfigurationSection, la cual nos servirá para marcar el ámbito en el cual obtendremos los valores dentro del fichero de configuración. Debe tener:

• Una constante pública que nos indique cómo llegar a la sección adecuada del fichero de configuración.
• Constantes privadas que nos marquen cómo se llamarán los atributos.
• Nodos hijos que podremos definir en el fichero de configuración
• Sus respectivas propiedades públicas que nos permitirán utilizarlas en cualquier parte de nuestro aplicativo.

En nuestro ejemplo definiremos la seccion como “oxxigeno/ejemploSettings”, lo que significa que en el fichero de configuración tendremos que definir un nodo oxxigeno y dentro uno ejemploSettings.

Queremos que exista una atributo en el nodo ejemploSettings, para lo cual crearemos una constante privada que nos diga como debe llamarse, “nuevaPropiedad”, y una propiedad pública que nos permita recuperarlo del fichero de configuración y utilizarlo en el aplicativo. Para ello crearemos una propiedad normal que nos devolverá un objeto de tipo string y le establecemos un atributo a la propiedad de tipo ConfigurationProperty, que indique cómo se va a llamar ese atributo en el fichero de configuración y si es obligatorio o no que exista.

Además nos interesa que bajo el nodo ejemploSettings exista una colección de nodos del mismo tipo (en nuestro caso EjemploData). Para ello procederemos igual que para la propiedad actual, pero definiremos su salida como EjemploDataCollection, y le agregaremos el atributo ConfigurationCollection pasándole como parámetro el tipo de objetos que se coleccionarán.

public sealed class EjemploSettings : ConfigurationSection
{
 
public const string SectionName = "oxxigeno/ejemploSettings";
 
#region Public Properties
 
private const string NuevaPropiedadPropertyName = "nuevaPropiedad";
 
[ConfigurationProperty(NuevaPropiedadPropertyName, IsRequired = true)]
public string NuevaPropiedad
{
get { return this[NuevaPropiedadPropertyName].ToString(); }
set { this[NuevaPropiedadPropertyName] = value; }
}
 
private const string ColeccionDeEjemploPropertyName = "coleccionDeEjemplo";
 
[ConfigurationProperty(ColeccionDeEjemploPropertyName, IsRequired = true, IsDefaultCollection = true)]
[ConfigurationCollection(typeof(EjemploData))]
public EjemploDataCollection ColeccionDeEjemplo
{
get { return (EjemploDataCollection)this[ColeccionDeEjemploPropertyName]; }
}
 
#endregion
}

Así pues, para cargar datos en el fichero de configuración, debemos cargar la clase controladora (EjemploSettings) y montar el árbol de nodos que hemos definido en las clases.

Dentro del nodo configurationSections debemos crear un nodo SectionGroup como se muestra, y dentro un nodo section. Pueden existir múltiples nodos sectionGroup pero no con el mismo nombre. Cada nodo sectionGroup puede tener en su interior multiples nodos section.

   <sectionGroup name="oxxigeno">
      <section name="ejemploSettings" type="Oxxigeno.Ejemplo.Configuration.EjemploSettings, Oxxigeno.Ejemplo, Version=1.0.0.0, Culture=neutral, PublicKeyToken=96df930e30970c00">
   </sectionGroup>

Y despues creamos el árbol de nodos tal como lo hemos definido, quedaría algo así:

   <oxxigeno> 
      <ejemploSettings nuevaPropiedad="valorDeLaPropiedad"&gt; 
         <coleccionDeEjemplo&gt; <clear/&gt;
            <add name="nombreDeLaEntrada1" propiedadBooleana="false" /&gt; 
            <add name="nombreDeLaEntrada2" propiedadBooleana="true" /&gt; 
         </coleccionDeEjemplo>
      </ejemploSettings>
   </oxxigeno&gt;

La forma de recuperar estos valores sería la siguiente:

EjemploSettings ejemploSettings = ConfigurationManager.GetSection(EjemploSettings.SectionName) as EjemploSettings;
string nuevaPropiedad = ejemploSettings.NuevaPropiedad;
foreach (EjemploData obj in ejemploSettings.ColeccionDeEjemplo)
{
string nombre = obj.Name;
bool propiedadBooleana = obj.PropiedadBooleana;
}

Considero que este método de utilización del fichero de configuración es:

• Más útil: Los valores se encuentran parseados al tipo necesario, no se obtienen unicamente valores de tipo string como pasa si utilizamos AppSettings, lo cual facilita el trabajo del desarrollador.
• Más estructurado: Los valores dentro del fichero de configuración son facilmente localizables y, por lo tanto, modificables.