2. 程式人生 > 其它 >.Net Core 中的選項Options

.Net Core 中的選項Options

阿新 • • 發佈：2021-09-07

.NetCore的配置選項建議結合在一起學習，不瞭解.NetCore 配置Configuration的同學可以看下我的上一篇文章 [.Net Core配置Configuration原始碼研究]

由程式碼開始


定義一個使用者配置選項

public class UserOptions
{
    private string instanceId;
    private static int index = 0;
    public UserOptions()
    {
        instanceId = (++index).ToString("00");
        Console.WriteLine($"Create UserOptions Instance:{instanceId}");
    }
    public string Name { get; set; }
    public int Age { get; set; }
    public override string ToString() => $"Name:{Name} Age:{Age} Instance:{instanceId} ";
}
public class UserOptions2
{
    public string Name { get; set; }
    public int Age { get; set; }
    public override string ToString() => $" Name:{Name} Age:{Age}";
}

定義json配置檔案:myconfig.json

{
  "UserOption": {
    "Name": "ConfigName-zhangsan",
    "Age": 666
  }
}

建立ServiceCollection

services = new ServiceCollection();
var configBuilder = new ConfigurationBuilder().AddInMemoryCollection().AddJsonFile("myconfig.json", true, true);
var iconfiguration = configBuilder.Build();
services.AddSingleton<IConfiguration>(iconfiguration);

示例程式碼

services.Configure<UserOptions>(x => { x.Name = "張三"; x.Age = new Random().Next(1, 10000); });
services.AddOptions<UserOptions2>().Configure<IConfiguration>((x, config) => { x.Name = config["UserOption:Name"]; x.Age = 100; }); ;
services.PostConfigure<UserOptions>(x => { x.Name = x.Name + "Post"; x.Age = x.Age; });
services.Configure<UserOptions>("default", x => { x.Name = "Default-張三"; x.Age = new Random().Next(1, 10000); });
services.Configure<UserOptions>("config", configuration.GetSection("UserOption"));
using (var provider = services.BuildServiceProvider())
{
    using (var scope1 = provider.CreateScope())
    {
        PrintOptions(scope1, "Scope1");
    }

    //修改配置檔案
    Console.WriteLine(string.Empty);
    Console.WriteLine("修改配置檔案");
    var filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "myconfig.json");
    File.WriteAllText(filePath, "{\"UserOption\": { \"Name\": \"ConfigName-lisi\", \"Age\": 777}}");
    //配置檔案的change回撥事件需要一定時間執行
    Thread.Sleep(300);
    Console.WriteLine(string.Empty);

    using (var scope2 = provider.CreateScope())
    {
        PrintOptions(scope2, "Scope2");
    }

    Console.WriteLine(string.Empty);

    using (var scope3 = provider.CreateScope())
    {
        PrintOptions(scope3, "Scope3");
    }
}

static void PrintOptions(IServiceScope scope, string scopeName)
{
    var options1 = scope.ServiceProvider.GetService<IOptions<UserOptions>>();
    Console.WriteLine($"手動注入讀取,IOptions,{scopeName}-----{ options1.Value}");

    var options2 = scope.ServiceProvider.GetService<IOptionsSnapshot<UserOptions>>();
    Console.WriteLine($"配置檔案讀取,IOptionsSnapshot,{scopeName}-----{ options2.Value}");
    var options3 = scope.ServiceProvider.GetService<IOptionsSnapshot<UserOptions>>();
    Console.WriteLine($"配置檔案根據名稱讀取,IOptionsSnapshot,{scopeName}-----{ options3.Get("config")}");

    var options4 = scope.ServiceProvider.GetService<IOptionsMonitor<UserOptions>>();
    Console.WriteLine($"配置檔案讀取,IOptionsMonitor,{scopeName}-----{ options4.CurrentValue}");
    var options5 = scope.ServiceProvider.GetService<IOptionsMonitor<UserOptions>>();
    Console.WriteLine($"配置檔案根據名稱讀取,IOptionsMonitor,{scopeName}-----{options5.Get("config")}");

    var options6 = scope.ServiceProvider.GetService<IOptions<UserOptions2>>();
    Console.WriteLine($"Options2-----{options6.Value}");
}

程式碼執行結果

