ASP.NET Core 選項模式源碼學習Options Configure(一)

来源:https://www.cnblogs.com/yyfh/archive/2019/12/11/12020522.html

前言 ASP.NET Core 後我們的配置變得更加輕量級了,在ASP.NET Core中,配置模型得到了顯著的擴展和增強,應用程式配置可以存儲在多環境變數配置中,appsettings.json用戶機密等 並可以通過應用程式中的相同界面輕鬆訪問,除此之外,ASP.NET中的新配置系統允許使用Opt ...


前言

ASP.NET Core 後我們的配置變得更加輕量級了,在ASP.NET Core中,配置模型得到了顯著的擴展和增強,應用程式配置可以存儲在多環境變數配置中,appsettings.json用戶機密等 並可以通過應用程式中的相同界面輕鬆訪問,除此之外,ASP.NET中的新配置系統允許使用Options的強類型設置。

強類型Options

在ASP.NET Core中沒有AppSettings["Key"]預設方法,那麼推薦的是創建強類型的配置類,去綁定配置項。


    public class MyOptions
    {
        public string Name { get; set; }

        public string Url { get; set; }
    }

然後我們在appsettings.json中添加如下內容:


{
  "MyOptions": 
    {
      "Name": "TestName",
      "Url": "TestUrl"
    }
}

配置綁定到類

ConfigureServices方法進行配置以綁定到類

        public void ConfigureServices(IServiceCollection services)
        {

            services.Configure<MyOptions>(Configuration.GetSection("MyOptions"));
            services.AddControllers();

        }

MyOptions只需將IOptions<>類的實例註入控制器中,然後通過Value屬性獲取Myoptions:


    public class WeatherForecastController : ControllerBase
    {
        private readonly MyOptions _options;
        public WeatherForecastController(IOptions<MyOptions> options)
        {
            _options = options.Value;
        }

        [HttpGet]
        public OkObjectResult Get() {
            return Ok(string.Format("Name:{0},Url:{1}", _options.Name,_options.Url));
        }
    }

Configure

委托配置

            //基礎註冊方式
            services.Configure<MyOptions>(o => { o.Url = "MyOptions"; o.Name = "Name111"; });
            //指定具體名稱
            services.Configure<MyOptions>("Option", o => { o.Url = "MyOptions"; o.Name = "Name111"; }) ;
            //配置所有實例
            services.ConfigureAll<MyOptions>(options =>{ options.Name = "Name1";  options.Url = "Url1";});

通過配置文件配置

           // 使用配置文件來註冊實例
            services.Configure<MyOptions>(Configuration.GetSection("MyOptions"));
            // 指定具體名稱
            services.Configure<MyOptions>("Option", Configuration.GetSection("MyOptions"));
PostConfigure

PostConfigure會在Configure註冊完之後再進行註冊


     services.PostConfigure<MyOptions>(o => o.Name = "Name1");
            services.PostConfigure<MyOptions>("Option", o => o.Name = "Name1");
            services.PostConfigureAll<MyOptions>(o => o.Name = "Name1");

源碼解析

IConfigureOptions介面


    public interface IConfigureOptions<in TOptions> where TOptions : class
    {
        
        void Configure(TOptions options);
    }

Configure為方便使用IConfigureOptions註冊單例ConfigureNamedOptions


     public static IServiceCollection Configure<TOptions>(this IServiceCollection services, string name, Action<TOptions> configureOptions)
            where TOptions : class
        {
            if (services == null)
            {
                throw new ArgumentNullException(nameof(services));
            }

            if (configureOptions == null)
            {
                throw new ArgumentNullException(nameof(configureOptions));
            }

            services.AddOptions();
            services.AddSingleton<IConfigureOptions<TOptions>>(new ConfigureNamedOptions<TOptions>(name, configureOptions));
            return services;
        }


上面代碼IConfigureOptions實現了ConfigureNamedOptions,那我們再來看看內部源碼
ConfigureNamedOptions 其實就是把我們註冊的Action包裝成統一的Configure方法,以方便後續創建Options實例時,進行初始化。


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

       
        public string Name { get; }

      
        public Action<TOptions> Action { get; }

      
        public virtual void Configure(string name, TOptions options)
        {
            if (options == null)
            {
                throw new ArgumentNullException(nameof(options));
            }

            // Null name is used to configure all named options.
            if (Name == null || name == Name)
            {
                Action?.Invoke(options);
            }
        }
        public void Configure(TOptions options) => Configure(Options.DefaultName, options);
    }

