欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

如何使用.NET Core 選項(xiàng)模式【Options】

 更新時(shí)間：2020年07月01日 10:29:39   作者：詹偉  
這篇文章主要介紹了如何使用.NET Core 選項(xiàng)模式，文中講解非常詳細(xì)，代碼幫助大家更好的理解和學(xué)習(xí)，感興趣的朋友可以了解下

ASP.NET Core引入了Options模式，使用類(lèi)來(lái)表示相關(guān)的設(shè)置組。簡(jiǎn)單的來(lái)說(shuō)，就是用強(qiáng)類(lèi)型的類(lèi)來(lái)表達(dá)配置項(xiàng)，這帶來(lái)了很多好處。利用了系統(tǒng)的依賴(lài)注入，并且還可以利用配置系統(tǒng)。它使我們可以采用依賴(lài)注入的方法直接使用綁定的一個(gè)POCO對(duì)象，這個(gè)POCO對(duì)象就叫做Options對(duì)象。也可以叫做配置對(duì)象。

以下大多內(nèi)容來(lái)自官方文檔，我只是個(gè)翻譯官或者叫搬運(yùn)工吧！

引入Options擴(kuò)展包

PM>Package-install Microsoft.Extensions.Options

綁定分層配置

在appsetting.json文件增加如下配置

"Position": {
  "Title": "Editor",
  "Name": "Joe Smith"
 }

創(chuàng)建以下 PositionOptions 類(lèi)：

public class PositionOptions
{
  public const string Position = "Position";

  public string Title { get; set; }
  public string Name { get; set; }
}

選項(xiàng)類(lèi)：

  • 必須是包含公共無(wú)參數(shù)構(gòu)造函數(shù)的非抽象類(lèi)。
  • 類(lèi)型的所有公共讀寫(xiě)屬性都已綁定。
  • 不會(huì)綁定字段。 在上面的代碼中，Position 未綁定。 由于使用了 Position 屬性，因此在將類(lèi)綁定到配置提供程序時(shí)，不需要在應(yīng)用中對(duì)字符串 "Position" 進(jìn)行硬編碼。

類(lèi)綁定

調(diào)用 ConfigurationBinder.Bind 將 PositionOptions 類(lèi)綁定到 Position 部分。然后就可以用了，當(dāng)然這種方式在開(kāi)發(fā).NET Core種并不常用，一般采用依賴(lài)注入的方式注入。

var positionOptions = new PositionOptions();
Configuration.GetSection(PositionOptions.Position).Bind(positionOptions);

使用 ConfigurationBinder.Get 可能比使用 ConfigurationBinder.Bind 更方便。

positionOptions = Configuration.GetSection(PositionOptions.Position).Get<PositionOptions>();

依賴(lài)項(xiàng)注入服務(wù)容器

修改ConfigureServices方法

public void ConfigureServices(IServiceCollection services)
{
  services.Configure<PositionOptions>(Configuration.GetSection(
                    PositionOptions.Position));
  services.AddRazorPages();
}

通過(guò)使用前面的代碼，以下代碼將讀取位置選項(xiàng)：

public class Test2Model : PageModel
{
  private readonly PositionOptions _options;

  public Test2Model(IOptions<PositionOptions> options)
  {
    _options = options.Value;
  }

  public ContentResult OnGet()
  {
    return Content($"Title: {_options.Title} \n" +
            $"Name: {_options.Name}");
  }
}

選項(xiàng)接口
初學(xué)者會(huì)發(fā)現(xiàn)這個(gè)框架有3個(gè)主要的面向消費(fèi)者的接口：IOptions、IOptionsMonitor以及IOptionsSnapshot。

這三個(gè)接口初看起來(lái)很類(lèi)似，所以很容易引起困惑，什么場(chǎng)景下該用哪個(gè)接口呢？

1.IOptions

  • 不支持

（1）在應(yīng)用啟動(dòng)后讀取配置數(shù)據(jù)。

（2）命名選項(xiàng)

  • 注冊(cè)為單一實(shí)例，可以注入到任何服務(wù)生存期。

2.IOptionsSnapshot

  • 作用域容器配置熱更新使用它
  • 注冊(cè)為范圍內(nèi)，因此無(wú)法注入到單一實(shí)例服務(wù)
  • 支持命名選項(xiàng)

3.IOptionsMonitor

  • 用于檢索選項(xiàng)并管理 TOptions 實(shí)例的選項(xiàng)通知。
  • 注冊(cè)為單一實(shí)例且可以注入到任何服務(wù)生存期。
  • 支持

（1）更改通知
（2）命名選項(xiàng)
（3）可重載配置
（4）選擇性選項(xiàng)失效

使用 IOptionsSnapshot 讀取已更新的數(shù)據(jù)

