深入探究ASP.NET Core Startup初始化

yi念之間發表於2020-11-03

前言

    Startup類相信大家都比較熟悉,在我們使用ASP.NET Core開發過程中經常用到的類,我們通常使用它進行IOC服務註冊,配置中介軟體資訊等。雖然它不是必須的,但是將這些操作統一在Startup中做處理,會在實際開發中帶來許多方便。當我們談起Startup類的時候你有沒有好奇過以下幾點

  • 為何我們自定義的Startup可以正常工作。
  • 我們定義的Startup類中ConfigureServices和Configure只能叫這個名字才能被呼叫到嗎?
  • 在使用泛型主機(IHostBuilder)時Startup的建構函式,為何只支援注入IWebHostEnvironment、IHostEnvironment、IConfiguration。
  • ConfigureServices方法為何只能傳遞IServiceCollection例項。
  • Configure方法的引數為何可以是所有在IServiceCollection註冊服務例項。
  • 在ASP.NET Core結合Autofac使用的時候為何我們新增的ConfigureContainer方法會被呼叫。
    帶著以上幾點疑問,我們將在本篇文章中探索Startup的原始碼,來了解Startup初始化過程到底為我們做了些什麼。

Startup的另類指定方式

在日常編碼過程中,我們通常使用UseStartup的方式來引入Startup類。但是這並不是唯一的方式,還有一種方式是在配置節點中指定Startup所在的程式集來自動查詢Startup類,這個我們可以在GenericWebHostBuilder的建構函式原始碼中的找到相關程式碼[點選檢視原始碼?]相信熟悉ASP.Net Core啟動流程的同學對GenericWebHostBuilder這個類都比較瞭解。ConfigureWebHostDefaults方法中其實呼叫了ConfigureWebHost方法,ConfigureWebHost方法中例項化了GenericWebHostBuilder物件,啟動流程不是我們們的重點,所以這裡只是簡單描述一下。直接找到我們需要的程式碼如下所示

//判斷是否配置了StartupAssembly引數
if (!string.IsNullOrEmpty(webHostOptions.StartupAssembly))
{
    try
    {
        //根據你配置的程式集去查詢Startup
        var startupType = StartupLoader.FindStartupType(webHostOptions.StartupAssembly, webhostContext.HostingEnvironment.EnvironmentName);
        UseStartup(startupType, context, services);
    }
    catch (Exception ex) when (webHostOptions.CaptureStartupErrors)
    {
       //此處省略程式碼省略
    }
}

這裡我們可以看出來,我們需要配置StartupAssembly對應的程式集,它可以通過StartupLoader的FindStartupType方法載入程式集中對應的類。我們還可以看到它還傳遞了EnvironmentName環境變數,至於它起到了什麼作用,我們繼續往下看。
首先我們需要找到webHostOptions.StartupAssembly是如何被初始化的,在WebHostOptions的建構函式中我們找到了StartupAssembly初始化的地方[點選檢視原始碼?]

StartupAssembly = configuration[WebHostDefaults.StartupAssemblyKey];

從這裡也可以看出來它的值來於配置,它的key來自WebHostDefaults.StartupAssemblyKey這個常量值,最後我們找到了的值為

public static readonly string StartupAssemblyKey = "startupAssembly";

也就是說只要我們給startupAssembly配置Startup所在的程式集名稱,它就可以在程式集中查詢Startup類進行初始化,如下所示

public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureHostConfiguration(config=> {
                    List<KeyValuePair<string, string>> keyValuePairs = new List<KeyValuePair<string, string>>();
                    //配置Startup所在的程式集名稱
                    keyValuePairs.Add(new KeyValuePair<string, string>("startupAssembly", "Startup所在的程式集名稱"));
                    config.AddInMemoryCollection(keyValuePairs);
                })
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    //這樣的話這裡就可以省略了
                    //webBuilder.UseStartup<Startup>();
                });

回到上面的思路,我們在StartupLoader類中檢視FindStartupType方法,來看下它是通過什麼規則來查詢Startup的[點選檢視原始碼?]精簡之後的程式碼大致如下

