ASP.NET Core - 选项系统之源码介绍

下一站港口

.NET Core 选项系统的主要实现在 Microsoft.Extensions.Options 和 Microsoft.Extensions.Options.ConfigurationExtensions 两个 Nuget 包。对于一个框架的源码进行解读，我们可以从我们常用的框架中的类或方法入手，这些类或方法就是我们解读的入口。
从上面对选项系统的介绍中，大家也可以看出，日常对选项系统的使用涉及到的主要有 Configure 方法，有 IOptions、IOptionsSnapshot、IOptionMonitor 等接口。
Configure

首先看选项注册，也就是 Configure 方法，注册相关的方法都是扩展方法，上面也讲到 Configure 方法有多个扩展来源，其中最常用的是 OptionsConfigurationServiceCollectionExtensions 中的 Configure 方法，该方法用于从配置信息中读取配置并绑定为选项，如下，这里将相应的方法单独摘出来了。
点击查看代码 OptionsConfigurationServiceCollectionExtensions.Configure

1. public static class OptionsConfigurationServiceCollectionExtensions
2. {
3.         /// <summary>
4.         /// Registers a configuration instance which TOptions will bind against.
5.         /// </summary>
6.         /// <typeparam name="TOptions">The type of options being configured.</typeparam>
7.         /// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
8.         /// <param name="config">The configuration being bound.</param>
9.         /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
10.         [RequiresUnreferencedCode(OptionsBuilderConfigurationExtensions.TrimmingRequiredUnreferencedCodeMessage)]
11.         public static IServiceCollection Configure<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TOptions>(this IServiceCollection services, IConfiguration config) where TOptions : class
12.                 => services.Configure<TOptions>(Options.Options.DefaultName, config);
14.         /// <summary>
15.         /// Registers a configuration instance which TOptions will bind against.
16.         /// </summary>
17.         /// <typeparam name="TOptions">The type of options being configured.</typeparam>
18.         /// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
19.         /// <param name="name">The name of the options instance.</param>
20.         /// <param name="config">The configuration being bound.</param>
21.         /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
22.         [RequiresUnreferencedCode(OptionsBuilderConfigurationExtensions.TrimmingRequiredUnreferencedCodeMessage)]
23.         public static IServiceCollection Configure<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TOptions>(this IServiceCollection services, string name, IConfiguration config) where TOptions : class
24.                 => services.Configure<TOptions>(name, config, _ => { });
26.         /// <summary>
27.         /// Registers a configuration instance which TOptions will bind against.
28.         /// </summary>
29.         /// <typeparam name="TOptions">The type of options being configured.</typeparam>
30.         /// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
31.         /// <param name="config">The configuration being bound.</param>
32.         /// <param name="configureBinder">Used to configure the <see cref="BinderOptions"/>.</param>
33.         /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
34.         [RequiresUnreferencedCode(OptionsBuilderConfigurationExtensions.TrimmingRequiredUnreferencedCodeMessage)]
35.         public static IServiceCollection Configure<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TOptions>(this IServiceCollection services, IConfiguration config, Action<BinderOptions> configureBinder)
36.                 where TOptions : class
37.                 => services.Configure<TOptions>(Options.Options.DefaultName, config, configureBinder);
39.         /// <summary>
40.         /// Registers a configuration instance which TOptions will bind against.
41.         /// </summary>
42.         /// <typeparam name="TOptions">The type of options being configured.</typeparam>
43.         /// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
44.         /// <param name="name">The name of the options instance.</param>
45.         /// <param name="config">The configuration being bound.</param>
46.         /// <param name="configureBinder">Used to configure the <see cref="BinderOptions"/>.</param>
47.         /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
48.         [RequiresUnreferencedCode(OptionsBuilderConfigurationExtensions.TrimmingRequiredUnreferencedCodeMessage)]
49.         public static IServiceCollection Configure<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TOptions>(this IServiceCollection services, string name, IConfiguration config, Action<BinderOptions> configureBinder)
50.                 where TOptions : class
51.         {
52.                 if (services == null)
53.                 {
54.                         throw new ArgumentNullException(nameof(services));
55.                 }
57.                 if (config == null)
58.                 {
59.                         throw new ArgumentNullException(nameof(config));
60.                 }
62.                 services.AddOptions();
63.                 services.AddSingleton<IOptionsChangeTokenSource<TOptions>>(new ConfigurationChangeTokenSource<TOptions>(name, config));
64.                 return services.AddSingleton<IConfigureOptions<TOptions>>(new NamedConfigureFromConfigurationOptions<TOptions>(name, config, configureBinder));
65.         }
66. }

