（16）ASP.NET Core 通用主機（HostBuilder）

来源:https://www.cnblogs.com/wzk153/archive/2019/08/12/11340588.html
-Advertisement-
Play Games

1.前言 ASP.NET Core應用程式可以配置和啟動主機（Host）。主機負責應用程式啟動和生命周期管理。通用主機用於無法處理HTTP請求的應用程式。通用主機的用途是將HTTP管道從Web主機API中分離出來，從而啟用更多的主機方案。 基於通用主機的消息、後臺任務和其他非HTTP工作負載可從橫切 ...


1.前言

ASP.NET Core應用程式可以配置和啟動主機（Host）。主機負責應用程式啟動和生命周期管理。通用主機用於無法處理HTTP請求的應用程式。通用主機的用途是將HTTP管道從Web主機API中分離出來，從而啟用更多的主機方案。 基於通用主機的消息、後臺任務和其他非HTTP工作負載可從橫切功能（如配置、依賴關係註入[DI]和日誌記錄）中受益。通用主機是ASP.NET Core 2.1中的新增功能，不適用於Web承載方案。對於Web承載方案，請使用Web主機。通用主機將在未來版本中替換Web主機，併在HTTP和非HTTP方案中充當主要的主機API。

2.介紹

IHostedService是執行代碼的入口點。每個IHostedService實現都按照ConfigureServices中服務註冊的順序執行。主機啟動時，每個IHostedService上都會調用StartAsync，主機正常關閉時，以反向註冊順序調用StopAsync。

3.設置主機

IHostBuilder是供庫和應用程式初始化、生成和運行主機的主要組件：

public static async Task Main(string[] args)
{
    var host = new HostBuilder().Build();
    await host.RunAsync();
}

4.選項

HostOptions配置IHost的選項。

4.1關閉超時值

ShutdownTimeout設置StopAsync的超時值。預設值為5秒。Program.Main中的以下選項配置將預設值為5秒的關閉超時值增加至20秒：

var host = new HostBuilder().ConfigureServices((hostContext, services) =>
    {
        services.Configure<HostOptions>(option =>
        {
            option.ShutdownTimeout = System.TimeSpan.FromSeconds(20);
        });
    })
    .Build();

5.預設服務

在主機初始化期間註冊以下服務：
●環境 (IHostingEnvironment)
●HostBuilderContext
●配置 (IConfiguration)
●IApplicationLifetime (ApplicationLifetime)
●IHostLifetime (ConsoleLifetime)
●IHost
●選項 (AddOptions)
●日誌記錄 (AddLogging)

6.主機配置

主機配置的創建方式如下：
●調用IHostBuilder上的擴展方法以設置“內容根”和“環境”。
●從ConfigureHostConfiguration中的配置提供應用程式讀取配置。
●應用程式鍵（名稱）、內容根、環境配置方式我就不多說了，跟上一篇Web主機配置是一樣的。

6.1ConfigureHostConfiguration

ConfigureHostConfiguration使用IConfigurationBuilder來為主機創建IConfiguration。主機配置用於初始化IHostingEnvironment，以供在應用程式的構建過程中使用。可多次調用ConfigureHostConfiguration，並得到累計結果。必須在ConfigureHostConfiguration中顯式指定應用程式所需的任何配置提供自身，包括：
●文件配置（例如，來自hostsettings.json文件）。
●環境變數配置。
●命令行參數配置。
●任何其他所需的配置提供程式。
通過使用SetBasePath指定應用程式的基本路徑，然後調用其中一個文件配置提供應用程式，可以啟用主機的文件配置。示例應用使用JSON文件hostsettings.json，並調用AddJsonFile來使用文件的主機配置設置。要添加主機的環境變數配置，請在主機生成器上調用 AddEnvironmentVariables。AddEnvironmentVariables接受用戶定義的首碼（可選）。示例應用程式使用首碼PREFIX_。當系統讀取環境變數時，便會刪除首碼。配置示例應用程式的主機後，PREFIX_ENVIRONMENT的環境變數值就變成environment密鑰的主機配置值。示例HostBuilder配置使用ConfigureHostConfiguration：

var host = new HostBuilder().ConfigureHostConfiguration(configHost =>
    {
        configHost.SetBasePath(Directory.GetCurrentDirectory());
        configHost.AddJsonFile("hostsettings.json", optional: true);
        configHost.AddEnvironmentVariables(prefix: "PREFIX_");
        configHost.AddCommandLine(args);
    })

6.2ConfigureAppConfiguration

通過在IHostBuilder實現上調用ConfigureAppConfiguration創建應用程式配置。ConfigureAppConfiguration使用IConfigurationBuilder來為應用程式創建IConfiguration。可多次調用ConfigureAppConfiguration，並得到累計結果。應用程式使用上一次在一個給定鍵上設置值的選項。HostBuilderContext.Configuration中提供ConfigureAppConfiguration創建的配置，以供進行後續操作和在Services中使用。應用程式配置會自動接收ConfigureHostConfiguration提供的主機配置。示例應用配置使用ConfigureAppConfiguration：

