在 ASP.NET Core 程式啟動前運行你的代碼

一、前言

在進行 Web 專案開發的程序中，可能會存在一些需要經常訪問的靜態資料，針對這種在程式運行程序中可能幾乎不會發生變化的資料，我們可以嘗試在程式運行前寫入到快取中，這樣在系統后續使用時就可以直接從快取中進行獲取，從而級訓因為頻繁讀取這些靜態資料造成的應用資料庫服務器的巨大承載壓力，

既然需要在程式運行前將靜態資料寫入到快取中，毫無疑問我們需要在程式運行前執行一些自定義功能的代碼，那么在本章中，我將會介紹如何在 ASP.NET Core 專案中，實作在程式啟動前執行某些特定功能的代碼，

二、Step by Step

1、先說結論

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

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>();
            });
}

2、前車之鑒

在嘗試如何在 ASP.NET Core 中實作這一功能需求前，我們可以看看在 .NET Framework 中如何實作這一功能，是不是可以對我們在后續的功能實作中提供某些借鑒，

對于采用 .NET Framework 的應用程式來說，專案創建后會生成一個 Global.asax 檔案，在這個類檔案中存在著 Application_Start 這樣的一個方法，而 Application_Start 這個方法實際上是在當應用程式接收到第一個 HTTP 請求時觸發，也就是說，當系統運行后第一次接收到用戶的請求，就會觸發 Application_Start 中的代碼邏輯，后續不管再接收到多少的請求，都不會再觸發該方法，

例如在這個基于 .NET Framework 構建的 MVC 專案模板中，在程式運行前需要執行注冊路由資訊、注冊過濾器、注冊使用 bundle 壓縮后的 js、css 檔案等等，

但是在 ASP.NET Core 專案中，并沒有原生存在這樣的方法，那么我們如何在 ASP.NET Core 應用中自己動手實作類似的功能呢？

3、后事之師

了解了在之前版本中的實作方式，現在我們仔細看看 Application_Start 這個方法中執行的每行代碼的功能，是不是特別像我們在 ASP.NET Core 專案中使用的各種中間件？

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

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

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

很不幸，這里其實是有個很嚴重的邏輯上的問題的，依賴注入最終的目的是為了實作將我們定義的服務契約與實作進行解耦，實作服務的消費者只需要告訴依賴注入容器自己所需要服務的型別（服務介面 or 抽象服務類），就能自動得到與之匹配的服務實體，

簡單點說就是，消費方要告訴服務提供方你要開始使用某個服務了，我才能給你提供對應的服務，就像我們去飯店吃飯，在點了菜后，沒有必要關心廚師是用天然氣 or 煤氣給你燒的菜，但是能不能上菜的關鍵在于我們有沒有點菜，因此，這個問題最侄訓是落在了我們應該在程式中的什么地方去呼叫我們設定好的方法，

繞了一圈，似乎我們的想法越來越偏，離我們想要實作的越來越遠，既然路偏了，那就直接回到起點吧，拋棄我們在 .NET Framework 專案中的經驗，重新從 ASP.NET Core 專案的啟動流程開始看起，

在 ASP.NET Core 應用的啟動程序中存在著兩個非常重要的物件，對應到我們采用的 ASP.NET Core 3.X 的專案中則是 Host 以及 HostBuilder，這里的 Host 就是承載我們 Web 應用運行的載體，而 HostBuilder 則是用來構建 Host 物件的，

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

因為對于 ASP.NET Core 應用程式來說，本質上其實只是一個控制臺應用，所以現在我們來看看對于一個控制臺應用中最重要的檔案：Program.cs， Program 類中的代碼如下所示，

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 方法中構建 HostBuilder 物件，然后去運行它，達到啟動我們 Web 應用宿主的目的，

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

不知你是否找到了這個類中對于我們最重要的一點，在 Main 方法中，我們是先構建、再去運行，因此，我們是不是可以在構建完成后，先等一等，把我們想要實作的功能先呼叫了，再去運行我們的程式，嗯，讓我們改造下 Main 方法中的代碼，

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>();
            });
}

從上面的圖中可以看到，在我們的 Web 應用的宿主程式還未啟動之前，控制臺就已經列印出了我們自己設定的資訊，之后，才是啟動我們的 Web 應用，這里是請求我們的 API 介面，同時可以發現，在模擬多次請求時，并不會再次觸發我們預設的事件，

三、總結

這一篇文章中并沒有包含代碼，更多的是針對我之前在開發中遇到的一個問題，自己在解決程序中的一個案例說明，希望可以在你以后遇到這類問題時可以提供一些幫助，離 2020 年的農歷新年也沒有幾天了，按目前的進度，估計就是年前的最后一篇博客了，我也要收拾收拾心情，準備過年了，最后，送大家一張表情包，獻給得知你是最后一個放假的童鞋，哈哈哈，提前祝大家新年快樂丫，

四、參考

1. [ASP.NET Core 3框架揭秘] 依賴注入[8]：服務實體的生命周期
2. 200行代碼，7個物件——讓你了解 ASP.NET Core 框架的本質
3. ASP.NET Core 2.0 : 七.一張圖看透啟動背后的秘密
4. ASP.NET Core 3.0 的新增功能

標籤：.NET Core

上一篇：如何利用Serilog的RequestLogging來精簡ASP.NET Core的日志輸出

下一篇：ASP.NET 開源匯入匯出庫Magicodes.IE 匯出Excel教程