复制代码

其中 IOptionsChangeTokenSource 接口是用来监听配置变化的服务，这个后面讲。
另外还有 OptionsServiceCollectionExtensions 中的 Configure 方法，用于直接通过委托对选项类进行配置。
点击查看代码 OptionsServiceCollectionExtensions.Configure

1. public static class OptionsServiceCollectionExtensions
2. {
4.         public static IServiceCollection Configure<TOptions>(this IServiceCollection services, Action<TOptions> configureOptions) where TOptions : class
5.                 => services.Configure(Options.Options.DefaultName, configureOptions);
7.         public static IServiceCollection Configure<TOptions>(this IServiceCollection services, string name, Action<TOptions> configureOptions)
8.                 where TOptions : class
9.         {
10.                 if (services == null)
11.                 {
12.                         throw new ArgumentNullException(nameof(services));
13.                 }
15.                 if (configureOptions == null)
16.                 {
17.                         throw new ArgumentNullException(nameof(configureOptions));
18.                 }
20.                 services.AddOptions();
21.                 services.AddSingleton<IConfigureOptions<TOptions>>(new ConfigureNamedOptions<TOptions>(name, configureOptions));
22.                 return services;
23.         }
24. }

复制代码

可以看出，其实选项系统中的选项都是命名模式的，默认名称为 Options.Options.DefaultName，实际就是 string.Empty。当我们调用 Configure 方法对选项进行配置的时候，实际上时调用了 AddOptions 方法，并且往容器中添加了一个单例的实现了 IConfigureOptions 接口的实现。
IConfigureOptions、IConfigureNamedOptions、IPostConfigureOptions

其中 IConfigureOptions 是选项配置行为服务接口，ConfigureOptions 是它的默认实现，该类的内容很简单，它的内部主要就是保存了一个委托，用于记录使用者对选项的配置操作。
点击查看代码 ConfigureOptions

1. public class ConfigureOptions<TOptions> : IConfigureOptions<TOptions> where TOptions : class
2. {
3.         /// <summary>
4.         /// Constructor.
5.         /// </summary>
6.         /// <param name="action">The action to register.</param>
7.         public ConfigureOptions(Action<TOptions> action)
8.         {
9.                 Action = action;
10.         }
12.         /// <summary>
13.         /// The configuration action.
14.         /// </summary>
15.         public Action<TOptions> Action { get; }
17.         /// <summary>
18.         /// Invokes the registered configure <see cref="Action"/>.
19.         /// </summary>
20.         /// <param name="options">The options instance to configure.</param>
21.         public virtual void Configure(TOptions options)
22.         {
23.                 if (options == null)
24.                 {
25.                         throw new ArgumentNullException(nameof(options));
26.                 }
28.                 Action?.Invoke(options);
29.         }
30. }

复制代码

