Cómo leer XML personalizado desde la aplicación.config?

Question

Quiero leer la sección XML personalizada del app.config de un servicio de Windows C#.

¿Cómo lo hago?

El XML es el siguiente:

<Books> 
<Book name="name1" title="title1"/> 
<Book name="name2" title="title2"/> 
</Books> 

Answer 1

Lo que se quiere hacer es leer sobre Custom Configuration Sections.

Answer 2

En un proyecto que desarrollé uso algo similar para la configuración que encontré. Creo que el artículo fue llamado el último controlador de sección de configuración que alguna vez necesitaré (no puedo encontrar un enlace que funcione, tal vez alguien pueda vincularlo para mí).

Este método lleva lo que usted desea dar un paso más allá, y realmente deserializa el objeto en la memoria. Solo estoy copiando el código de mi proyecto, pero debería ser bastante simple dar un paso atrás si lo único que quieres es el XML.

Primero, debe definir una clase que maneje sus configuraciones.

using System; 
using System.Configuration; 
using System.Xml; 
using System.Xml.Serialization; 
using System.Xml.XPath; 


namespace Ariel.config 
{ 
    class XmlSerializerSectionHandler : IConfigurationSectionHandler 
    { 

     #region IConfigurationSectionHandler Members 

     public object Create(object parent, object configContext, XmlNode section) 
     { 
      XPathNavigator nav = section.CreateNavigator(); 
      string typename = (string)nav.Evaluate("string(@type)"); 
      Type t = Type.GetType(typename); 
      XmlSerializer ser = new XmlSerializer(t); 
      return ser.Deserialize(new XmlNodeReader(section)); 
     } 

     #endregion 
    } 
} 

Ahora, supongamos que desea cargar una sección de configuración ... super fácil, fundido con el tipo de objeto que está esperando a XML Serialize a, y pasar la sección que está buscando (en SearchSettings este caso.

try 
{ 
    config = (Eagle.Search.SearchSettings)ConfigurationSettings.GetConfig("SearchSettings"); 
} 
catch (System.Configuration.ConfigurationException ex) 
{ 
    syslog.FatalException("Loading search configuration failed, you likely have an error", ex); 
    return; 
} 

Ahora, todo lo que necesita es su archivo app.config. elegí para dividir la mina en archivos separados (1 archivo por sección) sólo para hacer la gestión de la configuración un poco más fácil. se define una sección, asígnele un nombre y defina el tipo (como llame a la clase enumerada arriba) y el nombre del ensamblado.

App.config:

<?xml version="1.0" encoding="utf-8" ?> 
<configuration> 
    <configSections> 
    <section name="SearchSettings" type="Ariel.config.XmlSerializerSectionHandler, Ariel"/> 
    </configSections> 
    <SearchSettings configSource="Config\Search.config" /> 
</configuration> 

Ahora, todo lo que queda es el archivo de configuración a ser serializado de-. Lo que es importante aquí es que el bloque coincide con el nombre de su sección, y su tipo es el objeto al que debe deserializar, y el nombre del ensamblado.

<?xml version="1.0" encoding="utf-8" ?> 
<SearchSettings type="Eagle.Search.SearchSettings, Eagle"> 
    <NumThreads>4</NumThreads> 
</SearchSettings> 

Si lo que desea es el XML prima pura, todo lo que necesitará hacer es modificar el objeto que se encarga de la sección de devolver el XML o hacer lo que tiene que hacer.

Answer 3

Utilizo xml personalizado en mi config.app. archive y cree una aplicación. XSD a partir de ella. El archivo XSD incluye el esquema del archivo config.app. Luego, el archivo XSD se puede traducir a una clase vb o a un archivo de clase C# utilizando 'xsd.exe'. Ahora todo lo que tiene que hacer es deserializar el archivo de configuración para la clase.

<?xml version="1.0" encoding="utf-8" ?> 
<configuration> 
    <configSections> 
     <section name="CustomConfig" type="Object" /> 
    </configSections> 

    <CustomConfig> 
     <ActiveEnvironment>QAS</ActiveEnvironment> 
     <Environments> 
      <Environment name ="PRD" log="Y"> 
      </Environment> 
      <Environment name ="QAS" log="N"> 
      </Environment> 
      <Environment name ="DEV" log="Y"> 
      </Environment> 
     </Environments> 
    </CustomConfig> 

</configuration> 

Answer 4

Desde IConfigurationSectionHandler es obsoleto pensé que vale la pena mencionar que todavía se puede poner en práctica una sección seriada pura simplemente reemplazando ConfigurationSection.DeserializeSection y no llamar a la implementación base.

Aquí hay un ejemplo muy básico que reutilizo mucho. Una sección de configuración simple que carga un gráfico de objetos desde XAML en línea.(Naturalmente puede implementar con XmlSerializer en su lugar)

using System.Configuration; 
using System.Xaml; 
using System.Xml; 

... 

public class XamlConfigurationSection<T> : ConfigurationSection 
{ 
    public static XamlConfigurationSection<T> Get(string sectionName) 
    { 
     return (XamlConfigurationSection<T>)ConfigurationManager.GetSection(sectionName); 
    } 

    public T Content { get; set; } 

    protected override void DeserializeSection(XmlReader xmlReader) 
    { 
     xmlReader.Read(); 
     using (var xamlReader = new XamlXmlReader(xmlReader)) 
      Content = (T)XamlServices.Load(xamlReader); 
    } 
}