public static Type FindStartupType(string startupAssemblyName, string environmentName)
{
    var assembly = Assembly.Load(new AssemblyName(startupAssemblyName));
    //名稱Startup+環境變數的類比如(StartupDevelopment)
    var startupNameWithEnv = "Startup" + environmentName;
    //名稱為Startup的類
    var startupNameWithoutEnv = "Startup";

    // 先查詢包含名稱Startup+環境變數的相關類,如果找不到則查詢名稱為Startup的類
    var type =
        assembly.GetType(startupNameWithEnv) ??
        assembly.GetType(startupAssemblyName + "." + startupNameWithEnv) ??
        assembly.GetType(startupNameWithoutEnv) ??
        assembly.GetType(startupAssemblyName + "." + startupNameWithoutEnv);

    if (type == null)
    {
        // 如果上述規則找不到,則在程式集定義的所有類中繼續查詢
        var definedTypes = assembly.DefinedTypes.ToList();

        var startupType1 = definedTypes.Where(info => info.Name.Equals(startupNameWithEnv, StringComparison.OrdinalIgnoreCase));
        var startupType2 = definedTypes.Where(info => info.Name.Equals(startupNameWithoutEnv, StringComparison.OrdinalIgnoreCase));

        var typeInfo = startupType1.Concat(startupType2).FirstOrDefault();
        if (typeInfo != null)
        {
            type = typeInfo.AsType();
        }
    }
    //最終返回Startup型別
    return type;
}

通過上述程式碼我們可以看到在通過配置指定程式集時是如何查詢指定規則的Startup類的,基本上可以理解為先去查詢名稱為Startup+環境變數的類,如果找不到則繼續查詢名稱為Startup的類,最終會返回Startup的型別傳遞給UseStartup方法。其實我們最常使用的UseStartup()方法最終也是轉換成UseStartup(typeof(T))的方式,所以最終這兩種方式走到了相同的地方,接下來我們步入正題,來一起探究一下Starup究竟是如何被初始化的。

Startup的建構函式

相信對Startup有所瞭解的同學們都比較清楚,在使用泛型主機(IHostBuilder)時Startup的建構函式只支援注入IWebHostEnvironment、IHostEnvironment、IConfiguration,這個在微軟官方文件中https://docs.microsoft.com/en-us/aspnet/core/fundamentals/startup?view=aspnetcore-3.1#the-startup-class也有介紹,如果還有不熟悉這個操作的請先反思一下自己,然後在查閱微軟官方文件。接下來我們就從原始碼著手,來探究一下它到底是如何做到的。沿著上述的操作,繼續檢視UseStartup裡的程式碼找到了如下的實現[點選檢視原始碼?]

//建立Startup例項
object instance = ActivatorUtilities.CreateInstance(new HostServiceProvider(webHostBuilderContext), startupType);

這裡的startupType就是我們傳遞的Startup型別,關於ActivatorUtilities這個類還是比較實用的,它為我們提供了許多幫助我們例項化物件的方法,在日常程式設計中如果有需要可以使用這個類。上面的ActivatorUtilities的CreateInstance方法的功能就是根據傳遞IServiceProvider型別的物件去例項化指定的型別物件,我們這裡的型別就是startupType。它的使用場景就是,如果某個型別需要用過有參建構函式去例項化,而建構函式的引數可以來自於IServiceProvider的例項,那麼使用這個方法就在合適不過了。上面的程式碼傳遞的IServiceProvider的例項是HostServiceProvider物件,接下來我們找到它的實現原始碼[點選檢視原始碼?]程式碼並不多我們就全部貼上出來

private class HostServiceProvider : IServiceProvider
{
    private readonly WebHostBuilderContext _context;
    public HostServiceProvider(WebHostBuilderContext context)
    {
        _context = context;
    }

    public object GetService(Type serviceType)
    {
        // 通過這裡我們就比較清晰的看出,只有滿足這幾種情況下才能返回具體的例項,其他的都會返回null
        #pragma warning disable CS0618 // Type or member is obsolete
        if (serviceType == typeof(Microsoft.Extensions.Hosting.IHostingEnvironment)
            || serviceType == typeof(Microsoft.AspNetCore.Hosting.IHostingEnvironment)
        #pragma warning restore CS0618 // Type or member is obsolete
            || serviceType == typeof(IWebHostEnvironment)
            || serviceType == typeof(IHostEnvironment)
            )
        {
            return _context.HostingEnvironment;
        }
        if (serviceType == typeof(IConfiguration))
        {
            return _context.Configuration;
        }
        //不滿足這幾種情況的型別都返回null
        return null;
    }
}

