.NET Core - 選項框架：服務組件集成配置的最佳實踐

Table of Contents

IOptions

配置變更

IOptionsSnapshot

IOptionsMonitor

PostConfigure

---

本節來學習選項框架的使用，通過本節，你將理解如題所示的服務組件集成配置的最佳實踐。

我們定義一個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

更多課程詳細內容，可識別下方二維碼購買。

【掃描二維碼購買課程，可後臺留言獲得10元紅包返現。】

                                             

部分內容來源於網絡，侵刪。

更多精彩內容，請微信搜索攻城獅客棧 或掃描下方二維碼

------------------------------------------------------------------------------

公衆號：攻城獅客棧

CSDN：畫雞蛋的不止達芬奇

 

                                                                 

讓我們一起變的更優秀。

---