IOptionsMonitor 和 IOptionsSnapshot 之間的區(qū)別在于：

  • IOptionsMonitor 是一種單一示例服務(wù)，可隨時(shí)檢索當(dāng)前選項(xiàng)值，這在單一實(shí)例依賴(lài)項(xiàng)中尤其有用。
  • IOptionsSnapshot 是一種作用域服務(wù)，并在構(gòu)造 IOptionsSnapshot 對(duì)象時(shí)提供選項(xiàng)的快照。 選項(xiàng)快照旨在用于暫時(shí)性和有作用域的依賴(lài)項(xiàng)。
public class TestSnapModel : PageModel
{
  private readonly MyOptions _snapshotOptions;

  public TestSnapModel(IOptionsSnapshot<MyOptions> snapshotOptionsAccessor)
  {
    _snapshotOptions = snapshotOptionsAccessor.Value;
  }

  public ContentResult OnGet()
  {
    return Content($"Option1: {_snapshotOptions.Option1} \n" +
            $"Option2: {_snapshotOptions.Option2}");
  }
}

IOptionsMonitor

public class TestMonitorModel : PageModel
{
  private readonly IOptionsMonitor<MyOptions> _optionsDelegate;

  public TestMonitorModel(IOptionsMonitor<MyOptions> optionsDelegate )
  {
    _optionsDelegate = optionsDelegate;
  }

  public ContentResult OnGet()
  {
    return Content($"Option1: {_optionsDelegate.CurrentValue.Option1} \n" +
            $"Option2: {_optionsDelegate.CurrentValue.Option2}");
  }
}

命名選項(xiàng)支持使用 IConfigureNamedOptions

命名選項(xiàng)：

  • 當(dāng)多個(gè)配置節(jié)綁定到同一屬性時(shí)有用。
  • 區(qū)分大小寫(xiě)。

appsettings.json文件

{
 "TopItem": {
  "Month": {
   "Name": "Green Widget",
   "Model": "GW46"
  },
  "Year": {
   "Name": "Orange Gadget",
   "Model": "OG35"
  }
 }
}

下面的類(lèi)用于每個(gè)節(jié)，而不是創(chuàng)建兩個(gè)類(lèi)來(lái)綁定 TopItem:Month 和 TopItem:Year

public class TopItemSettings
{
  public const string Month = "Month";
  public const string Year = "Year";

  public string Name { get; set; }
  public string Model { get; set; }
}

依賴(lài)注入容器

public void ConfigureServices(IServiceCollection services)
{
  services.Configure<TopItemSettings>(TopItemSettings.Month,
                    Configuration.GetSection("TopItem:Month"));
  services.Configure<TopItemSettings>(TopItemSettings.Year,
                    Configuration.GetSection("TopItem:Year"));

  services.AddRazorPages();
}

服務(wù)應(yīng)用

public class TestNOModel : PageModel
{
  private readonly TopItemSettings _monthTopItem;
  private readonly TopItemSettings _yearTopItem;

  public TestNOModel(IOptionsSnapshot<TopItemSettings> namedOptionsAccessor)
  {
    _monthTopItem = namedOptionsAccessor.Get(TopItemSettings.Month);
    _yearTopItem = namedOptionsAccessor.Get(TopItemSettings.Year);
  }
}

使用 DI 服務(wù)配置選項(xiàng)

在配置選項(xiàng)時(shí)，可以通過(guò)以下兩種方式通過(guò)依賴(lài)關(guān)系注入訪問(wèn)服務(wù)：

  • 將配置委托傳遞給 OptionsBuilder 上的 Configure
    • services.AddOptions<MyOptions>("optionalName")
  .Configure<Service1, Service2, Service3, Service4, Service5>(
    (o, s, s2, s3, s4, s5) => 
      o.Property = DoSomethingWith(s, s2, s3, s4, s5));
  • 創(chuàng)建實(shí)現(xiàn) IConfigureOptions 或 IConfigureNamedOptions 的類(lèi)型，并將該類(lèi)型注冊(cè)為服務(wù)

建議將配置委托傳遞給 Configure，因?yàn)閯?chuàng)建服務(wù)較復(fù)雜。 在調(diào)用 Configure 時(shí)，創(chuàng)建類(lèi)型等效于框架執(zhí)行的操作。 調(diào)用 Configure 會(huì)注冊(cè)臨時(shí)泛型 IConfigureNamedOptions，它具有接受指定的泛型服務(wù)類(lèi)型的構(gòu)造函數(shù)。

選項(xiàng)驗(yàn)證

appsettings.json 文件

{
 "MyConfig": {
  "Key1": "My Key One",
  "Key2": 10,
  "Key3": 32
 }
}

下面的類(lèi)綁定到 "MyConfig" 配置節(jié)，并應(yīng)用若干 DataAnnotations 規(guī)則：

public class MyConfigOptions
{
  public const string MyConfig = "MyConfig";