通過這個內部私有類我們就能清晰的看到為何Starup的建構函式只能注入IWebHostEnvironment、IHostEnvironment、IConfiguration相關例項了,HostServiceProvider類實現了IServiceProvider的GetService方法並做了判斷,只有滿足這幾種型別才能返回具體的例項注入,其它不滿足條件的型別都會返回null。因此在初始化Starup例項的時候,通過建構函式注入的型別也就只能是這幾種了。最終通過這個建構函式初始化了Startup類的例項。

ConfigureServices的裝載

接下來我們就來在UseStartup方法裡繼續檢視是如何查詢並執行ConfigureServices方法的,繼續檢視找到如下實現[點選檢視原始碼?]

//傳遞startupType和環境變數引數查詢返回ConfigureServicesBuilder
var configureServicesBuilder = StartupLoader.FindConfigureServicesDelegate(startupType, context.HostingEnvironment.EnvironmentName);
//呼叫Build方法返回ConfigureServices委託
var configureServices = configureServicesBuilder.Build(instance);
//傳遞services物件即IServiceCollection物件呼叫ConfigureServices方法
configureServices(services);

從上述程式碼中我們可以瞭解到查詢並執行ConfigureServices方法的具體步驟可分為三步,首先在startupType型別中根據環境變數名稱查詢具體方法返回ConfigureServicesBuilder例項,然後構建ConfigureServicesBuilder例項返回ConfigureServices方法的委託,最後傳遞IServiceCollection物件執行委託方法。接下來我們就來檢視具體實現原始碼。
我們在StartupLoader類中找到了FindConfigureServicesDelegate方法的相關實現[點選檢視原始碼?]

internal static ConfigureServicesBuilder FindConfigureServicesDelegate(Type startupType, string environmentName)
{
    //根據startupType和根據environmentName構建的Configure{0}Services字串先去查詢返回型別為IServiceProvider的方法
    //找不到在查詢返回值為void型別的方法
    var servicesMethod = FindMethod(startupType, "Configure{0}Services", environmentName, typeof(IServiceProvider), required: false)
        ?? FindMethod(startupType, "Configure{0}Services", environmentName, typeof(void), required: false);
    //根據查詢的到的MethodInfo去構建ConfigureServicesBuilder例項
    return new ConfigureServicesBuilder(servicesMethod);
}

通過這裡的原始碼我們可以看到在startupType型別裡去查詢名字為environmentName構建的Configure{0}Services的方法資訊,然後根據查詢的方法資訊即MethodInfo物件去構建ConfigureServicesBuilder例項。接下里我們就來查詢FindMethod方法的實現

