Configuration (AppSettings, Settings) in ASP.NET Core 3 + 5

Goal

Get some understanding of .NET Core configuration principles.

Configuration

Your program.cs usually calls CreateDefaultBuilder.

Look at the source code of CreateDefaultBuilder in WebHost.cs: https://github.com/dotnet/aspnetcore/blob/master/src/DefaultBuilder/src/WebHost.cs>

Reads configuration in the following order:

1. Read appsettings.json using the JSON configuration provider.
2. Read appsettings.<Environment>.json using the JSON configuration provider. For example, appsettings.Production.json and appsettings.Development.json.
3. App secrets (when the app runs in the Development environment)
4. Environment variables using the Environment Variables configuration provider.
   • check double underscore variables: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-8.0#non-prefixed-environment-variables
5. Command-line arguments using the Command-line configuration provider.

Configuration API

This is a deep dive into configuration: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/

Usually, you don't use configuration directly. If you have any application specific configuration or settings, you can use Options.

Bind

bind app-config section to object

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-8.0#bind-hierarchical-configuration-data-using-the-options-pattern

Environment

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/environments

• at developement time: ASPNETCORE_ENVIRONMENT is set in launchSettings.json
• at run time: set per stage by the environment variable ASPNETCORE_ENVIRONMENT=<environment>

Typed Options

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options

appsettings.json can contain application specific properties;

{
  "option1": "value1_from_json",
  "option2": -1,
}

You can create typed access (classes) to access your configuration settings.

1. Create option class

public class MyOptions
{
    public MyOptions()
    {
        Option1 = "default_value1_from_ctor"; // Set default value.
    }
    public string Option1 { get; set; }
    public int Option2 { get; set; } = 5; // Set default value.
}

2. Configure option class

Add the configuration to the dependency injection configuration in ConfigureServices of your startup.cs:

// Register the Configuration instance which MyOptions binds against.
services.Configure<MyOptions>(Configuration);

3. Use option class

Have the configuration injected configuration in your service:

public class MyClass
{
    private readonly MyOptions _myOption;

    public MyService(IOptions<MyOptions> options)
    {
        _myOption = options.Value;
    }
}

Dynamic Config

From David Fowler: https://github.com/davidfowl/DotNetCodingPatterns/blob/main/1.md

public class LibraryOptions
{
    public int Setting { get; set; }
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddOptions<LibraryOptions>()
            .Configure<ISomeService>((options, service) =>
            {
                options.Setting = service.ComputeSetting();
            });
}

Namespace, Category, Suboptions

You can structure your application properties in appsettings.json in subsections:

{
  "option1": "value1_from_json",
  "option2": -1,
  "subsection": {
    "suboption1": "subvalue1_from_json",
    "suboption2": 200
  }
}

Create normal classes ...

public class MySubOptions
{
    public MySubOptions()
    {
        SubOption1 = "default_value1_from_ctor"; // Set default value.
    }
    public string SubOption1 { get; set; }
    public int SubOption2 { get; set; } = 5; // Set default value.
}

.. and inject them like normal options.

Details: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options?view=aspnetcore-3.1#suboptions-configuration

Untyped options

Sometimes you cannot inject a typed configuration (for example if you use a generic, multipurpose factory). Use Bind() in this case:

public class MyTesterClass
    {
        private readonly IConfiguration _configuration;

        public MyTesterClass(IConfiguration configuration)
        {
            _configuration = configuration;
        }

        public void Test()
        {
            var options = new MyOptions();
            _configuration.Bind("<OptionNamespace>", options);
            var options = new MyOptions();
            _configuration.Bind("<OptionNamespace>:<OptionSubNamespace>", options); // suboptions
        }
    }
}

Secrets

Store Secrets

You do not want to store any confidential information (like passwords) in your source code. With secrets, you can store the passwords and other information you want to keep outside of your source code.

To store credentials on your computer, open cmd in the folder of <your-project>.csproj and run this:

dotnet user-secrets init
dotnet user-secrets set "<myPurpose:mySecretItem>" "<mySecret>"

Use secrets - by configuration

Inject the configuration in your service:

public class MyClass
{
    private readonly IConfiguration _configuration;

    public MyService(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public void MyFunction(){
        _mySecret = _configuration["<myPurpose:mySecretItem>"];
    }
}

Use secrets - by option

Inject the typed option in your service:

public class MyClass
{
    private readonly MyOptions _myOptions;

    public MyService(IOptions<MyOptions> options)
    {
        _myOptions = options.Value;
    }

    public void MyFunction(){
        _mySecret = _myOptions.Option1;
    }
}

Tip: You can check and manage user secrets by right-click on your main project: "Manage User Secrets".

Source: https://stackoverflow.com/questions/39174989/how-to-register-multiple-implementations-of-the-same-interface-in-asp-net-core

IConfigurationRoot: GetDebugView()

source: https://twitter.com/cecilphillip/status/1362064796057755651

app.UseEndpoints(endpoints => {
  endpoints.MapGet("/dump-config", async ctx => {
    var configInfo = (Configuration as IConfigurationRoot).GetDebugView();
    await ctx.Response.WriteAsync(configInfo);
  }
});

Secrets in .NET Framework

Use ConfigurationBuilders

What's next

• Add Third party logger (Serilog) to your backend: https://github.com/boeschenstein/angular9-dotnetcore3-logging
• Swagger/OpenApi are tools which can create your Angular code to access the backend: check this https://github.com/boeschenstein/angular9-dotnetcore-openapi-swagger

Additional Information

Links

• .NET Core Configuration: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-3.1
• Secrets: https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-3.1&tabs=windows
• Secrets in .NET Framework: https://github.com/aspnet/MicrosoftConfigurationBuilders
• Options: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options?view=aspnetcore-3.1
• Configuration: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-3.1
• ASP.NET WebApi: https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-3.1&tabs=visual-studio
• Dependency Injection: https://github.com/boeschenstein/aspnetcore5-dependency_injection
• About me: https://github.com/boeschenstein

Current Versions

• .NET Core 3, 5