Configuración de lectura desde app.config o web.config en .NET

Estoy trabajando en una biblioteca de clase C # que necesita poder leer la configuración desde web.configoapp.config archivo (dependiendo de si se hace referencia a la DLL desde una aplicación web ASP.NET o una aplicación de formularios Windows Forms).

He encontrado que

ConfigurationSettings.AppSettings.Get("MySetting")

funciona, pero ese código ha sido marcado como obsoleto por Microsoft.

He leído que debería estar usando:

ConfigurationManager.AppSettings["MySetting"]

sin embargo, el System.Configuration.ConfigurationManager clase no parece estar disponible en un proyecto de biblioteca de clases C #.

¿Cuál es la mejor manera de hacer esto?

Deberá agregar una referencia a System.Configurationla carpeta de referencias de su proyecto .

Definitivamente deberías estar usando ConfigurationManagerlo obsoleto ConfigurationSettings.

Para un archivo app.config de muestra como el siguiente:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="countoffiles" value="7" />
    <add key="logfilelocation" value="abc.txt" />
  </appSettings>
</configuration>

Usted lee la configuración de la aplicación anterior utilizando el código que se muestra a continuación:

using System.Configuration;

Es posible que también deba agregar una referencia a System.Configurationsu proyecto si aún no hay una. Luego puede acceder a los valores de esta manera:

string configvalue1 = ConfigurationManager.AppSettings["countoffiles"];
string configvalue2 = ConfigurationManager.AppSettings["logfilelocation"];

Actualización para .NET Framework 4.5 y 4.6; lo siguiente ya no funcionará:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

Ahora acceda a la clase de Configuración a través de Propiedades:

string keyvalue = Properties.Settings.Default.keyname;

Consulte Gestión de la configuración de la aplicación para obtener más información.

Haga clic derecho en la biblioteca de su clase y elija la opción "Agregar referencias" en el menú.

Y desde la pestaña .NET, seleccione System.Configuration. Esto incluiría el archivo System.Configuration DLL en su proyecto.

Estoy usando esto, y funciona bien para mí:

textBox1.Text = ConfigurationManager.AppSettings["Name"];

Leer de la configuración:

Deberá agregar una referencia a la configuración:

1. Abra "Propiedades" en su proyecto
2. Vaya a la pestaña "Configuración"
3. Agregue "Nombre" y "Valor"

4. Obtenga valor con el siguiente código:

   string value = Properties.Settings.Default.keyname;

Guardar en la configuración:

   Properties.Settings.Default.keyName = value;
   Properties.Settings.Default.Save();

Debe agregar una referencia al ensamblado System.Configuration al proyecto.

Es posible que esté agregando el archivo App.config a un archivo DLL. App.Config funciona solo para proyectos ejecutables, ya que todos los archivos DLL toman la configuración del archivo de configuración para el archivo EXE que se está ejecutando.

Digamos que tiene dos proyectos en su solución:

• SomeDll
• SomeExe

Su problema podría estar relacionado con el hecho de que está incluyendo el archivo app.config en SomeDLL y no SomeExe. SomeDll puede leer la configuración del proyecto SomeExe.

Prueba esto:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

En el archivo web.config , esta debería ser la siguiente estructura:

<configuration>
<appSettings>
<add key="keyname" value="keyvalue" />
</appSettings>
</configuration>

Yo tuve el mismo problema. Solo léalos de esta manera: System.Configuration.ConfigurationSettings.AppSettings ["MySetting"]

web.configse usa con aplicaciones web. web.configpor defecto tiene varias configuraciones requeridas para la aplicación web. Puede tener un web.configpara cada carpeta en su aplicación web.

app.configse usa para aplicaciones de Windows. Cuando cree la aplicación en Visual Studio, se le cambiará el nombre automáticamente <appname>.exe.configy este archivo debe entregarse junto con su aplicación.

Puede usar el mismo método para llamar a los app settingsvalores de ambos archivos de configuración: System.Configuration.ConfigurationSettings.AppSettings ["Key"]