private static MethodInfo FindMethod(Type startupType, string methodName, string environmentName, Type returnType = null, bool required = true)
{
    //包含環境變數的ConfigureServices方法名稱比如(ConfigureDevelopmentServices)
    var methodNameWithEnv = string.Format(CultureInfo.InvariantCulture, methodName, environmentName);
    //名為ConfigureServices的方法
    var methodNameWithNoEnv = string.Format(CultureInfo.InvariantCulture, methodName, "");
    //方法是共有的靜態的或非靜態的方法
    var methods = startupType.GetMethods(BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static);
    //查詢包含環境變數的ConfigureServices方法名稱
    var selectedMethods = methods.Where(method => method.Name.Equals(methodNameWithEnv, StringComparison.OrdinalIgnoreCase)).ToList();
    if (selectedMethods.Count > 1)
    {
        //找打多個滿足規則的方法直接丟擲異常
        throw new InvalidOperationException(string.Format("Having multiple overloads of method '{0}' is not supported.", methodNameWithEnv));

    }
    //如果不存在包含環境變數的ConfigureServices的方法比如(ConfigureDevelopmentServices),則直接查詢方法名為ConfigureServices的方法
    if (selectedMethods.Count == 0)
    {
        selectedMethods = methods.Where(method => method.Name.Equals(methodNameWithNoEnv, StringComparison.OrdinalIgnoreCase)).ToList();
        //如果存在多個則同樣丟擲異常
        if (selectedMethods.Count > 1)
        {
            throw new InvalidOperationException(string.Format("Having multiple overloads of method '{0}' is not supported.", methodNameWithNoEnv));
        }
    }

    var methodInfo = selectedMethods.FirstOrDefault();
    //如果沒找到滿足規則的方法,並且滿足required引數,則丟擲未找到方法的異常
    if (methodInfo == null)
    {
        if (required)
        {
            throw new InvalidOperationException(string.Format("A public method named '{0}' or '{1}' could not be found in the '{2}' type.",
                methodNameWithEnv,
                methodNameWithNoEnv,
                startupType.FullName));

        }
        return null;
    }
    //如果找到了名稱一致的方法,但是返回型別和預期的不一致,也丟擲異常
    if (returnType != null && methodInfo.ReturnType != returnType)
    {
        if (required)
        {
            throw new InvalidOperationException(string.Format("The '{0}' method in the type '{1}' must have a return type of '{2}'.",
                methodInfo.Name,
                startupType.FullName,
                returnType.Name));
        }
        return null;
    }
    return methodInfo;
}

通過FindMethod方法我們可以得到幾個結論,首先ConfigureServices方法的名稱可以是包含環境變數的名稱比如(ConfigureDevelopmentServices),其次方法可以為共有的靜態或非靜態方法。FindMethod方法是真正執行查詢的邏輯所在,如果找到相關方法則返回MethodInfo。FindMethod查詢的方法名稱是通過methodName引數傳遞進來的,我們標註的註釋程式碼都是直接寫死了ConfigureServices方法,只是為了便於說明理解,但其實FindMethod是通用方法,接下來我們要講解的內容還會涉及到這個方法,到時候關於這個程式碼的邏輯我們就不會在進行說明了,因為是同一個方法,希望大家能注意到這一點。
通過上面的相關方法,我們瞭解到了是通過什麼樣的規則去查詢到ConfigureServices的方法資訊的,我們也看到了ConfigureServicesBuilder正是通過查詢到的MethodInfo去構造例項的,接下來我們就來檢視下ConfigureServicesBuilder的實現原始碼[點選檢視原始碼?]

internal class ConfigureServicesBuilder
{
    //建構函式傳遞的configureServices的MethodInfo
    public ConfigureServicesBuilder(MethodInfo configureServices)
    {
        MethodInfo = configureServices;
    }

    public MethodInfo MethodInfo { get; }
    public Func<Func<IServiceCollection, IServiceProvider>, Func<IServiceCollection, IServiceProvider>> StartupServiceFilters { get; set; } = f => f;
    //Build委託
    public Func<IServiceCollection, IServiceProvider> Build(object instance) => services => Invoke(instance, services);
    private IServiceProvider Invoke(object instance, IServiceCollection services)
    {
        //執行StartupServiceFilters委託引數為Func<IServiceCollection, IServiceProvider>型別的委託方法即Startup
        //返回了Func<IServiceCollection, IServiceProvider>委託,執行這個委託需傳遞services即IServiceCollections例項返回IServiceProvider型別
        return StartupServiceFilters(Startup)(services);
        IServiceProvider Startup(IServiceCollection serviceCollection) => InvokeCore(instance, serviceCollection);
    }

    private IServiceProvider InvokeCore(object instance, IServiceCollection services)
    {
        if (MethodInfo == null)
        {
            return null;
        }
        // 如果ConfigureServices方法包含多個引數或方法引數型別不是IServiceCollection型別則直接丟擲異常
        // 也就是說ConfigureServices只能包含一個引數且型別為IServiceCollection
        var parameters = MethodInfo.GetParameters();
        if (parameters.Length > 1 ||
            parameters.Any(p => p.ParameterType != typeof(IServiceCollection)))
        {
            throw new InvalidOperationException("The ConfigureServices method must either be parameterless or take only one parameter of type IServiceCollection.");
        }
        //找到ConfigureServices方法的引數,並將services即IServiceCollection的例項傳遞給這個引數
        var arguments = new object[MethodInfo.GetParameters().Length];
        if (parameters.Length > 0)
        {
            arguments[0] = services;
        }
        // 執行返回IServiceProvider例項
        return MethodInfo.InvokeWithoutWrappingExceptions(instance, arguments) as IServiceProvider;
    }
}