Create UserOptions Instance:01
手動注入讀取,IOptions,Scope1----- Name:張三Post Age:6575 Instance:01
Create UserOptions Instance:02
配置檔案讀取,IOptionsSnapshot,Scope1----- Name:張三Post Age:835 Instance:02
Create UserOptions Instance:03
配置檔案根據名稱讀取,IOptionsSnapshot,Scope1----- Name:ConfigName-zhangsan Age:666 Instance:03
Create UserOptions Instance:04
配置檔案讀取,IOptionsMonitor,Scope1----- Name:張三Post Age:1669 Instance:04
Create UserOptions Instance:05
配置檔案根據名稱讀取,IOptionsMonitor,Scope1----- Name:ConfigName-zhangsan Age:666 Instance:05
Options2----- Name:ConfigName-zhangsan Age:100

修改配置檔案
Create UserOptions Instance:06

手動注入讀取,IOptions,Scope2----- Name:張三Post Age:6575 Instance:01
Create UserOptions Instance:07
配置檔案讀取,IOptionsSnapshot,Scope2----- Name:張三Post Age:5460 Instance:07
Create UserOptions Instance:08
配置檔案根據名稱讀取,IOptionsSnapshot,Scope2----- Name:ConfigName-lisi Age:777 Instance:08
配置檔案讀取,IOptionsMonitor,Scope2----- Name:張三Post Age:1669 Instance:04
配置檔案根據名稱讀取,IOptionsMonitor,Scope2----- Name:ConfigName-lisi Age:777 Instance:06
Options2----- Name:ConfigName-zhangsan Age:100

手動注入讀取,IOptions,Scope3----- Name:張三Post Age:6575 Instance:01
Create UserOptions Instance:09
配置檔案讀取,IOptionsSnapshot,Scope3----- Name:張三Post Age:5038 Instance:09
Create UserOptions Instance:10
配置檔案根據名稱讀取,IOptionsSnapshot,Scope3----- Name:ConfigName-lisi Age:777 Instance:10
配置檔案讀取,IOptionsMonitor,Scope3----- Name:張三Post Age:1669 Instance:04
配置檔案根據名稱讀取,IOptionsMonitor,Scope3----- Name:ConfigName-lisi Age:777 Instance:06
Options2----- Name:ConfigName-zhangsan Age:100

通過執行程式碼得到的結論

  • Options可通過手動初始化配置項配置（可在配置時讀取依賴注入的物件）、或通過IConfiguration繫結配置
  • PostConfiger可在Configer基礎上繼續配置
  • 可通過IOptionsSnapshot或IOptionsMonitor根據配置名稱讀取配置項，未指定名稱讀取第一個注入的配置
  • IOptions和IOptionsMonitor生命週期為Singleton，IOptionsSnapshot生命週期為Scope
  • IOptionsMonitor可監聽到配置檔案變動去動態更新配置項

問題

  • IOptions,IOptionsSnapshot,IOptionsMonitor 如何/何時注入、初始化
  • Options指定名稱時內部是如何設定的
  • Options如何繫結的IConfiguration
  • IOptionsMonitor是如何同步配置檔案變動的


配合原始碼解決疑惑


Configure注入

public static IServiceCollection Configure<TOptions>(this IServiceCollection services, Action<TOptions> configureOptions) where TOptions : class
{
    return services.Configure(Microsoft.Extensions.Options.Options.DefaultName, configureOptions);
}

public static IServiceCollection Configure<TOptions>(this IServiceCollection services, string name, Action<TOptions> configureOptions) where TOptions : class
{
	services.AddOptions();
	services.AddSingleton((IConfigureOptions<TOptions>)new ConfigureNamedOptions<TOptions>(name, configureOptions));
	return services;
}

public static IServiceCollection AddOptions(this IServiceCollection services)
{
	services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptions<>), typeof(OptionsManager<>)));
	services.TryAdd(ServiceDescriptor.Scoped(typeof(IOptionsSnapshot<>), typeof(OptionsManager<>)));
	services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptionsMonitor<>), typeof(OptionsMonitor<>)));
	services.TryAdd(ServiceDescriptor.Transient(typeof(IOptionsFactory<>), typeof(OptionsFactory<>)));
	services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptionsMonitorCache<>), typeof(OptionsCache<>)));
	return services;
}

