如何在ASP.NET Core程序啟動前運行代碼

這篇文章主要講解了“如何在ASP.NET Core程序啟動前運行代碼”，文中的講解內(nèi)容簡單清晰，易于學(xué)習(xí)與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學(xué)習(xí)“如何在ASP.NET Core程序啟動前運行代碼”吧！

Step by Step

先說結(jié)論

因為這一篇文章更多的是在說明我在解決這個問題時的一步步思考，并沒有涉及到代碼的編寫，所以下面的內(nèi)容可能對你的幫助并不是很大，所以這里提前將實現(xiàn)的方式告訴大家。對于這個問題來說，只需要將我們想要執(zhí)行的代碼放到下面代碼中注釋所在的位置，即可實現(xiàn)我們的需求。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

public class Program
{
public static void Main(string[] args)
{
        	var host = CreateHostBuilder(args).Build();
        
        	// do what you want
        
        	host.Run();
    	}

    public static IHostBuilder CreateHostBuilder(string[] args) =>
    	Host.CreateDefaultBuilder(args)
    		.ConfigureWebHostDefaults(webBuilder =>
    		{
    			webBuilder.UseStartup<Startup>();
    		});
}

前車之鑒

在嘗試如何在 ASP.NET Core 中實現(xiàn)這一功能需求前，我們可以看看在 .NET Framework 中如何實現(xiàn)這一功能，是不是可以對我們在后續(xù)的功能實現(xiàn)中提供某些借鑒。

對于采用 .NET Framework 的應(yīng)用程序來說，項目創(chuàng)建后會生成一個 Global.asax 文件，在這個類文件中存在著 Application_Start 這樣的一個方法，而 Application_Start 這個方法實際上是在當(dāng)應(yīng)用程序接收到第一個 HTTP 請求時觸發(fā)，也就是說，當(dāng)系統(tǒng)運行后第一次接收到用戶的請求，就會觸發(fā) Application_Start 中的代碼邏輯，后續(xù)不管再接收到多少的請求，都不會再觸發(fā)該方法。

例如在這個基于 .NET Framework 構(gòu)建的 MVC 項目模板中，在程序運行前需要執(zhí)行注冊路由信息、注冊過濾器、注冊使用 bundle 壓縮后的 js、css 文件等等。

但是在 ASP.NET Core 項目中，并沒有原生存在這樣的方法，那么我們?nèi)绾卧?ASP.NET Core 應(yīng)用中自己動手實現(xiàn)類似的功能呢？

后事之師

了解了在之前版本中的實現(xiàn)方式，現(xiàn)在我們仔細看看 Application_Start 這個方法中執(zhí)行的每行代碼的功能，是不是特別像我們在 ASP.NET Core 項目中使用的各種中間件？

然而，如果你有使用過 ASP.NET Core 后就會知道，ASP.NET Core 中的中間件是會在每次請求時都會觸發(fā)的，雖然我們可以在我們自定義的中間件中設(shè)置緩存中不存在數(shù)據(jù)就寫入，存在就直接跳過的代碼邏輯，但是既然除了第一次訪問時才會真正執(zhí)行該中間件的功能，后面完全用不到，因此，對于我這種略微強迫癥的童鞋來說，這個真的不能忍。。。

既然中間件不可以，而我們需要的僅僅是只運行一次，提到 .NET Core，不知道你的第一印象是什么，對于我個人來說，無處不在的依賴注入，可能是我在 18 年開始學(xué)習(xí) .NET Core 時的第一印象。我們知道，對于 .NET Core 中原生的依賴注入組件，存在著三種生命周期：Singleton、Scoped 以及 Transient，對于這三種生命周期的具體解釋，還是推薦博客園里蔣金楠老師的一篇文章（電梯直達）。

對于采用 Singleton 方式注入的服務(wù)來說，因為是一種類似于全局單例的形式，不管后續(xù)從何處進行訪問，都會訪問的是同一個實例，那么，這里是不是就可以在此基礎(chǔ)上實現(xiàn)我們的需求了呢？

很不幸，這里其實是有個很嚴(yán)重的邏輯上的問題的，依賴注入最終的目的是為了實現(xiàn)將我們定義的服務(wù)契約與實現(xiàn)進行解耦，實現(xiàn)服務(wù)的消費者只需要告訴依賴注入容器自己所需要服務(wù)的類型（服務(wù)接口 or 抽象服務(wù)類），就能自動得到與之匹配的服務(wù)實例。