看完ConfigureServicesBuilder類的實現邏輯,關於通過什麼樣的邏輯查詢並執行ConfigureServices方法的邏輯就非常清晰了。首先是查詢ConfigureServices方法,即包含環境變數的ConfigureServices方法名稱比如(ConfigureDevelopmentServices)或名為ConfigureServices的方法,返回的是ConfigureServicesBuilder物件。然後執行ConfigureServicesBuilder的Build方法,這個方法裡包含了執行ConfigureServices的規則,即ConfigureServices只能包含一個引數且型別為IServiceCollection,然後將當前程式中存在的IServiceCollection例項傳遞給它。

Configure的裝載

我們常使用Startup的Configure方法去配置中介軟體,預設生成的Configure方法為我們新增了IApplicationBuilder和IWebHostEnvironment例項,但是其實Configure方法不僅僅可以傳遞這兩個引數,它可以通過引數注入在IServiceCollection中註冊的所有服務,究竟是如何實現的呢,接下來我們繼續探究UseStartup方法查詢原始碼檢視想實現
[點選檢視原始碼?],我們抽離出來核心實現如下

//和ConfigureServices查詢方式類似傳遞Startup例項和環境變數
ConfigureBuilder configureBuilder = StartupLoader.FindConfigureDelegate(startupType, context.HostingEnvironment.EnvironmentName);
services.Configure<GenericWebHostServiceOptions>(options =>
{
    //通過檢視GenericWebHostServiceOptions的原始碼可知app其實就是IApplicationBuilder例項
    options.ConfigureApplication = app =>
    {
        startupError?.Throw();
        //執行Startup.Configure,instance為Startup例項
        if (instance != null && configureBuilder != null)
        {  
            //執行Configure方法傳遞Startup例項和IApplicationBuilder例項
            configureBuilder.Build(instance)(app);
        }
    };
});

我們通過檢視GenericWebHostServiceOptions的原始碼可知ConfigureApplication屬性的型別為Action也就是說app引數其實就是IApplicationBuilder介面的例項。通過上面這段程式碼可以看出,主要邏輯就是呼叫StartupLoader的FindConfigureDelegate方法,然後返回ConfigureBuilder建造類,然後構建出Configure方法並執行。首先我們來檢視FindConfigureDelegate的邏輯實現
[點選檢視原始碼?]

internal static ConfigureBuilder FindConfigureDelegate(Type startupType, string environmentName)
{
    //通過startup型別和方法名為Configure或Configure+環境變數名稱的方法
    var configureMethod = FindMethod(startupType, "Configure{0}", environmentName, typeof(void), required: true);
    //用查詢到的方法去初始化ConfigureBuilder
    return new ConfigureBuilder(configureMethod);
}

從這裡我們可以看到FindConfigureDelegate方法也是呼叫的FindMethod方法,只是傳遞的方法名字串為Configure或Configure+環境變數,關於FindMethod的方法實現我們在上面講解ConfigureServices方法的時候已經非常詳細的說過了,這裡就不過多的講解了。總之是通過FindMethod去查詢名為Configure的方法或名為Configure+環境變數的方法比如ConfigureDevelopment查詢規則和ConfigureServices是完全一致的。但是Configure方法卻可以通過引數注入註冊到IServiceCollection中的服務,答案我們同樣要在ConfigureBuilder類中去探尋
[點選檢視原始碼?]

internal class ConfigureBuilder
{
    //建構函式傳遞Configure的MethodInfo
    public ConfigureBuilder(MethodInfo configure)
    {
        MethodInfo = configure;
    }