IConfigureNamedOptions 继承了 IConfigureNamedOptions 接口，默认实现是 ConfigureNamedOptions ，作用一样，只不过多了一个方法用于应对命名选项模式。它有多个重载泛型重载，也是之前的文章ASP.NET Core - 选型系统之选型配置 中讲到的“使用DI服务配置选项”的具体实现。
点击查看代码 ConfigureNamedOptions```csharppublic class ConfigureNamedOptions : IConfigureNamedOptions where TOptions : class{        ///         /// Constructor.        ///         /// The name of the options.        /// The action to register.        public ConfigureNamedOptions(string name, Action action)        {                Name = name;                Action = action;        }

1. /// <summary>
2. /// The options name.
3. /// </summary>
4. public string Name { get; }
6. /// <summary>
7. /// The configuration action.
8. /// </summary>
9. public Action<TOptions> Action { get; }
11. /// <summary>
12. /// Invokes the registered configure <see cref="Action"/> if the <paramref name="name"/> matches.
13. /// </summary>
14. /// <param name="name">The name of the options instance being configured.</param>
15. /// <param name="options">The options instance to configure.</param>
16. public virtual void Configure(string name, TOptions options)
17. {
18.         if (options == null)
19.         {
20.                 throw new ArgumentNullException(nameof(options));
21.         }
23.         // Null name is used to configure all named options.
24.         if (Name == null || name == Name)
25.         {
26.                 Action?.Invoke(options);
27.         }
28. }
30. /// <summary>
31. /// Invoked to configure a <typeparamref name="TOptions"/> instance with the <see cref="Options.DefaultName"/>.
32. /// </summary>
33. /// <param name="options">The options instance to configure.</param>
34. public void Configure(TOptions options) => Configure(Options.DefaultName, options);

复制代码

}

1. </details>
3. 而 NamedConfigureFromConfigurationOptions<TOptions> 类是 IConfigureNamedOptions<TOptions> 的另一个实现，继承了ConfigureNamedOptions<TOptions> 类，重写了一些行为，最终是通过之前讲到的 ConfigurationBuilder的 Bind 方法将配置绑定到选项类而已。
5. <details>
6. <summary>点击查看代码 NamedConfigureFromConfigurationOptions<TOptions></summary>
8. ```csharp
9. public class NamedConfigureFromConfigurationOptions<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TOptions> : ConfigureNamedOptions<TOptions>
10.         where TOptions : class
11. {
12.         /// <summary>
13.         /// Constructor that takes the <see cref="IConfiguration"/> instance to bind against.
14.         /// </summary>
15.         /// <param name="name">The name of the options instance.</param>
16.         /// <param name="config">The <see cref="IConfiguration"/> instance.</param>
17.         [RequiresUnreferencedCode(OptionsBuilderConfigurationExtensions.TrimmingRequiredUnreferencedCodeMessage)]
18.         public NamedConfigureFromConfigurationOptions(string name, IConfiguration config)
19.                 : this(name, config, _ => { })
20.         { }
22.         /// <summary>
23.         /// Constructor that takes the <see cref="IConfiguration"/> instance to bind against.
24.         /// </summary>
25.         /// <param name="name">The name of the options instance.</param>
26.         /// <param name="config">The <see cref="IConfiguration"/> instance.</param>
27.         /// <param name="configureBinder">Used to configure the <see cref="BinderOptions"/>.</param>
28.         [RequiresUnreferencedCode(OptionsBuilderConfigurationExtensions.TrimmingRequiredUnreferencedCodeMessage)]
29.         public NamedConfigureFromConfigurationOptions(string name, IConfiguration config, Action<BinderOptions> configureBinder)
30.                 : base(name, options => BindFromOptions(options, config, configureBinder))
31.         {
32.                 if (config == null)
33.                 {
34.                         throw new ArgumentNullException(nameof(config));
35.                 }
36.         }
38.         [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
39.                 Justification = "The only call to this method is the constructor which is already annotated as RequiresUnreferencedCode.")]
40.         private static void BindFromOptions(TOptions options, IConfiguration config, Action<BinderOptions> configureBinder) => config.Bind(options, configureBinder);
41. }

复制代码

