ASP.NET CORE

Configuración en ASP.NET Core Mediante Archivos JSON

2 de abril, 2024

El proceso de configuración en ASP.NET Core mediante archivos appsettings.json y sus variantes appsettings.{Environment}.json, se realiza de forma implícita por medio de proveedores, que en la mayoría de escenarios es suficiente.

Sin embargo, hay casos estrictamente necesarios en los cuales se requiere requiere añadir archivos JSON adicionales de forma explícita, y para realizar esta tarea existe el método de extensión AddJsonFile perteneciente al proveedor JsonConfigurationProvider, el cual carga la configuración desde pares clave-valor en tiempo de ejecución.

La sobrecarga del método AddJsonFile más usada es en la que se define los siguientes parámetros:

Path: Ruta relativa de acceso al archivo JSON.
Optional: Establece si el archivo es opcional, indicándole así al proveedor de configuración que no lance una excepción de tipo FileNotFoundException si no encuentra el archivo.
ReloadOnChange: Indica si el archivo se debe volver a cargar cuando su contenido cambie, sin la necesidad de volver a iniciar la aplicación.

¡IMPORTANTE!

Hay que tener presente, que la recarga automática de configuración conlleva a que ASP.NET Core configure e inicie un observador de archivos en segundo plano, lo que podría ocasionar problemas de rendimiento si se tienen demasiados archivos.

Considere el siguiente archivo personalizado DbSettings.json:

{
   "MongoDbSettings": {
      "Host": "localhost",
      "Port": 27017
   }
}

En el siguiente código se carga el archivo DbSettings.json:

var builder = WebApplication.CreateBuilder(args);

builder.Configuration.Sources.Clear();
builder.Configuration.AddJsonFile("DbSettings.json", optional: false, reloadOnChange: true);

builder.Services.ConfigureHttpJsonOptions(options =>
{
    options.SerializerOptions.WriteIndented = true;
});

var app = builder.Build();

app.MapGet("/", () => app.Configuration.AsEnumerable());

app.Run();

En el código anterior:

Se removieron o invalidaron todos los orígenes que se cargan de forma predeterminada (Archivos appsettings.json, appsettings.{Environment}.json, variables de entorno, argumentos de línea de comandos, etc.) por medio del método Clear().
Se añade el archivo por medio del método de extensión AddJsonFile.
Se configura que los elementos de configuración deben mostrarse con sangría.

[
  {
    "key": "MongoDbSettings",
    "value": null
  },
  {
    "key": "MongoDbSettings:Port",
    "value": "27017"
  },
  {
    "key": "MongoDbSettings:Host",
    "value": "localhost"
  }
]

En caso de que el archivo haya sido agregado como no opcional, y al momento de cargarlo no se encuentre, se lanzara la siguiente excepción:

System.IO.FileNotFoundException
HResult=0x80070002
Message=The configuration file 'DbSettings.json' was not found and is not optional. The expected physical path was 'C:\ConfiguracionJsonAspNetCore\DbSettings.json'.
Source=Microsoft.Extensions.Configuration.FileExtensions
StackTrace:
 at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
 at Microsoft.Extensions.Configuration.ConfigurationManager.AddSource(IConfigurationSource source)
 at Microsoft.Extensions.Configuration.ConfigurationManager.Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(IConfigurationSource source)
 at Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(IConfigurationBuilder builder, String path, Boolean optional, Boolean reloadOnChange)
 at Program.<Main>$(String[] args) in C:\ConfiguracionJsonAspNetCore\Program.cs:line 3

¡IMPORTANTE!

Hay que tener muy presente el orden en el cual se agregan los archivos, ya que, dependiendo de eso, sus valores serán sobrescritos o reemplazados.

Configuración en ASP.NET Core Mediante Archivos JSON

Artículos Relacionados

Recursos Adicionales