    public MethodInfo MethodInfo { get; }
    //Build方法返回Action<IApplicationBuilder>委託
    public Action<IApplicationBuilder> Build(object instance) => builder => Invoke(instance, builder);
    //執行邏輯
    private void Invoke(object instance, IApplicationBuilder builder)
    {
        //通過IApplicationBuilder的ApplicationServices獲取IServiceProvider例項建立一個作用域
        using (var scope = builder.ApplicationServices.CreateScope())
        {
            //獲取IServiceProvider例項
            var serviceProvider = scope.ServiceProvider;
            //獲取Configure的所有引數
            var parameterInfos = MethodInfo.GetParameters();
            var parameters = new object[parameterInfos.Length];
            for (var index = 0; index < parameterInfos.Length; index++)
            {
                var parameterInfo = parameterInfos[index];
                //如果方法引數為IApplicationBuilder型別則直接將傳遞過來的IApplicationBuilder賦值給它
                if (parameterInfo.ParameterType == typeof(IApplicationBuilder))
                {
                    parameters[index] = builder;
                }
                else
                {
                    try
                    {
                        //根據方法的引數型別在serviceProvider中獲取具體例項賦值給對應引數
                        parameters[index] = serviceProvider.GetRequiredService(parameterInfo.ParameterType);
                    }
                    catch (Exception ex)
                    {
                        //如果對應的方法引數名稱,沒在serviceProvider中獲取到則直接丟擲異常
                        //變相的說明了Configure方法的引數必須是註冊在IServiceCollection中的
                    }
                }
            }
            MethodInfo.InvokeWithoutWrappingExceptions(instance, parameters);
        }
    }
}

通過ConfigureBuilder類的實現邏輯,可以清晰的看到為何Configure方法引數可以注入任何在IServiceCollection中註冊的服務了。接下來我們總結一下Configure方法的初始化邏輯,首先在Startup中查詢方法名為Configure或Configure+環境變數名稱(比如ConfigureDevelopment)的方法,然後查詢IApplicationBuilder型別的引數,如果找到則將程式中的IApplicationBuilder例項傳遞給它。至於為何Configure方法能夠通過引數注入任何在IServiceCollection中註冊的服務,則是因為迴圈Configure中的所有引數然後在IOC容器中獲取對應例項賦值過來,Configure方法的引數一定得是在IServiceCollection註冊過的型別,否則會丟擲異常。

ConfigureContainer為何會被呼叫

如果你在ASP.NET Core 3.1中使用過Autofac那麼你對ConfigureContainer方法一定不陌生,它和ConfigureServices、Configure方法一樣的神奇,在幾乎沒有任何約束的情況下我們只需要定義ConfigureContainer方法併為方法傳遞一個ContainerBuilder引數,那麼這個方法就能順利的被呼叫了。這一切究竟是如何實現的呢,接下來我們繼續探究原始碼,找到了如下的邏輯
[點選檢視原始碼?]

//根據規則查詢最終返回ConfigureContainerBuilder例項
var configureContainerBuilder = StartupLoader.FindConfigureContainerDelegate(startupType, context.HostingEnvironment.EnvironmentName);
if (configureContainerBuilder.MethodInfo != null)
{
    //獲取容器型別比如如果是autofac則型別為ContainerBuilder
    var containerType = configureContainerBuilder.GetContainerType();
    // 儲存configureContainerBuilder例項
    _builder.Properties[typeof(ConfigureContainerBuilder)] = configureContainerBuilder;
    //構建一個Action<HostBuilderContext,containerType>型別的委託
    var actionType = typeof(Action<,>).MakeGenericType(typeof(HostBuilderContext), containerType);

    // 獲取此型別的私有ConfigureContainer方法,然後宣告該方法的泛型為容器型別,然後建立這個方法的委託
    var configureCallback = GetType().GetMethod(nameof(ConfigureContainer), BindingFlags.NonPublic | BindingFlags.Instance)
                                     .MakeGenericMethod(containerType)
                                     .CreateDelegate(actionType, this);

    // 等同於執行_builder.ConfigureContainer<T>(ConfigureContainer),其中T為容器型別。
    //C onfigureContainer表示一個委託,即我們在Startup中定義的ConfigureContainer委託
    typeof(IHostBuilder).GetMethods().First(m => m.Name == nameof(IHostBuilder.ConfigureContainer))
        .MakeGenericMethod(containerType)
        .InvokeWithoutWrappingExceptions(_builder, new object[] { configureCallback });
}