其他的 IPostConfigureOptions 接口也是一样套路，当我们通过相应的方法传入委托对选项类进行配置的时候，会向容器中注入一个单例服务，将配置行为保存起来。
接着往下看 AddOptions 方法，AddOptions 方法有两个重载：
点击查看代码 AddOptions```csharppublic static class OptionsServiceCollectionExtensions{        public static IServiceCollection AddOptions(this IServiceCollection services)        {                if (services == null)                {                        throw new ArgumentNullException(nameof(services));                }

1.         services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptions<>), typeof(UnnamedOptionsManager<>)));
2.         services.TryAdd(ServiceDescriptor.Scoped(typeof(IOptionsSnapshot<>), typeof(OptionsManager<>)));
3.         services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptionsMonitor<>), typeof(OptionsMonitor<>)));
4.         services.TryAdd(ServiceDescriptor.Transient(typeof(IOptionsFactory<>), typeof(OptionsFactory<>)));
5.         services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptionsMonitorCache<>), typeof(OptionsCache<>)));
6.         return services;
7. }
8. public static OptionsBuilder<TOptions> AddOptions<TOptions>(this IServiceCollection services, string name)
9.         where TOptions : class
10. {
11.         if (services == null)
12.         {
13.                 throw new ArgumentNullException(nameof(services));
14.         }
16.         services.AddOptions();
17.         return new OptionsBuilder<TOptions>(services, name);
18. }

复制代码

}

1. </details>
3. 这里可以看出两者的返回值不同，而且第二个方法也调用了第一个方法，第一个方法中主要就是向容器中添加我们常用的IOptions<TOptions>、IOptionsSnapshot<TOptions>、IOptionsMonitor<TOptions> 服务接口，这里也可以看到不同服务接口对于的生命周期。除此之外还有工厂服务IOptionsFactory<>和缓存服务IOptionsMonitorCache<>，这两个就是选项体系的关键。每个选项进行配置的时候都会同时注入这些服务，所以每一个选项我们都能使用三个不同接口去解析。
5. # OptionsBuilder
7. 上面第二个 AddOptions 方法返回 OptionsBuilder<TOptions> 对象。之前讲过 OptionsBuilder<TOptions> 类中也有 Configure 方法，其实不止 Configure 方法，其他的 PostConfigure 方法等也有，它其实就是最终的选项系统配置类，我们所有的选项配置其实都可以通过调用第二个 AddOptions 方法，再通过 OptionsBuilder<TOptions> 对象中的方法来完成配置。其他各个扩展方法的配置方式不过是进行了使用简化而已。
9. <details>
10. <summary>点击查看代码 OptionsBuilder<TOptions></summary>
12. ```csharp
13. public class OptionsBuilder<TOptions> where TOptions : class
14. {
15.         private const string DefaultValidationFailureMessage = "A validation error has occurred.";
16.        
17.         public string Name { get; }
18.        
19.         public IServiceCollection Services { get; }
20.        
21.         public OptionsBuilder(IServiceCollection services, string name)
22.         {
23.                 Services = services;
24.                 Name = name ?? Options.DefaultName;
25.         }
26.        
27.         public virtual OptionsBuilder<TOptions> Configure(Action<TOptions> configureOptions)
28.         {
29.                 Services.AddSingleton<IConfigureOptions<TOptions>>(new ConfigureNamedOptions<TOptions>(Name, configureOptions));
30.                 return this;
31.         }
32.        
33.         public virtual OptionsBuilder<TOptions> PostConfigure(Action<TOptions> configureOptions)
34.         {
35.                 Services.AddSingleton<IPostConfigureOptions<TOptions>>(new PostConfigureOptions<TOptions>(Name, configureOptions));
36.                 return this;
37.         }
38.        
39.         public virtual OptionsBuilder<TOptions> Validate(Func<TOptions, bool> validation)
40.                 => Validate(validation: validation, failureMessage: DefaultValidationFailureMessage);
41.                
42.         public virtual OptionsBuilder<TOptions> Validate(Func<TOptions, bool> validation, string failureMessage)
43.         {
44.                 Services.AddSingleton<IValidateOptions<TOptions>>(new ValidateOptions<TOptions>(Name, validation, failureMessage));
45.                 return this;
46.         }
47. }

复制代码

IValidateOptions

我们除了可以对选项进行配置绑定之外，还可以对选项进行验证。验证规则是通过上面的第二个 AddOptions 方法返回的 OptionsBuilder 方法进行添加的。
验证规则配置有三种方式，最后其实都是通过 IValidateOptions 的实现类来完成。我们自己实现的自定义验证类就不用说了，最后我们会将其注入到容器中，而从上面的代码中可以看到，当我们通过委托的方式自定义验证规则的时候，它会被构建成一个 ValidateOptions 类对象，并注入到容器中作为一个服务。
ValidateOptions 是 IValidateOptions 的一个实现类，构造函数中接收委托，通过委托返回的 bool 结构判断验证是否通过。
点击查看代码 ValidateOptions