services.Configure(Configuration.GetSection("MyOptions")); 我們不指定具體名稱的時候預設是如下代碼片段


        public virtual void Configure(string name, TOptions options)
        {
            if (options == null)
            {
                throw new ArgumentNullException(nameof(options));
            }

            // Null name is used to configure all named options.
            if (Name == null || name == Name)
            {
                Action?.Invoke(options);
            }
        }
        public void Configure(TOptions options) => Configure(Options.DefaultName, options);

預設使用的是Options.DefaultName

AddOptions預設方法預設為我們註冊了一些核心的類


     public static IServiceCollection AddOptions(this IServiceCollection services)
        {
            if (services == null)
            {
                throw new ArgumentNullException(nameof(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;
        }
        

您的分享是我們最大的動力!

更多相關文章
一周排行
  • C#實現(Delegate)的委托就不多說了,直接上代碼,看代碼中的註釋: namespace Delegate { delegate void DGSayiHi(string name);//聲明委托 delegate void DGDo(string name); class Program { ...
  • C#實現的從小到大的冒泡排序: public void BubbleSort(int[] array) { int length = array.Length; for (int i = 0; i < length - 1; i++) { for (int j = length - 1; j > i ...
  • string aa = DateTime.Now.ToShortDateString();//"2019/9/23" string bb = DateTime.Now.ToShortTimeString();//"上午 10:21" string ff = DateTime.Now.ToLongDa ...
  • 1. 什麼是,以及怎麼用畫中畫 Windows 10 Creators Update以後UWP提供了一個新的視圖模式CompactOverlay,中文翻譯成 緊湊的覆蓋層 ?反正大部分時間我們都會稱它為 畫中畫模式 。 上圖中右上角即為進入畫中畫模式的微軟“電影和電視”應用。 可以調用 "Appli ...
  • C#實現的對兩個Table進行Merge,兩表必須存在至少一個公共欄位作為連接項,否則連接就失去了意義。如下是對兩個table進行Merge的詳細代碼: private void button1_Click(object sender, EventArgs e)//Button點擊觸發事件 { #r ...
  • 在很多時候,我們做一些非常規化的界面的時候,往往需要創建一些用戶控制項,在其中繪製好一些基礎的界面塊,作為後續重覆使用的一個單元,用戶控制項同時也可以封裝處理一些簡單的邏輯。在開發Winform各種類型項目,我都時不時需要定製一些特殊的用戶控制項,以方便在界面模塊中反覆使用。我們一般是在自定義的用戶控制項里... ...
  • 第一部分:面向對象 封裝 繼承(里氏轉換) 多態第二部分:值類型、引用類型、字元串操作第三部分:集合文件操作第四部分:正則表達式第五部分:XML操作第六部分:委托、事件第七部分:反射。 //存儲著我們當前正在運行的進程//Process[] pro = Process.GetProcesses(); ...
  • 程式處理存放圖片的幾種方式 我的理解有4個: 1:放在項目本身得文件夾中,直接部署到伺服器上 2:存放在磁碟中,然後資料庫中存放路徑,讀取得時候傳路徑。這個適合小項目 3:將圖片轉換成二進位文件,但是不建議這樣做,因為會給資料庫造成壓力。 4:存放在雲存儲器上,也是在資料庫上存地址,不過是雲地址,使 ...
  • 什麼是AutoMapper?AutoMapper是一個簡單的小型庫,用於解決一個看似複雜的問題 - 擺脫將一個對象映射到另一個對象的代碼。這種類型的代碼是相當沉悶和無聊的寫,所以為什麼不發明一個工具來為我們做? 我們來看看在.netcore3.1中怎樣使用AutoMapper9.0。 Profile ...
  • Teigha中實體旋轉 代碼: using (var trans = database.TransactionManager.StartTransaction()) { Entity ent = trans.GetObject(entityId, OpenMode.ForWrite) asEntit ...
x