繼續使用老配方,我們檢視StartupLoader的FindConfigureContainerDelegate方法實現
[點選檢視原始碼?]

internal static ConfigureContainerBuilder FindConfigureContainerDelegate(Type startupType, string environmentName)
{
    //根據startupType和根據environmentName構建的Configure{0}Services字串先去查詢返回型別為IServiceProvider的方法
    var configureMethod = FindMethod(startupType, "Configure{0}Container", environmentName, typeof(void), required: false);
    //用查詢到的方法去初始化ConfigureContainerBuilder
    return new ConfigureContainerBuilder(configureMethod);
}

果然還是這個配方這個味道,廢話不多說直接檢視ConfigureContainerBuilder原始碼
[點選檢視原始碼?]

internal class ConfigureContainerBuilder
{
    public ConfigureContainerBuilder(MethodInfo configureContainerMethod)
    {
        MethodInfo = configureContainerMethod;
    }
    public MethodInfo MethodInfo { get; }
    public Func<Action<object>, Action<object>> ConfigureContainerFilters { get; set; } = f => f;
    public Action<object> Build(object instance) => container => Invoke(instance, container);
    //查詢容器型別,其實就是ConfigureContainer方法的的唯一引數
    public Type GetContainerType()
    {
        var parameters = MethodInfo.GetParameters();
        //ConfigureContainer方法只能包含一個引數
        if (parameters.Length != 1)
        {
            throw new InvalidOperationException($"The {MethodInfo.Name} method must take only one parameter.");
        }
        return parameters[0].ParameterType;
    }

    private void Invoke(object instance, object container)
    {
        ConfigureContainerFilters(StartupConfigureContainer)(container);
        void StartupConfigureContainer(object containerBuilder) => InvokeCore(instance, containerBuilder);
    }
    
    //根據傳遞的container物件執行ConfigureContainer方法邏輯比如使用autofac時ConfigureContainer(ContainerBuilder)
    private void InvokeCore(object instance, object container)
    {
        if (MethodInfo == null)
        {
            return;
        }
        var arguments = new object[1] { container };
        MethodInfo.InvokeWithoutWrappingExceptions(instance, arguments);
    }
}

果不其然千年老方下來還是那個味道,和ConfigureServices、Configure方法思路幾乎一致。這裡需要注意的是GetContainerType獲取的容器型別是ConfigureContainer方法的唯一引數即容器型別,如果傳遞多個引數則直接丟擲異常。其實Startup的ConfigureContainer方法經過花裡胡哨的一番操作之後,最終還是轉換成了雷士如下的操作方式,這個我們在上面程式碼中構建actionType的時候就可以看出,最終通過查詢到的容器型別去完成註冊等相關操作,這裡就不過多的講解了

Host.CreateDefaultBuilder(args)
        .ConfigureContainer<ContainerBuilder>((context,container)=> {
            container.RegisterType<PersonService>().As<IPersonService>().InstancePerLifetimeScope();
        });

總結

    本篇文章我們主要是圍繞著Startup是如何被初始化進行講解的,分別講解了Startup是如何被例項化的,為何Startup的建構函式只能傳遞IWebHostEnvironment、IHostEnvironment、IConfiguration型別的引數,以及ConfigureServices、Configure、ConfigureContainer方法是如何查詢到並被初始化呼叫的。其中雖然涉及到的程式碼比較多,但是整體思路在閱讀原始碼後還是比較清晰的。由於筆者文筆有限,可能許多地方描述的不夠清晰,亦或是本人能力有限理解的不夠透徹,不過本人在文章中都標記了原始碼所在位置的連結,如果有感興趣的同學可以自行點選連線檢視原始碼。Startup類比較常用,如果能夠更深層次的瞭解其原理,對我們實際程式設計過程中會有很大的幫助,同時呼籲更多的小夥伴們深入閱讀了解.NET Core的原始碼並分享出來。如有各位有疑問或者有了解的更透徹的,歡迎評論區提問或批評指導。

?歡迎掃碼關注我的公眾號? 深入探究ASP.NET Core Startup初始化

相關文章