1. public class ValidateOptions<TOptions> : IValidateOptions<TOptions> where TOptions : class
2. {
3.         /// <summary>
4.         /// Constructor.
5.         /// </summary>
6.         /// <param name="name">Options name.</param>
7.         /// <param name="validation">Validation function.</param>
8.         /// <param name="failureMessage">Validation failure message.</param>
9.         public ValidateOptions(string name, Func<TOptions, bool> validation, string failureMessage)
10.         {
11.                 Name = name;
12.                 Validation = validation;
13.                 FailureMessage = failureMessage;
14.         }
16.         /// <summary>
17.         /// The options name.
18.         /// </summary>
19.         public string Name { get; }
21.         /// <summary>
22.         /// The validation function.
23.         /// </summary>
24.         public Func<TOptions, bool> Validation { get; }
26.         /// <summary>
27.         /// The error to return when validation fails.
28.         /// </summary>
29.         public string FailureMessage { get; }
31.         /// <summary>
32.         /// Validates a specific named options instance (or all when <paramref name="name"/> is null).
33.         /// </summary>
34.         /// <param name="name">The name of the options instance being validated.</param>
35.         /// <param name="options">The options instance.</param>
36.         /// <returns>The <see cref="ValidateOptionsResult"/> result.</returns>
37.         public ValidateOptionsResult Validate(string name, TOptions options)
38.         {
39.                 // null name is used to configure all named options
40.                 if (Name == null || name == Name)
41.                 {
42.                         if ((Validation?.Invoke(options)).Value)
43.                         {
44.                                 return ValidateOptionsResult.Success;
45.                         }
46.                         return ValidateOptionsResult.Fail(FailureMessage);
47.                 }
49.                 // ignored if not validating this instance
50.                 return ValidateOptionsResult.Skip;
51.         }
52. }

复制代码

我们可以通过重载方法传入相应的验证失败提醒文本。
Options、UnnamedOptionsManager

接下来看选项使用相关的内容，其中 IOptions 中的选项类一经创建一直保持不变，默认实现类 UnnamedOptionsManager。
点击查看代码 UnnamedOptionsManager

1. internal sealed class UnnamedOptionsManager<[DynamicallyAccessedMembers(Options.DynamicallyAccessedMembers)] TOptions> :
2.         IOptions<TOptions>
3.         where TOptions : class
4. {
5.         private readonly IOptionsFactory<TOptions> _factory;
6.         private volatile object _syncObj;
7.         private volatile TOptions _value;
9.         public UnnamedOptionsManager(IOptionsFactory<TOptions> factory) => _factory = factory;
11.         public TOptions Value
12.         {
13.                 get
14.                 {
15.                         if (_value is TOptions value)
16.                         {
17.                                 return value;
18.                         }
20.                         lock (_syncObj ?? Interlocked.CompareExchange(ref _syncObj, new object(), null) ?? _syncObj)
21.                         {
22.                                 return _value ??= _factory.Create(Options.DefaultName);
23.                         }
24.                 }
25.         }
26. }

复制代码

IOptions 接口只有一个 Value 属性，实现类中通过锁确保创建的 Value 值不会因为线程问题导致不同，且该服务被注册为单例生命周期，所以对象不销毁，后续一直会读取内存中的 Value 值。具体选项类对象的创建由工厂服务负责。
IOptionsSnapshot、OptionsManager

IOptionsSnapshot 的实现类是 OptionsManager，该类中有一个私有的 OptionsCache 属性，每次对选项类进行读取的时候，都是先尝试从缓存读取，如果没有才创建。而由于 IOptionsSnapshot 被注册为请求域生命周期，所以单次请求内相应对象不会销毁，缓存不会清空，会一直保持一个。
点击查看代码 OptionsManager

