Microsoft.Extensions.Options 8.0.2

关于

Microsoft.Extensions.Options 以强类型方式通过依赖注入指定和访问设置，并作为配置、DI 和高级库之间的桥梁。这个库是应用程序开发者使用 DI 来配置 HttpClient Factory 等库的行为的粘合剂。这也使得用户可以对他们的配置获取强类型的视图。

在本包中，您将找到一个用于验证选项的选项验证源生成器，它可以生成非常高效和优化的代码用于验证选项。

关键特性

• 提供IValidateOptions接口用于验证选项，以及实现此接口的几个泛型ValidateOptions类。
• OptionsBuilder用于配置选项。
• 提供为服务集合和OptionsBuilder提供扩展方法来注册和验证选项。
• 提供一组实现IConfigureNamedOptions接口的泛型ConfigureNamedOptions类，用于配置命名选项。
• 提供生成选项验证代码的源生成器。
• 选项缓存、管理和监控。

使用说明

选项验证示例

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; }
}

使用IValidateOptions验证选项

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;
    }
}

选项验证源生成器示例

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();
}

主要类型

此库提供的主要类型包括：

• IOptions，IOptionsFactory 和 IOptionsMonitor
• IValidateOptions 和 ValidateOptions
• OptionsBuilder，OptionsFactory，OptionsMonitor 和 OptionsManager
• OptionsServiceCollectionExtensions
• OptionsValidatorAttribute

附加文档

• 概念文档
• API文档

相关包

Microsoft.Extensions.Logging Microsoft.Extensions.Configuration

反馈 & 贡献

Microsoft.Extensions.Options以开源形式发布，遵循MIT许可证。欢迎在GitHub仓库提交错误报告和贡献。