Como encontré el mejor enfoque para acceder a las variables de configuración de la aplicación de manera sistemática al hacer una clase de contenedor sobre el sistema.

public class BaseConfiguration
{
    protected static object GetAppSetting(Type expectedType, string key)
    {
        string value = ConfigurationManager.AppSettings.Get(key);
        try
        {
            if (expectedType == typeof(int))
                return int.Parse(value);
            if (expectedType == typeof(string))
                return value;

            throw new Exception("Type not supported.");
        }
        catch (Exception ex)
        {
            throw new Exception(string.Format("Config key:{0} was expected to be of type {1} but was not.",
                key, expectedType), ex);
        }
    }
}

Ahora podemos acceder a las variables de configuración necesarias mediante nombres codificados utilizando otra clase como se muestra a continuación:

public class ConfigurationSettings:BaseConfiguration
{
    #region App setting

    public static string ApplicationName
    {
        get { return (string)GetAppSetting(typeof(string), "ApplicationName"); }
    }

    public static string MailBccAddress
    {
        get { return (string)GetAppSetting(typeof(string), "MailBccAddress"); }
    }

    public static string DefaultConnection
    {
        get { return (string)GetAppSetting(typeof(string), "DefaultConnection"); }
    }

    #endregion App setting

    #region global setting


    #endregion global setting
}

Le recomiendo que cree un contenedor para esta llamada. Algo así como ay ConfigurationReaderServiceuse la inyección de dependencia para obtener esta clase. De esta forma, podrá aislar estos archivos de configuración con fines de prueba.

Entonces use el ConfigurationManager.AppSettings["something"];sugerido y devuelva este valor. Con este método, puede crear algún tipo de devolución predeterminada si no hay ninguna clave disponible en el archivo .config.

Además, puedes usar Formo :

Configuración:

<appSettings>
    <add key="RetryAttempts" value="5" />
    <add key="ApplicationBuildDate" value="11/4/1999 6:23 AM" />
</appSettings>

Código:

dynamic config = new Configuration();
var retryAttempts1 = config.RetryAttempts;                 // Returns 5 as a string
var retryAttempts2 = config.RetryAttempts(10);             // Returns 5 if found in config, else 10
var retryAttempts3 = config.RetryAttempts(userInput, 10);  // Returns 5 if it exists in config, else userInput if not null, else 10
var appBuildDate = config.ApplicationBuildDate<DateTime>();

Solo para completar, hay otra opción disponible solo para proyectos web: System.Web.Configuration.WebConfigurationManager.AppSettings ["MySetting"]

El beneficio de esto es que no requiere que se agregue una referencia adicional, por lo que puede ser preferible para algunas personas.

Paso 1: haga clic derecho en la pestaña de referencias para agregar referencias.

Paso 2: haga clic en la pestaña Ensamblajes

Paso 3: busque 'System.Configuration'

Paso 4: haz clic en Aceptar.

Entonces funcionará.

 string value = System.Configuration.ConfigurationManager.AppSettings["keyname"];

Siempre creo una interfaz IConfig con propiedades typesafe declaradas para todos los valores de configuración. Una clase de implementación de Config envuelve las llamadas a System.Configuration. Todas sus llamadas de System.Configuration ahora están en un solo lugar, y es mucho más fácil y limpio mantener y rastrear qué campos se están utilizando y declarar sus valores predeterminados. Escribo un conjunto de métodos de ayuda privados para leer y analizar tipos de datos comunes.

Usando un marco IoC puede acceder a los campos IConfig en cualquier lugar de su aplicación simplemente pasando la interfaz a un constructor de clases. También puede crear implementaciones simuladas de la interfaz IConfig en sus pruebas unitarias para que ahora pueda probar varios valores de configuración y combinaciones de valores sin necesidad de tocar su archivo App.config o Web.config.

Otra posible solución:

var MyReader = new System.Configuration.AppSettingsReader();
string keyvalue = MyReader.GetValue("keyalue",typeof(string)).ToString();

He estado tratando de encontrar una solución para este mismo problema durante un par de días. Pude resolver esto agregando una clave dentro de la etiqueta de configuración de aplicaciones en el archivo web.config . Esto debería anular el archivo .dll cuando se usa el asistente.

<configuration>
    <appSettings>
        <add key="loginUrl" value="~/RedirectValue.cshtml" />
        <add key="autoFormsAuthentication" value="false"/>
    </appSettings>
</configuration>

Puedes usar la siguiente línea. En mi caso estaba funcionando: System.Configuration.ConfigurationSettings.AppSettings ["yourKeyName"]

Debe tener cuidado de que la línea de código anterior también sea la versión anterior y esté obsoleta en las nuevas bibliotecas.

ConfigurationManager no es lo que necesita para acceder a su propia configuración.

Para hacer esto debes usar

{YourAppName}.Properties.Settings.{settingName}

Pude lograr que el siguiente enfoque funcione para proyectos de .NET Core:

Pasos:

1. Cree un appsettings.json (formato que figura a continuación) en su proyecto.
2. Luego cree una clase de configuración. El formato se proporciona a continuación.

3. He creado un método de inicio de sesión () para mostrar el uso de la clase de configuración.

   Cree appsettings.json en su proyecto con contenido:

   {
     "Environments": {
       "QA": {
         "Url": "somevalue",
    "Username": "someuser",
         "Password": "somepwd"
     },
     "BrowserConfig": {
       "Browser": "Chrome",
       "Headless": "true"
     },
     "EnvironmentSelected": {
       "Environment": "QA"
     }
   }
   
   public static class Configuration
   {
       private static IConfiguration _configuration;
   
       static Configuration()
       {
           var builder = new ConfigurationBuilder()
               .AddJsonFile($"appsettings.json");
   
           _configuration = builder.Build();
   
       }
       public static Browser GetBrowser()
       {
   
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "Firefox")
           {
               return Browser.Firefox;
           }
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "Edge")
           {
               return Browser.Edge;
           }
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "IE")
           {
               return Browser.InternetExplorer;
           }
           return Browser.Chrome;
       }
   
       public static bool IsHeadless()
       {
           return _configuration.GetSection("BrowserConfig:Headless").Value == "true";
       }
   
       public static string GetEnvironment()
       {
           return _configuration.GetSection("EnvironmentSelected")["Environment"];
       }
       public static IConfigurationSection EnvironmentInfo()
       {
           var env = GetEnvironment();
           return _configuration.GetSection($@"Environments:{env}");
       }
   
   }
   
   
   public void Login()
   {
       var environment = Configuration.EnvironmentInfo();
       Email.SendKeys(environment["username"]);
       Password.SendKeys(environment["password"]);
       WaitForElementToBeClickableAndClick(_driver, SignIn);
   }

Si necesita / desea utilizar la ConfigurationManagerclase ...

Puede que tenga que cargar System.Configuration.ConfigurationManagerpor Microsoft a través de NuGet Package Manager

Herramientas-> Administrador de paquetes NuGet-> Administrar paquetes NuGet para la solución ...

Documentos de Microsoft

Una cosa que vale la pena señalar de los documentos ...

Si su aplicación necesita acceso de solo lectura a su propia configuración, le recomendamos que utilice el método GetSection (String). Este método proporciona acceso a los valores de configuración en caché para la aplicación actual, que tiene un mejor rendimiento que la clase de configuración.

Verifique la versión .NET en la que está trabajando. Debe ser superior a 4. Y debe agregar la biblioteca del sistema System.Configuration a su aplicación.

Aquí hay un ejemplo: App.config

<applicationSettings>
    <MyApp.My.MySettings>
        <setting name="Printer" serializeAs="String">
            <value>1234 </value>
        </setting>
    </MyApp.My.MySettings>
</applicationSettings>

Dim strPrinterName as string = My.settings.Printer