1. public class OptionsManager<[DynamicallyAccessedMembers(Options.DynamicallyAccessedMembers)] TOptions> :
2.         IOptions<TOptions>,
3.         IOptionsSnapshot<TOptions>
4.         where TOptions : class
5. {
6.         private readonly IOptionsFactory<TOptions> _factory;
7.         private readonly OptionsCache<TOptions> _cache = new OptionsCache<TOptions>(); // Note: this is a private cache
9.         /// <summary>
10.         /// Initializes a new instance with the specified options configurations.
11.         /// </summary>
12.         /// <param name="factory">The factory to use to create options.</param>
13.         public OptionsManager(IOptionsFactory<TOptions> factory)
14.         {
15.                 _factory = factory;
16.         }
18.         /// <summary>
19.         /// The default configured <typeparamref name="TOptions"/> instance, equivalent to Get(Options.DefaultName).
20.         /// </summary>
21.         public TOptions Value => Get(Options.DefaultName);
23.         /// <summary>
24.         /// Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
25.         /// </summary>
26.         public virtual TOptions Get(string name)
27.         {
28.                 name = name ?? Options.DefaultName;
30.                 if (!_cache.TryGetValue(name, out TOptions options))
31.                 {
32.                         // Store the options in our instance cache. Avoid closure on fast path by storing state into scoped locals.
33.                         IOptionsFactory<TOptions> localFactory = _factory;
34.                         string localName = name;
35.                         options = _cache.GetOrAdd(name, () => localFactory.Create(localName));
36.                 }
38.                 return options;
39.         }
40. }

复制代码

IOptionsMonitor、OptionsMonitor

IOptionsMonitor 每次获取选项类都是最新的值，它实现类是 OptionsMonitor，实现类中使用了从容器中注入的单例缓存 IOptionsMonitorCache 来保存选项类，并且通过相应的 IOptionsChangeTokenSource 注册了选项类绑定内容的监听，例如上面讲到的 ConfigurationChangeTokenSource，在选项类配置内容改变的时候会触发事件，而在事件中会将缓存先情况并重新获取创建类，并且执行注册进来的额外的监听事件，可以看看下面的 InvokeChanged 方法。
点击查看代码 OptionsMonitor

1. public class OptionsMonitor<[DynamicallyAccessedMembers(Options.DynamicallyAccessedMembers)] TOptions> :
2.         IOptionsMonitor<TOptions>,
3.         IDisposable
4.         where TOptions : class
5. {
6.         private readonly IOptionsMonitorCache<TOptions> _cache;
7.         private readonly IOptionsFactory<TOptions> _factory;
8.         private readonly List<IDisposable> _registrations = new List<IDisposable>();
9.         internal event Action<TOptions, string> _onChange;
11.         /// <summary>
12.         /// Constructor.
13.         /// </summary>
14.         /// <param name="factory">The factory to use to create options.</param>
15.         /// <param name="sources">The sources used to listen for changes to the options instance.</param>
16.         /// <param name="cache">The cache used to store options.</param>
17.         public OptionsMonitor(IOptionsFactory<TOptions> factory, IEnumerable<IOptionsChangeTokenSource<TOptions>> sources, IOptionsMonitorCache<TOptions> cache)
18.         {
19.                 _factory = factory;
20.                 _cache = cache;
22.                 void RegisterSource(IOptionsChangeTokenSource<TOptions> source)
23.                 {
24.                         IDisposable registration = ChangeToken.OnChange(
25.                                           () => source.GetChangeToken(),
26.                                           (name) => InvokeChanged(name),
27.                                           source.Name);
29.                         _registrations.Add(registration);
30.                 }
32.                 // The default DI container uses arrays under the covers. Take advantage of this knowledge
33.                 // by checking for an array and enumerate over that, so we don't need to allocate an enumerator.
34.                 if (sources is IOptionsChangeTokenSource<TOptions>[] sourcesArray)
35.                 {
36.                         foreach (IOptionsChangeTokenSource<TOptions> source in sourcesArray)
37.                         {
38.                                 RegisterSource(source);
39.                         }
40.                 }
41.                 else
42.                 {
43.                         foreach (IOptionsChangeTokenSource<TOptions> source in sources)
44.                         {
45.                                 RegisterSource(source);
46.                         }
47.                 }
48.         }
50.         private void InvokeChanged(string name)
51.         {
52.                 name = name ?? Options.DefaultName;
53.                 _cache.TryRemove(name);
54.                 TOptions options = Get(name);
55.                 if (_onChange != null)
56.                 {
57.                         _onChange.Invoke(options, name);
58.                 }
59.         }
61.         /// <summary>
62.         /// The present value of the options.
63.         /// </summary>
64.         public TOptions CurrentValue
65.         {
66.                 get => Get(Options.DefaultName);
67.         }
69.         /// <summary>
70.         /// Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
71.         /// </summary>
72.         public virtual TOptions Get(string name)
73.         {
74.                 name = name ?? Options.DefaultName;
75.                 return _cache.GetOrAdd(name, () => _factory.Create(name));
76.         }
78.         /// <summary>
79.         /// Registers a listener to be called whenever <typeparamref name="TOptions"/> changes.
80.         /// </summary>
81.         /// <param name="listener">The action to be invoked when <typeparamref name="TOptions"/> has changed.</param>
82.         /// <returns>An <see cref="IDisposable"/> which should be disposed to stop listening for changes.</returns>
83.         public IDisposable OnChange(Action<TOptions, string> listener)
84.         {
85.                 var disposable = new ChangeTrackerDisposable(this, listener);
86.                 _onChange += disposable.OnChange;
87.                 return disposable;
88.         }
90.         /// <summary>
91.         /// Removes all change registration subscriptions.
92.         /// </summary>
93.         public void Dispose()
94.         {
95.                 // Remove all subscriptions to the change tokens
96.                 foreach (IDisposable registration in _registrations)
97.                 {
98.                         registration.Dispose();
99.                 }
101.                 _registrations.Clear();
102.         }
104.         internal sealed class ChangeTrackerDisposable : IDisposable
105.         {
106.                 private readonly Action<TOptions, string> _listener;
107.                 private readonly OptionsMonitor<TOptions> _monitor;
109.                 public ChangeTrackerDisposable(OptionsMonitor<TOptions> monitor, Action<TOptions, string> listener)
110.                 {
111.                         _listener = listener;
112.                         _monitor = monitor;
113.                 }
115.                 public void OnChange(TOptions options, string name) => _listener.Invoke(options, name);
117.                 public void Dispose() => _monitor._onChange -= OnChange;
118.         }
119. }