通過上面的原始碼可以發現，Options相關類是在AddOptions中注入的，具體的配置項在Configure中注入。

如果不指定Configure的Name，也會有個預設的Name=Microsoft.Extensions.Options.Options.DefaultName

那麼我們具體的配置項存到哪裡去了呢，在ConfigureNamedOptions這個類中，在Configer函式呼叫時，只是把相關的配置委託存了起來：

public ConfigureNamedOptions(string name, Action<TOptions> action)
{
	Name = name;
	Action = action;
}

OptionsManager

private readonly ConcurrentDictionary<string, Lazy<TOptions>> _cache = new ConcurrentDictionary<string, Lazy<TOptions>>(StringComparer.Ordinal);

public TOptions Value => Get(Options.DefaultName);

public virtual TOptions Get(string name)
{
	name = name ?? Options.DefaultName;
	return _cache.GetOrAdd(name, () => _factory.Create(name));
}

OptionsManager實現相對較簡單，在查詢時需要執行Name，如果為空就用預設的Name，如果快取沒有，就用Factory建立一個，否則就讀快取中的選項。

IOptions和IOptionsSnapshot的實現類都是OptionsManager，只是生命週期不同。


OptionsFactory

那麼OptionsFactory又是如何建立Options的呢？我們看一下他的建構函式，建構函式將所有Configure和PostConfigure的初始化委託都通過建構函式儲存在內部變數中

public OptionsFactory(IEnumerable<IConfigureOptions<TOptions>> setups, IEnumerable<IPostConfigureOptions<TOptions>> postConfigures)
	{
        _setups = setups;
        _postConfigures = postConfigures;
	}

接下來看Create（有刪改，與本次研究無關的程式碼沒有貼出來）：

	public TOptions Create(string name)
	{
        //首先建立對應Options的例項
		TOptions val = Activator.CreateInstance<TOptions>();
        //迴圈所有的配置項，依次執行，如果對同一個Options配置了多次，最後一次的賦值生效
		foreach (IConfigureOptions<TOptions> setup in _setups)
		{
			var configureNamedOptions = setup as IConfigureNamedOptions<TOptions>;
			if (configureNamedOptions != null)
			{
                //Configure中會判斷傳入Name的值與本身的Name值是否相同，不同則不執行Action
                //這解釋了我們一開始的示例中，注入了三個UserOptions，但是在IOptionsSnapshot.Value中獲取到的是第一個沒有名字的
                //因為Value會呼叫OptionsManager.Get(Options.DefaultName),進而呼叫Factory的Create(Options.DefaultName)
				configureNamedOptions.Configure(name, val);
			}
			else if (name == Options.DefaultName)
			{
				setup.Configure(val);
			}
		}
        
        //PostConfigure沒啥可多說了,名字判斷邏輯與Configure一樣
		foreach (var postConfigure in _postConfigures)
		{
			postConfigure.PostConfigure(name, val);
		}
		
		return val;
	}

NamedConfigureFromConfigurationOptions

IConfiguration配置Options的方式略有不同

對應Configure擴充套件方法最終呼叫的程式碼在Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions這個類中

public static IServiceCollection Configure<TOptions>(this IServiceCollection services, string name, IConfiguration config, Action<BinderOptions> configureBinder) where TOptions : class
{
	services.AddOptions();
	services.AddSingleton((IOptionsChangeTokenSource<TOptions>)new ConfigurationChangeTokenSource<TOptions>(name, config));
	return services.AddSingleton((IConfigureOptions<TOptions>)new NamedConfigureFromConfigurationOptions<TOptions>(name, config, configureBinder));
}

擴充套件方法裡又注入了一個IOptionsChangeTokenSource，這個類的作用是提供一個配置檔案變動監聽的Token

同時將IConfigureOptions實現類註冊成了NamedConfigureFromConfigurationOptions

NamedConfigureFromConfigurationOptions繼承了ConfigureNamedOptions，在建構函式中用IConfiguration.Bind實現了生成Options的委託

	public NamedConfigureFromConfigurationOptions(string name, IConfiguration config, Action<BinderOptions> configureBinder)
		: base(name, (Action<TOptions>)delegate(TOptions options)
		{
			config.Bind(options, configureBinder);
		})