簡單點說就是，消費方要告訴服務(wù)提供方你要開始使用某個服務(wù)了，我才能給你提供對應(yīng)的服務(wù)，就像我們?nèi)ワ埖瓿燥?，在點了菜后，沒有必要關(guān)心廚師是用天然氣 or 煤氣給你燒的菜，但是能不能上菜的關(guān)鍵在于我們有沒有點菜。因此，這個問題最終還是落在了我們應(yīng)該在程序中的什么地方去調(diào)用我們設(shè)定好的方法。

繞了一圈，似乎我們的想法越來越偏，離我們想要實現(xiàn)的越來越遠，既然路偏了，那就直接回到起點吧，拋棄我們在 .NET Framework 項目中的經(jīng)驗，重新從 ASP.NET Core 項目的啟動流程開始看起。

在 ASP.NET Core 應(yīng)用的啟動過程中存在著兩個非常重要的對象，對應(yīng)到我們采用的 ASP.NET Core 3.X 的項目中則是 Host 以及 HostBuilder。這里的 Host 就是承載我們 Web 應(yīng)用運行的載體，而 HostBuilder 則是用來構(gòu)建 Host 對象的。

PS：因為 ASP.NET Core 3.0 開始加入了 對于 gRPC 框架和 Windows Service 的支持，同時為了與其它非 Web 服務(wù)器方案進行集成，因此將原來的 WebHost 和 WebHostBuilder 替換成了新的通用主機（generic-host）配置的模式 。當(dāng)然，在 3.X 版本你還是可以使用 WebHost 和 WebHostBuilder 的，不過當(dāng)然是不推薦的。

因為對于 ASP.NET Core 應(yīng)用程序來說，本質(zhì)上其實只是一個控制臺應(yīng)用，所以現(xiàn)在我們來看看對于一個控制臺應(yīng)用中最重要的文件：Program.cs， Program 類中的代碼如下所示。

1
2
3
4
5
6
7
8
9
10
11
12
13
14

public class Program
{
public static void Main(string[] args)
{
		CreateHostBuilder(args).Build().Run();
	}

public static IHostBuilder CreateHostBuilder(string[] args) =>
		Host.CreateDefaultBuilder(args)
			.ConfigureWebHostDefaults(webBuilder =>
			{
				webBuilder.UseStartup<Startup>();
			});
}

代碼很少，功能也很簡單，簡單來說，在 Main 方法中構(gòu)建 HostBuilder 對象，然后去運行它，達到啟動我們 Web 應(yīng)用宿主的目的。

當(dāng)然，在構(gòu)建 HostBuilder 對象的過程中，會配置 Kestrel 服務(wù)器，會設(shè)置 ContentRoot，會加載配置文件等等一系列的動作，因為自己水平太次，嘗試了一下，還是解釋不好，如果你想要深入了解的話，建議配合博客園里面的這兩篇文章一起食用（200行代碼，7個對象——讓你了解 ASP.NET Core 框架的本質(zhì)、ASP.NET Core 2.0 : 七.一張圖看透啟動背后的秘密）。雖然參考文章中都是基于 ASP.NET Core 2.X 版本進行解釋說明的，但其實最終的差異不是很大。

不知你是否找到了這個類中對于我們最重要的一點，在 Main 方法中，我們是先構(gòu)建、再去運行，因此，我們是不是可以在構(gòu)建完成后，先等一等，把我們想要實現(xiàn)的功能先調(diào)用了，再去運行我們的程序。嗯，讓我們改造下 Main 方法中的代碼。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

public class Program
{
public static void Main(string[] args)
{
    		var host = CreateHostBuilder(args).Build();

        	// Get logger
        	//
        	var logger = host.Services.GetRequiredService<ILogger<Program>>();
        	logger.LogInformation("haha, I ran before web host starting");

        	host.Run();
    	}

    public static IHostBuilder CreateHostBuilder(string[] args) =>
    	Host.CreateDefaultBuilder(args)
    		.ConfigureWebHostDefaults(webBuilder =>
    		{
    			webBuilder.UseStartup<Startup>();
    		});
}

感謝各位的閱讀，以上就是“如何在ASP.NET Core程序啟動前運行代碼”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對如何在ASP.NET Core程序啟動前運行代碼這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關(guān)知識點的文章，歡迎關(guān)注！