复制代码

OnChange 方法中传入的委托本来可以可以直接追加到事件中的，这里将其再包装多一层，是为了 OptionsMonitor 对象销毁的时候能够将相应的事件释放，如果不包装多一层的话，委托只在方法作用域中，对象释放的时候是获取不到的。
IOptionsMonitorCache、OptionsCache

OptionsCache 是 IOptionsMonitorCache 接口的的实现类，从上面可以看到 OptionsMonitor 和 OptionsSnapshot 都使用到了这个，OptionsSnapshot 通过内部创建的私有的缓存属性实现了请求域内选项类不变，而 OptionsMonitor 则通过它减少了每次都直接读取配置来源(如文件、数据库、配置中心api)的性能消耗，而是通过变更事件的方式进行更新。其实我们还可以在需要的时候注入IOptionsMonitorCache 服务自行对选项类进行更新。
OptionsCache 的具体实现比较简单，主要就是通过 ConcurrentDictionary 对象作为内存缓存，其中为了性能还再使用了 Lazy 方式。
IOptionsFactory、OptionsFactory

OptionsFactory 类实现 IOptionsFactory 接口，是选项类的实际创建配置之处，其实就是将之前注册到容器中与当前相关的各种配置、验证的行为配置类注入进来，再通过放射创建对象之后，将选项类对象传进去，逐一对相应的行为进行调用，最后得到一个成型的选项类。这里选项类的创建方式很简单，这也是要求选项类要有无参构造函数的原因。
点击查看代码 OptionsFactory