所以在Factory的Create函式中，會呼叫IConfiguration的Bind函式

由於IOptionsSnapshot生命週期是Scope，在配置檔案變動後新的Scope中會獲取最新的Options


ValidateOptions

OptionsBuilder還包含了一個Validate函式，該函式要求傳入一個Func<TOptions,bool>的委託,會注入一個單例的ValidateOptions物件。

在OptionsFactory構建Options的時候會驗證Options的有效性,驗證失敗會丟擲OptionsValidationException異常

對於ValidateOptions和PostConfigureOptions都是構建Options例項時需要用到的主要模組，不過使用和內部實現都較為簡單，應用場景也不是很多，本文就不對這兩個類多做介紹了


結論

在Configure擴充套件函式中會首先呼叫AddOptions函式

IOptions,IOptionsSnapshot,IOptionsMonitor都是在AddOptions函式中注入的

Configure配置的選項配置委託最終會儲存到ConfigureNamedOptions或NamedConfigureFromConfigurationOptions

IOptions和IOptionsSnapshot的實現類為OptionsManager

OptionsManager通過OptionsFactory建立Options的例項，並會以Name作為鍵存到字典中快取例項

OptionsFactory會通過反射建立Options的例項，並呼叫ConfigureNamedOptions中的委託給例項賦值

現在只剩下最後一個問題了，OptionsMonitor是如何動態更新選項的呢？

其實前面的講解中已經提到了一個關鍵的介面IOptionsChangeTokenSource，這個介面提供一個IChangeToken,通過ChangeToken監聽這個Token就可以監聽到檔案的變動，我們來看下OptionsMonitor是否是這樣做的吧！

//建構函式
public OptionsMonitor(IOptionsFactory<TOptions> factory, IEnumerable<IOptionsChangeTokenSource<TOptions>> sources, IOptionsMonitorCache<TOptions> cache)
{
    _factory = factory;
    _sources = sources;
    _cache = cache;
    //迴圈屬於TOptions的所有IChangeToken
    foreach (IOptionsChangeTokenSource<TOptions> source in _sources)
    {
        ChangeToken.OnChange(() => source.GetChangeToken(), delegate(string name)
                             {

                                //清除快取 
                                name = name ?? Options.DefaultName;
								_cache.TryRemove(name);
                             }, source.Name);
    }
}



public virtual TOptions Get(string name)
{
    name = name ?? Options.DefaultName;
    return _cache.GetOrAdd(name, () => _factory.Create(name));
}

果然是這樣的吧！

相關推薦

.Net Core 中選項Options的具體實現

目錄由程式碼開始定義一個使用者配置選項定義on配置檔案:myconfig.json建立ServiceCollection示例程式碼程式碼執行結果通過執行程式碼得到的結論問題配合原始碼解決疑惑Configure注入OptionsManagerOptionsFactoryNa

.net core中的Options重新載入機制ConfigurationChangeTokenSource

　　Options是.net core提出的一種輔助配置機制，即選項。 　　目前，我們可以使用的Options有五種（原始碼）：

.Net Core 中的選項Options

.NetCore的配置選項建議結合在一起學習，不瞭解.NetCore 配置Configuration的同學可以看下我的上一篇文章 [.Net Core配置Configuration原始碼研究]

ASP.NET Core 學習筆記 第五篇 ASP.NET Core 中的選項

前言 還記得上一篇文章中所說的配置嗎？本篇文章算是上一篇的延續吧。在 .NET Core 中讀取配置檔案大多數會為配置選項繫結一個POCO(Plain Old CLR Object)物件，並通過依賴注入使用它。而這種使用方式稱之為選項模式

.Net Core之選項模式Options使用

一、簡要闡述 ASP.NET Core引入了Options模式，使用類來表示相關的設定組。簡單的來說，就是用強型別的類來表達配置項，這帶來了很多好處。利用了系統的依賴注入，並且還可以利用配置系統。它使我們可以採用依賴注入

在Asp.Net Core中使用ModelConvention實現全域性過濾器隔離

