Uso de app.config con una biblioteca de clases

Question

Frecuentemente necesito crear una biblioteca de clases .Net que requiera app.config para cosas como cadenas de conexión de bases de datos. Sin embargo, estas configuraciones deben estar en app.config o web.config de la aplicación llamante. Si quiero distribuir el archivo DLL a través de múltiples aplicaciones, se convierte en un problema porque tengo que copiar estas configuraciones en cada aplicación app.config.

He considerado leer manualmente las configuraciones de configuración a través del código desde el interior de la biblioteca de clases, pero eso también es un gran problema. ¿Alguien tiene alguna sugerencia sobre la mejor forma de cargar la configuración de app.config dentro de una biblioteca de clases?

Answer 1

Una cosa que podría hacer es tener un archivo de configuración separado solo para su biblioteca, entonces solo tiene que tener una referencia en el archivo de configuración de la aplicación de entrada.

Consulte el accepted answer en this question para obtener información sobre esto.

Answer 2

Sé que no es lo que quiere escuchar, pero el archivo de configuración del punto de entrada es el lugar lógico para poner estos ajustes. Si cada biblioteca necesitara su propio archivo de configuración, sería tedioso tener que editar cada archivo en lugar de solo uno.

Tendría un archivo de texto con la configuración predeterminada incluida como parte de su biblioteca (y como parte del proyecto) que se puede distribuir con la biblioteca para la configuración de configuración predeterminada (se puede copiar y pegar en la configuración archivo).

Answer 3

Haga que cada biblioteca de clases defina las configuraciones en una sección de configuración personalizada.

A continuación, agregue manejadores de sección personalizados a su archivo process.exe.config.

This MSDN article es bastante completo en su explicación, con ejemplos tanto en VB como en C#.

Se trata de escribir algo de código bastante repetitivo - Dmitryr ha creado this tool para generar las secciones de configuración de un fragmento de una configuración de XML, lo que podría ayudar.

Answer 4

No es un (gran) problema utilizar su propio archivo de configuración para cada biblioteca de clases. Si usa vb.net, puede agregar valores a través del panel "mi proyecto" en la página "Configuración".

Lo único que debe hacer es llamar a "My.Settings.Save" en la configuración de la biblioteca de su clase (y no solo en el archivo de configuración de la aplicación principal).

Eso también funciona con C# (pero probablemente necesite más trabajo manual).

Answer 5

Si está usando NUnit, nombre su archivo app.config con el mismo nombre que su nombre de archivo de proyecto * .nunit. Entonces, por ejemplo, si llamó a su proyecto "ClassLibraryA.nunit", entonces nombre su archivo de configuración de biblioteca de clase "ClassLibraryA.config". También necesitan residir en la misma carpeta/directorio. NUnit en realidad está usando esto como el archivo de configuración principal.

Si tiene código personalizado, entonces necesita asegurarse de que su app.config (o web.config) haga referencia al archivo app.config de la biblioteca de la clase. La aplicación solo se preocupa por la raíz app.config o web.config. Por lo tanto, debe agregar una sección de configuración personalizada que apunte a la biblioteca de clases app.config.

Answer 6

Aquí hay una alternativa.

En lugar de tratar de encontrar la manera de "fusionar" sus app.configs, o incluso la colocación de los elementos de configuración en el archivo DLL (y tratando de evitar lo que es "de diseño"), en primer lugar, intente esto:

Crea tu DLL, pero donde necesites un ítem de configuración, crea una propiedad pública. Cuando crea una instancia de la clase en la DLL, rellena estas propiedades con elementos de configuración de la aplicación propietaria.

Ahora la configuración se administra en el nivel de propietario, y la DLL es portátil, ya que tiene que pasar lo que necesita en tiempo de ejecución.

¡No más DLL.config!

Answer 7

Puede crear su propio archivo XML (llámalo appConfig.xml o algo si lo desea), use System.Xml en lugar de System.Configuration para leerlo, e inclúyalo junto a su dll.

Answer 8

Ir a Propiedades de la aplicación -> pestaña Configuración; agregue su configuración allí.

Use Properties.Settings.Default.<SettingName> para acceder a la configuración. ¡Eso es!

Answer 9

Cree su biblioteca de clase en una solución diferente. Si los mantiene en la misma solución, la app.config en la jerarquía más alta se leerá.