  [RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
  public string Key1 { get; set; }
  [Range(0, 1000,
    ErrorMessage = "Value for {0} must be between {1} and {2}.")]
  public int Key2 { get; set; }
  public int Key3 { get; set; }
}
  • 啟用DataAnnotations驗(yàn)證
    • public void ConfigureServices(IServiceCollection services)
{
  services.AddOptions<MyConfigOptions>()
    .Bind(Configuration.GetSection(MyConfigOptions.MyConfig))
    .ValidateDataAnnotations();

  services.AddControllersWithViews();
}

使用IValidateOptions更復(fù)雜的配置

public class MyConfigValidation : IValidateOptions<MyConfigOptions>
{
  public MyConfigOptions _config { get; private set; }

  public MyConfigValidation(IConfiguration config)
  {
    _config = config.GetSection(MyConfigOptions.MyConfig)
      .Get<MyConfigOptions>();
  }

  public ValidateOptionsResult Validate(string name, MyConfigOptions options)
  {
    string vor=null;
    var rx = new Regex(@"^[a-zA-Z''-'\s]{1,40}$");
    var match = rx.Match(options.Key1);

    if (string.IsNullOrEmpty(match.Value))
    {
      vor = $"{options.Key1} doesn't match RegEx \n";
    }

    if ( options.Key2 < 0 || options.Key2 > 1000)
    {
      vor = $"{options.Key2} doesn't match Range 0 - 1000 \n";
    }

    if (_config.Key2 != default)
    {
      if(_config.Key3 <= _config.Key2)
      {
        vor += "Key3 must be > than Key2.";
      }
    }

    if (vor != null)
    {
      return ValidateOptionsResult.Fail(vor);
    }

    return ValidateOptionsResult.Success;
  }
}

IValidateOptions 允許將驗(yàn)證代碼移出 StartUp 并將其移入類(lèi)中。

使用前面的代碼，使用以下代碼在 Startup.ConfigureServices 中啟用驗(yàn)證

public void ConfigureServices(IServiceCollection services)
{
  services.Configure<MyConfigOptions>(Configuration.GetSection(
                    MyConfigOptions.MyConfig));
  services.TryAddEnumerable(ServiceDescriptor.Singleton<IValidateOptions
               <MyConfigOptions>, MyConfigValidation>());
  services.AddControllersWithViews();
}

選項(xiàng)后期配置

使用 IPostConfigureOptions 設(shè)置后期配置。進(jìn)行所有 IConfigureOptions 配置后運(yùn)行后期配置

services.PostConfigure<MyOptions>(myOptions =>
{
  myOptions.Option1 = "post_configured_option1_value";
});

使用 PostConfigureAll 對(duì)所有配置實(shí)例進(jìn)行后期配置

在啟動(dòng)期間訪問(wèn)選項(xiàng)

IOptions 和 IOptionsMonitor 可用于 Startup.Configure 中，因?yàn)樵?Configure 方法執(zhí)行之前已生成服務(wù)。

public void Configure(IApplicationBuilder app, 
  IOptionsMonitor<MyOptions> optionsAccessor)
{
  var option1 = optionsAccessor.CurrentValue.Option1;
}

結(jié)論

IOptions<>是單例，因此一旦生成了，除非通過(guò)代碼的方式更改，它的值是不會(huì)更新的。

IOptionsMonitor<>也是單例，但是它通過(guò)IOptionsChangeTokenSource<> 能夠和配置文件一起更新，也能通過(guò)代碼的方式更改值。

IOptionsSnapshot<>是范圍，所以在配置文件更新的下一次訪問(wèn)，它的值會(huì)更新，但是它不能跨范圍通過(guò)代碼的方式更改值，只能在當(dāng)前范圍（請(qǐng)求）內(nèi)有效。

所以你應(yīng)該根據(jù)你的實(shí)際使用場(chǎng)景來(lái)選擇到底是用這三者中的哪一個(gè)。

一般來(lái)說(shuō)，如果你依賴(lài)配置文件，那么首先考慮IOptionsMonitor<>，如果不合適接著考慮IOptionsSnapshot<>，最后考慮IOptions<>。

有一點(diǎn)需要注意，在ASP.NET Core應(yīng)用中IOptionsMonitor可能會(huì)導(dǎo)致同一個(gè)請(qǐng)求中選項(xiàng)的值不一致,當(dāng)你正在修改配置文件的時(shí)候,這可能會(huì)引發(fā)一些奇怪的bug。

如果這個(gè)對(duì)你很重要，請(qǐng)使用IOptionsSnapshot，它可以保證同一個(gè)請(qǐng)求中的一致性，但是它可能會(huì)帶來(lái)輕微的性能上的損失。
如果你是在app啟動(dòng)的時(shí)候自己構(gòu)造Options（比如在Startup類(lèi)中）：

services.Configure<TestOptions>(opt => opt.Name = "Test");

IOptions<>最簡(jiǎn)單，也許是一個(gè)不錯(cuò)的選擇。

以上就是如何使用.NET Core 選項(xiàng)模式【Options】的詳細(xì)內(nèi)容，更多關(guān)于.NET Core 選項(xiàng)模式【Options】的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

相關(guān)文章

最新評(píng)論