5-Options

The Options Pattern in .NET is a design pattern that binds related configuration settings from sources like appsettings.json to strongly-typed C# classes.

Instead of extracting values using error-prone string keys from an injected IConfiguration object, it leverages dependency injection (DI) to supply isolated, validated configurations directly to your services.

This pattern promotes the software engineering principles of encapsulation and separation of concerns. [1, 2, 3, 4]

---

🛠️ Step-by-Step Implementation

1. Define the Configuration Section

Add a section to your appsettings.json file: [5]

{
  "WeatherOptions": {
    "City": "Trivandrum",
    "Temperature": 22,
    "EnableAlerts": true
  }
}

2. Create the Options Class

Create a Plain Old C# Object (POCO) matching the JSON structure. Do not make the class abstract, and ensure it has a public parameterless constructor. [2, 3, 4, 5]

public class WeatherOptions
{
    // A constant prevents magic string typos during binding
    public const string SectionName = "WeatherOptions"; 
 
    public string City { get; set; } = string.Empty;
    public int Temperature { get; set; }
    public bool EnableAlerts { get; set; }
}
 

3. Bind and Register in Program.cs

Use the standard .BindConfiguration() method to register the options container into the DI system: [2]

var builder = WebApplication.CreateBuilder(args);
 
// Binds appsettings data to your WeatherOptions class automatically
builder.Services.AddOptions<WeatherOptions>()
    .BindConfiguration(WeatherOptions.SectionName);
 

4. Inject and Consume via Dependency Injection

Inject the standard interface wrapper into your controller or service and read the settings via the .Value property: [2, 5]

public class WeatherController : ControllerBase
{
    private readonly WeatherOptions _options;
 
    // Inject using the IOptions interface wrapper
    public WeatherController(IOptions<WeatherOptions> options)
    {
        _options = options.Value;
    }
 
    [HttpGet]
    public IActionResult GetCity() => Ok($"Current city is {_options.City}");
}
 

---

⏱️ Choosing the Right Options Interface

Depending on how frequently your parameters change and your service lifetimes, you must choose from three primary interfaces: [3, 5]

Interface	Lifetime Registration	Configuration Updates	Best For
IOptions<T>	Singleton	Read once at startup. Ignores file changes.	Settings that never change during runtime (e.g., application name).
IOptionsSnapshot<T>	Scoped	Reloads per request. Values remain static within a single request.	Scoped or transient services needing up-to-date values on execution.
IOptionsMonitor<T>	Singleton	Real-time access. Uses file notifications to fetch live updates via .CurrentValue.	Singleton services that must dynamically respond to hot-reloads.

---

🛡️ Configuration Validation

To prevent invalid settings from compromising your live system, always utilize fail-fast startup validation: [2, 3]

1. Add Data Annotations to your settings properties: [3, 4]

using System.ComponentModel.DataAnnotations;
 
public class WeatherOptions
{
    public const string SectionName = "WeatherOptions";
 
    [Required, StringLength(50)]
    public string City { get; set; } = string.Empty;
 
    [Range(-50, 60)]
    public int Temperature { get; set; }
}
 

1. Enforce check criteria during runtime bootstrap using ValidateDataAnnotations() and ValidateOnStart(): [3, 4]

builder.Services.AddOptions<WeatherOptions>()
    .BindConfiguration(WeatherOptions.SectionName)
    .ValidateDataAnnotations()
    .ValidateOnStart(); // Crashes application deployment immediately if configuration is broken
 

Spring Boot Equivalent of Option

---

If you’d like, I can show you how to handle Named Options for multiple variations of the same class configuration, or show you how to write a custom IValidateOptions validator. Which area would you like to explore next? [3, 4, 6]

[1] https://learn.microsoft.com

[2] https://codewithmukesh.com

[3] https://medium.com

[4] https://learn.microsoft.com

[5] https://www.youtube.com

[6] https://medium.com

---

https://codewithmukesh.com/blog/options-pattern-in-aspnet-core/