[ASP.NET Core 3框架揭秘] Options[7]: 与配置系统的整合

Options模型本身与配置系统完全没有关系,但是配置在大部分情况下会作为绑定Options对象的数据源,所以有必要将两者结合在一起。与《扩展与定制》演示的两个例子一样,针对配置系统的集成同样是通过定制Options模型相应的对象来实现的。具体来说,集成配置系统需要解决如下两个问题:

  • 将承载配置数据的IConfiguration对象绑定为Options对象。

  • 自动感知配置数据的变化。

第一个问题涉及针对Options对象的初始化问题,这自然是通过自定义IConfigureOptions<TOptions>实现类型来解决的,具体来说就是下面的NamedConfigureFromConfigurationOptions<TOptions>类型,它定义在NuGet包“Microsoft.Extensions.Options.ConfigurationExtensions”中。如下面的代码片段所示,NamedConfigureFromConfigurationOptions<TOptions>通过调用ConfigurationBinder的静态方法Bind利用配置绑定机制来实现配置数据向Options对象的转换。

public class NamedConfigureFromConfigurationOptions<TOptions> : ConfigureNamedOptions<TOptions> where TOptions : class
{
    public NamedConfigureFromConfigurationOptions(string name, IConfiguration config)
        : base(name, options => ConfigurationBinder.Bind(config, options))
    {}
}

第二个问题则采用自定义的IOptionsChangeTokenSource<TOptions>实现类型来解决,具体提供的就是下面的ConfigurationChangeTokenSource<TOptions>。从给出的代码片段可以看出,GetChangeToken方法直接调用IConfiguration对象的GetReloadToken方法得到返回的IChangeToken对象。

public class ConfigurationChangeTokenSource<TOptions> : IOptionsChangeTokenSource<TOptions>
{
    private IConfiguration _config;
    public string Name { get; }

    public ConfigurationChangeTokenSource(IConfiguration config) : this(Options.DefaultName, config)
    { }
    public ConfigurationChangeTokenSource(string name, IConfiguration config)
    {
        _config = config;
        Name = name ?? Options.DefaultName;
    }

    public IChangeToken GetChangeToken() => _config.GetReloadToken()
}

将IConfiguration对象绑定为Options对象的NamedConfigureFromConfigurationOptions<TOptions>和用来检测配置数据变化的ConfigurationChangeTokenSource<TOptions>都是通过下面的Configure<TOptions>扩展方法来注册的。

public static class OptionsConfigurationServiceCollectionExtensions
{    
    public static IServiceCollection Configure<TOptions>( this IServiceCollection services, IConfiguration config) where TOptions : class
        => services.Configure<TOptions>(Options.Options.DefaultName, config);
    
    public static IServiceCollection Configure<TOptions>( this IServiceCollection services, string name, IConfiguration config)  where TOptions : class
        => services
         .AddSingleton<IOptionsChangeTokenSource<TOptions>>( new ConfigurationChangeTokenSource<TOptions>(name, config))
         .AddSingleton<IConfigureOptions<TOptions>>( new NamedConfigureFromConfigurationOptions<TOptions>(name, config));
}
我来评几句
登录后评论

已发表评论数()

相关站点

+订阅
热门文章