var host = new HostBuilder().ConfigureAppConfiguration((hostContext, configApp) =>
    {
        configApp.SetBasePath(Directory.GetCurrentDirectory());
        configApp.AddJsonFile("appsettings.json", optional: true);
        configApp.AddJsonFile(
            $"appsettings.{hostContext.HostingEnvironment.EnvironmentName}.json",
            optional: true);
        configApp.AddEnvironmentVariables(prefix: "PREFIX_");
        configApp.AddCommandLine(args);
    })

6.3ConfigureServices

ConfigureServices將服務添加到應用程式的依賴關係註入容器。可多次調用ConfigureServices，並得到累計結果。托管服務是一個類，具有實現IHostedService介面的後臺任務邏輯。示例應用程式使用AddHostedService擴展方法向自身添加生命周期事件 LifetimeEventsHostedService和定時後臺任務TimedHostedService服務：

var host = new HostBuilder()
    .ConfigureServices((hostContext, services) =>
    {
        if (hostContext.HostingEnvironment.IsDevelopment())
        {
            // Development service configuration
        }
        else
        {
            // Non-development service configuration
        }
        services.AddHostedService<LifetimeEventsHostedService>();
        services.AddHostedService<TimedHostedService>();
})

6.4ConfigureLogging

ConfigureLogging添加了一個委托來配置提供的ILoggingBuilder。可以利用相加結果多次調用 ConfigureLogging。

var host = new HostBuilder().ConfigureLogging((hostContext, configLogging) =>
    {
        configLogging.AddConsole();
        configLogging.AddDebug();
    })
6.4.1UseConsoleLifetime

UseConsoleLifetime偵聽Ctrl+C/SIGINT或SIGTERM並調用StopApplication來啟動關閉進程。UseConsoleLifetime解除阻止RunAsync和WaitForShutdownAsync等擴展。ConsoleLifetime預註冊為預設生命周期實現，使用註冊的最後一個生命周期。

var host = new HostBuilder().UseConsoleLifetime()

7.容器配置

主機可以接受IServiceProviderFactory<TContainerBuilder>。提供工廠不屬於DI容器註冊，而是用於創建具體DI容器的主機內部函數。UseServiceProviderFactory(IServiceProviderFactory<TContainerBuilder>)重寫用於創建應用程式的服務提供程式的預設工廠。ConfigureContainer方法托管自定義容器配置。ConfigureContainer提供在基礎主機API的基礎之上配置容器的強類型體驗。可以利用相加結果多次調用ConfigureContainer。

為應用程式創建服務容器並提供服務容器工廠：

public class GenericHostSample
{
    internal class ServiceContainerFactory : IServiceProviderFactory<ServiceContainer>
    {
        public ServiceContainer CreateBuilder(IServiceCollection services)
        {
            return new ServiceContainer();
        }
        public IServiceProvider CreateServiceProvider(ServiceContainer containerBuilder)
        {
            throw new NotImplementedException();
        }
    }
}

使用該工廠併為應用程式配置自定義服務容器：

var host = new HostBuilder().UseServiceProviderFactory<ServiceContainer>(new ServiceContainerFactory())
    .ConfigureContainer<ServiceContainer>((hostContext, container) =>{
})

8.擴展性

在IHostBuilder上使用擴展方法實現主機擴展性。應用程式建立UseHostedService擴展方法，以註冊在T中傳遞的托管服務：

public static class Extensions
{
    public static IHostBuilder UseHostedService<T>(this IHostBuilder hostBuilder)
        where T : class, IHostedService, IDisposable
    {
        return hostBuilder.ConfigureServices(services =>
            services.AddHostedService<T>());
    }
}

9.管理主機

IHost實現負責啟動和停止由服務容器中註冊的IHostedService實現。

9.1Run

Run運行應用程式並阻止調用線程，直到關閉主機：

public class Program
{
    public void Main(string[] args)
    {
        var host = new HostBuilder().Build();
        host.Run();
    }
}

9.2RunAsync

RunAsync運行應用程式並返回在觸發取消令牌或關閉時完成的Task：

public class Program
{
    public static async Task Main(string[] args)
    {
        var host = new HostBuilder().Build();
        await host.RunAsync();
    }
}

9.3RunConsoleAsync

RunConsoleAsync啟用控制台、生成和啟動主機，以及等待Ctrl+C/SIGINT或SIGTERM關閉。

public class Program
{
    public static async Task Main(string[] args)
    {
        var hostBuilder = new HostBuilder();
        await hostBuilder.RunConsoleAsync();
    }
}

9.4Start和StopAsync

Start同步啟動主機。StopAsync嘗試在提供的超時時間內停止主機。

public class Program
{
    public static async Task Main(string[] args)
    {
        var host = new HostBuilder().Build();
        using (host)
        {
            host.Start();
            await host.StopAsync(TimeSpan.FromSeconds(5));
        }
    }
}

