.net core 选项数据热更新：让服务感知配置的变化

• .net core 选项数据热更新：让服务感知配置的变化
  • 关键类型
  • 场景
  • 通过代码更新选项
  • 内容示例
    • 项目架构
    • 通过 Scoped 模式修改 appsetting.json 配置查看结果
    • 通过 Scoped模式 以及 Snapshot 进行热更新
    • 当通过 单例模式 的时候是怎样的呢?
    • 通过 单例模式 与 IOptionsMonitor 也可以做到热更新
    • IOptionsMonitor 可以做到变动时事件监听的效果
    • 使用静态扩展
    • 使用动态配置配置对象

关键类型

• IOptionsMonitor
• IOptionsSnapshot

场景

• 范围作用域类型使用 IOptionsSnapshot
• 单例服务使用 IOptionsMonitor

通过代码更新选项

• IPostConfigureOptions

内容示例

项目架构

参考：https://www.tnblog.net/hb/article/details/4716

通过 Scoped 模式修改 appsetting.json 配置查看结果

Startup.cs

...
//改成 Scoped模式：每次HTTP请求会创建一个实例
services.AddScoped<IOrderService, OrderService>();
...

第一次运行结果

修改appsetting.json 把 MaxOrderCount 的值改为 2000

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "OrderService": {
    "MaxOrderCount":  2000
  },
  "AllowedHosts": "*"
}

仍然为200

通过 Scoped模式 以及 Snapshot 进行热更新

OrderService.cs

public class OrderService : IOrderService
{
    IOptionsSnapshot<OrderServiceOptions> _orderServiceOptions;
    public OrderService(IOptionsSnapshot<OrderServiceOptions> orderServiceOptions)
    {
        _orderServiceOptions = orderServiceOptions;
    }
    public int ShowMaxOrderCount()
    {
        return _orderServiceOptions.Value.MaxOrderCount;
    }
}

同样的操作运行结果

当通过 单例模式 的时候是怎样的呢?

Startup.cs

...
//改成 单例模式：唯一的一个实例
services.AddSingleton<IOrderService, OrderService>();
...

我们发现这里直接报错了，无法使用 IOptionsSnapshot

通过 单例模式 与 IOptionsMonitor 也可以做到热更新

OrderService.cs

public class OrderService : IOrderService
{
    IOptionsMonitor<OrderServiceOptions> _orderServiceOptions;
    public OrderService(IOptionsMonitor<OrderServiceOptions> orderServiceOptions)
    {
        _orderServiceOptions = orderServiceOptions;
    }
    public int ShowMaxOrderCount()
    {
        return _orderServiceOptions.CurrentValue.MaxOrderCount;
    }
}

运行结果

IOptionsMonitor 可以做到变动时事件监听的效果

OrderService.cs

public class OrderService : IOrderService
{
    IOptionsMonitor<OrderServiceOptions> _orderServiceOptions;
    public OrderService(IOptionsMonitor<OrderServiceOptions> orderServiceOptions)
    {
        _orderServiceOptions = orderServiceOptions;
        //添加监听
        orderServiceOptions.OnChange((a) =>
        {
            Console.WriteLine($"The value is Change：{a.MaxOrderCount}");
        });
    }
    public int ShowMaxOrderCount()
    {
        return _orderServiceOptions.CurrentValue.MaxOrderCount;
    }
}

结果
这里修改了一次出现了两次更改是因为它同时监听了当前项目中的 appsetting.json 与运行时的 appsetting.json

使用静态扩展

当我们运用大量的依赖注入的时候,可以考虑使用静态扩展方法

OrderServiceExtensions.cs

namespace Microsoft.Extensions.DependencyInjection
{
    public static class OrderServiceExtensions
    {
        public static IServiceCollection AddOrderService(this IServiceCollection services,IConfiguration configuration)
        {
            services.Configure<OrderServiceOptions>(configuration);
            services.AddSingleton<IOrderService, OrderService>();
            return services;
        }
    }
}

Startup.cs

...
public void ConfigureServices(IServiceCollection services)
{
    services.AddOrderService(Configuration.GetSection("OrderService"));
    services.AddControllers();
}

使用动态配置配置对象

比如当加载完成时我们还需要给 MaxOrderCount + 100

OrderServiceExtensions.cs

namespace Microsoft.Extensions.DependencyInjection
{
    public static class OrderServiceExtensions
    {
        public static IServiceCollection AddOrderService(this IServiceCollection services,IConfiguration configuration)
        {
            services.Configure<OrderServiceOptions>(configuration);
            //动态配置
            services.PostConfigure<OrderServiceOptions>(option =>
            {
                option.MaxOrderCount += 100;
            });
            services.AddSingleton<IOrderService, OrderService>();
            return services;
        }
    }
}

当前配置为：200 结果：