從何說起 這來自於我把專案遷移到Asp.Net Core的過程中碰到一個問題。在一個web程式中同時包含了MVC和WebAPI，現在需要給WebAPI部分單獨新增一個介面驗證過濾器 IActionFilter ，常規做法一般是寫好過濾器後給需要的

.Net Core中使用ExceptionFilter過濾器的方法

.Net Core中有各種Filter,分別是AuthorizationFilter、ResourceFilter、ExceptionFilter、ActionFilter、ResultFilter。可以把他們看作是.Net Core自帶的AOP的擴充套件封裝。

ASP.NET Core中的Http快取使用

Http響應快取可減少客戶端或代理對web伺服器發出的請求數。響應快取還減少了web伺服器生成響應所需的工作量。響應快取由Http請求中的header控制。

淺談ASP.NET Core 中jwt授權認證的流程原理

1，快速實現授權驗證 什麼是 JWT ？為什麼要用 JWT ？JWT 的組成？ 這些百度可以直接找到，這裡不再贅述。

.NET Core中建立和使用NuGet包的示例程式碼

在.NET Core的專案中，如果我們要在專案中引用其它DLL檔案，不建議直接在專案引用中新增DLL檔案（雖然在.NET Core專案中也可以這麼做），建議是去直接下載DLL檔案所屬的NuGet包。這樣最大的好處是我們可以將要引用DL

ASP.NET Core中的Controller使用示例

ASP.NET CORE出現之前我們實現的Controller，MVC都繼承自Controller基類，WebApi的話繼承自ApiController。現在ASP.NET CORE把MVC跟WebApi合併了，已經不再區分MVC或者WebApi。ASP.NET CORE的Controller繼承結構也發

詳解在.net core中完美解決多租戶分庫分表的問題

前幾天有人想做一個多租戶的平臺,每個租戶一個庫,可以進行水平擴充套件,應用端根據登入資訊,切換到不同的租戶庫

詳解ASP.NET Core中配置監聽URLs的五種方式

預設情況下，ASP. NET Core應用會監聽一下2個Url: http://localhost:5000 https://localhost:5001

ASP.NET Core中的Action的返回值型別實現

在Asp.net Core之前所有的Action返回值都是ActionResult，Json(),File()等方法返回的都是ActionResult的子類。並且Core把MVC跟WebApi合併之後Action的返回值體系也有了很大的變化。

Asp.net Core中實現自定義身份認證的示例程式碼

Asp.Net Core中雖然集成了許多常用的身份認證，但很多時候，我們還是需要實現自己的身份認證介面，本文這裡就簡單的介紹下如何實現自定義身份認證介面。

ASP.NET Core 中基於 API Key 對私有 Web API 進行保護

原文:ASP.NET Core 中基於 API Key 對私有 Web API 進行保護 這兩天遇到一個應用場景，需要對內網呼叫的部分 web api 進行安全保護，只允許請求頭賬戶包含指定 key 的客戶端進行呼叫。在網上找到一篇英文博文 ASP.N

詳解如何在C#/.NET Core中使用責任鏈模式

最近我有一個朋友在研究經典的“Gang Of Four”設計模式。他經常來詢問我在實際業務應用中使用了哪些設計模式。單例模式、工廠模式、中介者模式 - 都是我之前使用過，甚至寫過相關文章的模式。但是有一種模式是我還沒

Magicodes.IE在.NET Core中通过请求头导出多种格式文件

前言 在2.2里程碑中我们增加了一些新的功能,正如标题所写通过请求头进行导出我们不同格式的文件.下面我们来看一下如何使用.通过这种方式无论是对我们的数据多用途，还是说对我们的数据校验都做到了轻松易配。

Magicodes.IE在.NET Core中通過請求頭匯出多種格式檔案

前言 在2.2里程碑中我們增加了一些新的功能,正如標題所寫通過請求頭進行匯出我們不同格式的檔案.下面我們來看一下如何使用.通過這種方式無論是對我們的資料多用途，還是說對我們的資料校驗都做到了輕鬆易配。

.Net Core 中GC的工作原理

前言 .NET 中GC管理你服務的記憶體分配和釋放,GC是執行公共語言執行時(CLR Common Language Runtime)中,GC可以幫助開發人員有效的分配記憶體和和釋放記憶體,大多數情況下是不需要去擔心的,但是有時候服務總是是出現莫