9.5StartAsync和StopAsync

StartAsync啟動應用程式。StopAsync停止應用程式。

public class Program
{
    public static async Task Main(string[] args)
    {
        var host = new HostBuilder().Build();
        using (host)
        {
            await host.StartAsync();
            await host.StopAsync();
        }
    }
}

9.6WaitForShutdown

WaitForShutdown通過IHostLifetime觸發，例如ConsoleLifetime（偵聽Ctrl+C/SIGINT或SIGTERM）。WaitForShutdown調用StopAsync。

public class Program
{
    public void Main(string[] args)
    {
        var host = new HostBuilder().Build();
        using (host)
        {
            host.Start();
            host.WaitForShutdown();
        }
    }
}

9.7WaitForShutdownAsync

WaitForShutdownAsync返回在通過給定的令牌和調用StopAsync來觸發關閉時完成的Task。

public class Program
{
    public static async Task Main(string[] args)
    {
        var host = new HostBuilder().Build();
        using (host)
        {
            await host.StartAsync();
            await host.WaitForShutdownAsync();
        }
    }
}

9.8External control（外部控制項）

public class Program
{
    private IHost _host;
    public Program()
    {
        _host = new HostBuilder()
            .Build();
    }
    public async Task StartAsync()
    {
        _host.StartAsync();
    }
    public async Task StopAsync()
    {
        using (_host)
        {
            await _host.StopAsync(TimeSpan.FromSeconds(5));
        }
    }
}

在StartAsync開始時調用WaitForStartAsync，在繼續之前，會一直等待該操作完成。它可用於延遲啟動，直到外部事件發出信號。

10.IHostingEnvironment、IApplicationLifetime介面

該兩個介面類型跟上一篇Web主機IHostingEnvironment、IApplicationLifetime介面類型是一樣的，詳情就不在這多講了，想要瞭解的請移步到上一篇Web主機文章。

參考文獻：
ASP.NET Core 通用主機


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

-Advertisement-
Play Games
更多相關文章
  • python day2-爬蟲實現github登錄
    GitHub登錄 分析登錄頁面 開發者工具分析請求 從session請求分析得知： 1.請求的URL為：https://github.com/session 2.該請求為post請求，即需要上傳data表單，所以我們需要分析form-data 由form-data分析得知： 1.login：GitH ...
  • 伺服器免密碼登錄
    伺服器數量過多，每次採用ip+埠 輸入密碼的方式登錄比較繁瑣，就採用了免密碼和埠登錄。 普通登錄方式： ssh p 27479 [email protected] 更換免密碼登錄： 本地操作： 本地的公鑰位置： ~/.ssh/id_rsa.pub ~/.ssh目錄下創建一個config文件， ...
  • [Spring cloud 一步步實現廣告系統] 17. 根據流量類型查詢廣告
    廣告檢索服務 功能介紹 媒體方（手機APP打開的展示廣告，走在路上看到的大屏幕廣告等等） 請求數據對象實現 從上圖我們可以看出，在媒體方向我們的廣告檢索系統發起請求的時候，請求中會有很多的請求參數信息，他們分為了三個部分，我們來編碼封裝這幾個參數對象信息以及我們請求本身的信息。Let's code. ...
  • 小白之旅30-1
    Filter 過濾器 概念：當訪問伺服器的某些資源時，過濾器可以將請求先進行攔截，在完成了一定的特殊功能後，可以讓此請求繼續執行。 一. 實現步驟 1、實現Filter介面 2、重寫方法 3、配置web.xml 二. 過濾器的url配置 完全匹配：攔截指定資源 擴展名匹配： .擴展名，攔截指定尾碼的 ...
  • 線程和偏向鎖、輕量級鎖、重量級鎖的知識整理
    xl_echo編輯整理，歡迎轉載，轉載請聲明文章來源。歡迎添加echo微信(微信號：t2421499075)交流學習。 百戰不敗，依不自稱常勝，百敗不頹，依能奮力前行。——這才是真正的堪稱強大！！ 參考文章列表： "Java併發編程：Synchronized底層優化（偏向鎖、輕量級鎖）" "輕量級鎖 ...
  • asp.net core EF code first
    以連接mysql資料庫為例 一 安裝組件 Microsoft.EntityFrameworkCore Microsoft.EntityFrameworkCore.Relational Microsoft.EntityFrameworkCore.Tools MySqlConnector Pomelo. ...
  • 工作流設計過程
    1.業務場景：用戶登錄，收到消息通知，審批業務，根據配置的流程繼續流轉，最終審核發送回給申請人(終審同意結束，終審不同意申請人可以繼續修改提交)。 2.思路過程： 3..資料庫設計： 4.代碼過程： ...
  • abp(net core)+easyui+efcore實現倉儲管理系統——使用 WEBAPI實現CURD (十三)
    上接(abp(net core)+easyui+efcore實現倉儲管理系統——使用 WEBAPI實現CURD (十二))，在這一篇文章中我們創建視圖模型、列表視圖、添加菜單。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類