Microsoft.Extensions.Options 8.0.0-rc.2.23479.6
About
Microsoft.Extensions.Options
provides a strongly typed way of specifying and accessing settings using dependency injection and acts as a bridge between configuration, DI, and higher level libraries. This library is the glue for how an app developer uses DI to configure the behavior of a library like HttpClient Factory. This also enables user to get a strongly-typed view of their configuration.
Within this package, you'll find an options validation source generator that generates exceptionally efficient and optimized code for validating options.
Key Features
- Offer the IValidateOptions interface for the validation of options, along with several generic ValidateOptions classes that implement this interface.
- OptionsBuilder to configure options.
- Provide extension methods for service collections and options builder to register options and validate options.
- Supply a set of generic ConfigureNamedOptions classes that implement the IConfigureNamedOptions interface for configuring named options.
- Provide a source generator that generates validation code for options.
- Options caching, managing and monitoring.
How to Use
Options validation example
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews();
// Load the configuration and validate it
builder.Services.AddOptions<MyConfigOptions>()
.Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
.ValidateDataAnnotations();
var app = builder.Build();
// Declare the option class to validate
public class MyConfigOptions
{
public const string MyConfig = "MyConfig";
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
public string Key1 { get; set; }
[Range(0, 1000,
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
public int Key2 { get; set; }
public int Key3 { get; set; }
}
Using IValidateOptions to validate options
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews();
// Configuration to validate
builder.Services.Configure<MyConfigOptions>(builder.Configuration.GetSection(
MyConfigOptions.MyConfig));
// OPtions validation through the DI container
builder.Services.AddSingleton<IValidateOptions
<MyConfigOptions>, MyConfigValidation>();
var app = builder.Build();
public class MyConfigValidation : IValidateOptions<MyConfigOptions>
{
public MyConfigOptions _config { get; private set; }
public MyConfigValidation(IConfiguration config)
{
_config = config.GetSection(MyConfigOptions.MyConfig)
.Get<MyConfigOptions>();
}
public ValidateOptionsResult Validate(string name, MyConfigOptions options)
{
string? vor = null;
var rx = new Regex(@"^[a-zA-Z''-'\s]{1,40}$");
var match = rx.Match(options.Key1!);
if (string.IsNullOrEmpty(match.Value))
{
vor = $"{options.Key1} doesn't match RegEx \n";
}
if ( options.Key2 < 0 || options.Key2 > 1000)
{
vor = $"{options.Key2} doesn't match Range 0 - 1000 \n";
}
if (_config.Key2 != default)
{
if(_config.Key3 <= _config.Key2)
{
vor += "Key3 must be > than Key2.";
}
}
if (vor != null)
{
return ValidateOptionsResult.Fail(vor);
}
return ValidateOptionsResult.Success;
}
}
Options Validation Source Generator Example
using System;
using System.ComponentModel.DataAnnotations;
using Microsoft.Extensions.Options;
public class MyConfigOptions
{
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
public string Key1 { get; set; }
[Range(0, 1000,
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
public int Key2 { get; set; }
public int Key3 { get; set; }
}
[OptionsValidator]
public partial class MyConfigValidation : IValidateOptions<MyConfigOptions>
{
// Source generator will automatically provide the implementation of IValidateOptions
// Then you can add the validation to the DI Container using the following code:
//
// builder.Services.AddSingleton<IValidateOptions
// <MyConfigOptions>, MyConfigValidation>();
// builder.Services.AddOptions<MyConfigOptions>()
// .Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
// .ValidateDataAnnotations();
}
Main Types
The main types provided by this library are:
IOptions
,IOptionsFactory
, andIOptionsMonitor
IValidateOptions
andValidateOptions
OptionsBuilder
,OptionsFactory
,OptionsMonitor
, andOptionsManager
OptionsServiceCollectionExtensions
OptionsValidatorAttribute
Additional Documentation
Related Packages
Microsoft.Extensions.Logging Microsoft.Extensions.Configuration
Feedback & Contributing
Microsoft.Extensions.Options is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.
Showing the top 20 packages that depend on Microsoft.Extensions.Options.
Packages | Downloads |
---|---|
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
|
1,123 |
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
|
1,058 |
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
|
1,005 |
Microsoft.Extensions.Diagnostics.Abstractions
Diagnostic abstractions for Microsoft.Extensions.Diagnostics.
Commonly Used Types:
Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder
Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener
Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule
Microsoft.Extensions.Diagnostics.Metrics.MeterScope
Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions
Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions
|
897 |
Microsoft.Extensions.Hosting
Hosting and startup infrastructures for applications.
|
862 |
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
|
848 |
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
|
844 |
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
|
841 |
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
840 |
Microsoft.Extensions.Logging.EventSource
EventSource/EventListener logger provider implementation for Microsoft.Extensions.Logging.
|
840 |
Microsoft.Extensions.Logging.EventLog
Windows Event Log logger provider implementation for Microsoft.Extensions.Logging.
|
833 |
Microsoft.Extensions.Http
The HttpClient factory is a pattern for configuring and retrieving named HttpClients in a composable way. The HttpClient factory provides extensibility to plug in DelegatingHandlers that address cross-cutting concerns such as service location, load balancing, and reliability. The default HttpClient factory provides built-in diagnostics and logging and manages the lifetimes of connections in a performant way.
Commonly Used Types:
System.Net.Http.IHttpClientFactory
|
401 |
AspNetCoreRateLimit
ASP.NET Core rate limiting middleware
|
292 |
Microsoft.Extensions.Http
The HttpClient factory is a pattern for configuring and retrieving named HttpClients in a composable way. The HttpClient factory provides extensibility to plug in DelegatingHandlers that address cross-cutting concerns such as service location, load balancing, and reliability. The default HttpClient factory provides built-in diagnostics and logging and manages the lifetimes of connections in a performant way.
Commonly used types:
System.Net.Http.IHttpClientFactory
|
283 |
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
|
280 |
Microsoft.AspNetCore.DataProtection
ASP.NET Core logic to protect and unprotect data, similar to DPAPI.
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/3f1acb59718cadf111a0a796681e3d3509bb3381
|
191 |
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
|
181 |
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
|
178 |
Microsoft.Extensions.Logging.EventLog
Windows Event Log logger provider implementation for Microsoft.Extensions.Logging.
|
178 |
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
|
177 |
.NET Framework 4.6.2
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0-rc.2.23479.6)
- Microsoft.Extensions.Primitives (>= 8.0.0-rc.2.23479.6)
- System.ValueTuple (>= 4.5.0)
.NET 6.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0-rc.2.23479.6)
- Microsoft.Extensions.Primitives (>= 8.0.0-rc.2.23479.6)
.NET 7.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0-rc.2.23479.6)
- Microsoft.Extensions.Primitives (>= 8.0.0-rc.2.23479.6)
.NET 8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0-rc.2.23479.6)
- Microsoft.Extensions.Primitives (>= 8.0.0-rc.2.23479.6)
.NET Standard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0-rc.2.23479.6)
- Microsoft.Extensions.Primitives (>= 8.0.0-rc.2.23479.6)
- System.ComponentModel.Annotations (>= 5.0.0)
.NET Standard 2.1
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0-rc.2.23479.6)
- Microsoft.Extensions.Primitives (>= 8.0.0-rc.2.23479.6)
- System.ComponentModel.Annotations (>= 5.0.0)