ASP.NET Core 應用程序Startup類介紹

Startup 類

ASP.NET Core應用程序需要一個啓動類,按照慣例命名爲Startup。在主程序的Web Host生成器(WebHostBuilderExtensions)的 UseStartup <TStartup> 擴展方法中指定啓動類名稱。

您可以爲不同的環境定義不同的Startup類,並在運行時選擇適當的Startup類。如果在Web Host配置或選項中指定startupAssembly(啓動程序集),託管將加載該啓動程序集並搜索 Startup 或 Startup[Environment] 類型。根據名稱後綴匹配當前環境的類將被優先使用,所以如果應用程序在開發環境中運行,幷包含一個Startup和一個StartupDevelopment類,他將使用StartupDevelopment類。

通俗的講,ASP.NET Core應用程序啓動的時候將會根據當前的運行環境(生產環境(Production)或者開發環境(Development))自動選擇啓動類。比如在一個ASP.NET Core應用程序中,具有兩個啓動類StartupStartupDevelopment,那麼當我們的啓動環境設置爲開發環境的時候,啓動時將會搜索啓動程序集,優先使用StartupDevelopment這個帶有Development後綴的啓動類。

我們來驗證一下!

建立兩個啓動類StartupStartupDevelopment,我們分別在這兩個類的構造方法中打上標記以便於我們區分使用了哪個啓動類。

Startup:

StartupDevelopment:

然後在Program類中設置啓動程序集名稱

我們通過修改launchSettings.json裏的環境配置來切換環境:

我們可以看到當我們使用開發環境的時候使用的確實是StartupDevelopment啓動類。

我們也可以通過調用UseStartup<TStartup>來定義一個固定的Startup類,該類將被使用而不考慮環境。 這是推薦的方法。

Startup類構造方法可以接受通過依賴注入提供的依賴性。 常用的方法是使用IHostingEnvironment來設置配置源。

Startup類必須包含Configure方法,並可以選擇包含ConfigureServices方法,這兩個方法在應用程序啓動時調用。 該類還可以包含這些方法的特定於環境的版本。 ConfigureServices(如果存在)在Configure之前調用。

Configure方法主要是配置ASP.NET Core的中間件,相當於我們在ASP.NET中所說的管道,ConfigureServices主要是配置依賴注入(DI)。

ConfigureServices 方法

ConfigureServices方法是可選的; 但是如果使用的話,它會在WebHost的Configure方法之前被調用。 WebHost可能會在調用啓動方法之前配置一些服務。 按照慣例,在這個方法中設置配置選項。

對於需要大量設置的功能,在IServiceCollection上添加Add[Service]擴展方法。 下面示例將應用程序配置爲使用Entity Framework,Identity和MVC的服務:

public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));

    services.AddIdentity<ApplicationUser, IdentityRole>()
        .AddEntityFrameworkStores<ApplicationDbContext>()
        .AddDefaultTokenProviders();

    services.AddMvc();

    // Add application services.
    services.AddTransient<IEmailSender, AuthMessageSender>();
    services.AddTransient<ISmsSender, AuthMessageSender>();
}

將服務添加到服務容器使得它們可以通過依賴注入在應用程序中使用(http://www.cnblogs.com/stulzq/p/7761128.html)。

在啓動時可用的服務

ASP.NET Core依賴注入在應用程序啓動期間提供服務。 您可以通過在Startup類的構造方法或其Configure方法中包含適當的接口作爲參數來請求這些服務。 ConfigureServices方法只接受一個IServiceCollection參數(但是可以從這個集合中檢索任何已註冊的服務,所以不需要額外的參數)。

下面是一些通常由啓動方法請求的服務:

  • 在構造方法中:IHostingEnvironment,ILogger<Startup>

  • ConfigureServices方法中:IServiceCollection

  • Configure方法中:IApplicationBuilderIHostingEnvironmentILoggerFactory

Startup類構造方法或其Configure方法可以請求由WebHostBuilder ConfigureServices方法添加的任何服務。 使用WebHostBuilder在啓動方法中提供您需要的任何服務。

Configure 方法

Configure方法用於指定ASP.NET應用程序如何響應HTTP請求。 通過將中間件組件添加到由依賴注入提供的IApplicationBuilder實例來配置請求管道。

從下面的例子中,我們使用了幾個擴展方法來配置支持BrowserLink,error pages, static files, ASP.NET MVC, 和 Identity的管道。

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    loggerFactory.AddConsole(Configuration.GetSection("Logging"));
    loggerFactory.AddDebug();

    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
        app.UseDatabaseErrorPage();
        app.UseBrowserLink();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
    }

    app.UseStaticFiles();

    app.UseIdentity();

    app.UseMvc(routes =>
    {
        routes.MapRoute(
            name: "default",
            template: "{controller=Home}/{action=Index}/{id?}");
    });
}

每個Use擴展方法將一箇中間件組件添加到請求管道。 例如,UseMvc擴展方法將路由中間件添加到請求管道,並將MVC配置爲默認處理程序。

有關如何使用IApplicationBuilder的更多信息,請參閱中間件

額外的服務,如IHostingEnvironmentILoggerFactory也可以在方法簽名中指定,在這種情況下,如果這些服務可用,將被注入。

參考:

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/startup

.NET Core 交流羣:4656606
如果您認爲這篇文章還不錯或者有所收穫,您可以點擊右下角的【推薦】按鈕【精神支持】,因爲這種支持是我繼續寫作,分享的最大動力!
發佈了26 篇原創文章 · 獲贊 2 · 訪問量 2萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章