1. public class OptionsFactory<[DynamicallyAccessedMembers(Options.DynamicallyAccessedMembers)] TOptions> :
2.         IOptionsFactory<TOptions>
3.         where TOptions : class
4. {
5.         private readonly IConfigureOptions<TOptions>[] _setups;
6.         private readonly IPostConfigureOptions<TOptions>[] _postConfigures;
7.         private readonly IValidateOptions<TOptions>[] _validations;
9.         /// <summary>
10.         /// Initializes a new instance with the specified options configurations.
11.         /// </summary>
12.         /// <param name="setups">The configuration actions to run.</param>
13.         /// <param name="postConfigures">The initialization actions to run.</param>
14.         public OptionsFactory(IEnumerable<IConfigureOptions<TOptions>> setups, IEnumerable<IPostConfigureOptions<TOptions>> postConfigures) : this(setups, postConfigures, validations: Array.Empty<IValidateOptions<TOptions>>())
15.         { }
17.         /// <summary>
18.         /// Initializes a new instance with the specified options configurations.
19.         /// </summary>
20.         /// <param name="setups">The configuration actions to run.</param>
21.         /// <param name="postConfigures">The initialization actions to run.</param>
22.         /// <param name="validations">The validations to run.</param>
23.         public OptionsFactory(IEnumerable<IConfigureOptions<TOptions>> setups, IEnumerable<IPostConfigureOptions<TOptions>> postConfigures, IEnumerable<IValidateOptions<TOptions>> validations)
24.         {
25.                 // The default DI container uses arrays under the covers. Take advantage of this knowledge
26.                 // by checking for an array and enumerate over that, so we don't need to allocate an enumerator.
27.                 // When it isn't already an array, convert it to one, but don't use System.Linq to avoid pulling Linq in to
28.                 // small trimmed applications.
30.                 _setups = setups as IConfigureOptions<TOptions>[] ?? new List<IConfigureOptions<TOptions>>(setups).ToArray();
31.                 _postConfigures = postConfigures as IPostConfigureOptions<TOptions>[] ?? new List<IPostConfigureOptions<TOptions>>(postConfigures).ToArray();
32.                 _validations = validations as IValidateOptions<TOptions>[] ?? new List<IValidateOptions<TOptions>>(validations).ToArray();
33.         }
35.         /// <summary>
36.         /// Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
37.         /// </summary>
38.         public TOptions Create(string name)
39.         {
40.                 TOptions options = CreateInstance(name);
41.                 foreach (IConfigureOptions<TOptions> setup in _setups)
42.                 {
43.                         if (setup is IConfigureNamedOptions<TOptions> namedSetup)
44.                         {
45.                                 namedSetup.Configure(name, options);
46.                         }
47.                         else if (name == Options.DefaultName)
48.                         {
49.                                 setup.Configure(options);
50.                         }
51.                 }
52.                 foreach (IPostConfigureOptions<TOptions> post in _postConfigures)
53.                 {
54.                         post.PostConfigure(name, options);
55.                 }
57.                 if (_validations != null)
58.                 {
59.                         var failures = new List<string>();
60.                         foreach (IValidateOptions<TOptions> validate in _validations)
61.                         {
62.                                 ValidateOptionsResult result = validate.Validate(name, options);
63.                                 if (result is not null && result.Failed)
64.                                 {
65.                                         failures.AddRange(result.Failures);
66.                                 }
67.                         }
68.                         if (failures.Count > 0)
69.                         {
70.                                 throw new OptionsValidationException(name, typeof(TOptions), failures);
71.                         }
72.                 }
74.                 return options;
75.         }
77.         /// <summary>
78.         /// Creates a new instance of options type
79.         /// </summary>
80.         protected virtual TOptions CreateInstance(string name)
81.         {
82.                 return Activator.CreateInstance<TOptions>();
83.         }
84. }

复制代码

以上就是 .NET Core 下的选项系统，由于选项系统的源码不多，这里也就将大部分类都拿出来讲了一下，相当于把这个框架的流程思路都讲了一遍，不知不觉写得字数又很多了，希望有童鞋能够耐心地看到这里。


参考文章：
ASP.NET Core 中的选项模式 | Microsoft Learn
选项模式 - .NET | Microsoft Learn
面向 .NET 库创建者的选项模式指南 - .NET | Microsoft Learn
理解ASP.NET Core - 选项(Options)


ASP.NET Core 系列：
目录：ASP.NET Core 系列总结
上一篇：ASP.NET Core - 选项系统之选项验证

来源:https://www.cnblogs.com/wewant/archive/2023/03/30/17111746.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！