本节来学习选项框架的使用，通过本节，你将理解如题所示的服务组件集成配置的最佳实践。
我们定义一个IOrderService接口，接口包含一个ShowMaxOrderCount方法
public interface IOrderService { void ShowMaxOrderCount(); }
定义一个OrderService服务实现这个接口
public class OrderService : IOrderService { OrderOptions orderOptions; public OrderService(OrderOptions orderOptions) { this.orderOptions = orderOptions; } public void ShowMaxOrderCount() { Console.WriteLine($"MaxOrderCount:{orderOptions.MaxOrderCount}"); } }
同时，我们定义一个类用来承载配置数据。
public class OrderOptions { public int MaxOrderCount { get; set; } = 100; public int TotalCount { get; set; } = 500; }
这样，我们通过将该服务注册到根容器之后，就可以通过前端来调用该服务方法了。
//根容器注册 services.AddSingleton<OrderOptions>(); services.AddSingleton<IOrderService, OrderService>();
//前端调用服务 [HttpGet] public void Get([FromServices]IOrderService service) { service.ShowMaxOrderCount(); }
但是，我们的配置肯定是会不停变化的，因此，我们需要从配置中读取值并绑定到配置类上，比如如下配置
{ //...省略不必要的 "MaxOrderCount": { "MaxOrderCount": 2000, "TotalCount": 1000 } }
其实，我们当然可以通过学习配置框架强类型绑定时的方式，将配置绑定到配置类来实现，但是这样的话，我们的服务就要依赖配置框架了。为了实现松耦合，微软为我们提供了选项框架来处理这种情形。
IOptions
当我们使用选项框架时，只需要用IOptions<>来包装我们的配置类，然后更改配置类的注册方式即可完成从配置文件读取配置信息
public class OrderService : IOrderService { IOptions<OrderOptions> options; public OrderService(IOptions<OrderOptions> options) { this.options = options; } public void ShowMaxOrderCount() { Console.WriteLine($"MaxOrderCount:{options.Value.MaxOrderCount}"); Console.WriteLine($"TotalOrderCount:{options.Value.TotalCount}"); } }
//注册方式 services.Configure<OrderOptions>(Configuration.GetSection("MaxOrderCount")); services.AddSingleton<IOrderService, OrderService>();
通过这种方式，我们即可完成服务组件的配置集成。
和之前一样，我们仍然对注册方式进行封装，用扩展方法的方式来表示
public static class OrderServiceExtension { public static IServiceCollection AddOrderService(this IServiceCollection services,IConfiguration configuration) { services.Configure<OrderOptions>(configuration); services.AddSingleton<IOrderService, OrderService>(); return services; } }
那么，使用选项框架时，我们如何来获取配置变更呢？
配置变更
首先，我们可定要定义ChangeToken.OnChange方法
ChangeToken.OnChange(() => Configuration.GetReloadToken(), () => { Console.WriteLine("重新加载配置"); });
对于选项框架的配置变更，我们有2种方式
- IOptionsSnapshot:针对scope模式
- IOptionsMonitor：针对单例模式，但也可用于scope模式
下面我们来说一下这两种方式的区别
IOptionsSnapshot
使用该方式时，只需修改服务中对应的配置类类型为IOptionsSnapshot<>。
public class OrderService : IOrderService { IOptionsSnapshot<OrderOptions> optionsSnapshot; public OrderService(IOptionsSnapshot<OrderOptions> optionsSnapshot) { this.optionsSnapshot = optionsSnapshot; } public void ShowMaxOrderCount() { Console.WriteLine($"MaxOrderCount:{optionsSnapshot.Value.MaxOrderCount}"); } }
那么，我们在每次请求时，都会获取到新的配置值（这里可以使用刷新模拟重新请求）
IOptionsMonitor
同样的，使用该方式时，我们需要更改配置类型为IOptionsMonitor<>
public class OrderService : IOrderService { IOptionsMonitor<OrderOptions> optionsMonitor; public OrderService(IOptionsMonitor<OrderOptions> optionsMonitor) { this.optionsMonitor= optionsMonitor; optionsMonitor.OnChange(options => { Console.WriteLine($"配置发生了变更，新值为{optionsMonitor.CurrentValue.MaxOrderCount}"); }); } public void ShowMaxOrderCount() { Console.WriteLine($"MaxOrderCount:{optionsSnapshot.Value.MaxOrderCount}"); } }
IOptionsMonitor有一个OnChange方法可用于监听配置的变化，我们可用该方法来获取变更，并对变更后的值进行操作。
其实，如果只是获取监听，ChangeToken.OnChange仍然有效，区别在于，在配置框架中可以对配置的值进行操作。
PostConfigure
PostConfigure可以对配置进行操作并提交其修改，适用于，当取出配置后，需要对配置进行操作后在使用的情况，如下
public static class OrderServiceExtension { public static IServiceCollection AddOrderService(this IServiceCollection services,IConfiguration configuration) { services.Configure<OrderOptions>(configuration); services.AddSingleton<IOrderService, OrderService>(); //对配置+10 services.PostConfigure<OrderOptions>(options => { options.MaxOrderCount += 10; }); return services; } }
好了，本篇到这里就结束了。下一篇学习选项框架中数据验证的3种方式。
源码可访问
https://github.com/IronMarmot/Samples/tree/master/CoreSamples
