(16)ASP.NET Core 通用主機(HostBuilder)

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

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 通用主機


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

更多相關文章
  • .NET Core 數據結構與演算法 1 1 本節內容為順序表 簡介 線性表是簡單、基本、常用的數據結構。線性表是線性結構的抽象 (Abstract),線性結構的特點是結構中的數據元素之間存在一對一的線性關係。這 種一對一的關係指的是數據元素之間的位置關係,即: 除第一個位置的數據元素外,其它數據元素 ...
  • RBAC許可權框架(Role-Based Access Control)基於角色的許可權訪問控制的框架,通過用戶-角色-許可權的關聯,非常方便的進行許可權管理,在這裡不再說明什麼是RBAC,請自行百度. 謝謝大家的捧場,如文章中有錯誤或者,請聯繫我或者給我發郵件[email protected],修正後 ...
  • 訪問修飾符 訪問修飾符 C# 中常用的有 private、public、protected、internal 4個訪問修飾符。 private:私有訪問是允許的最低訪問級別,私有成員只有在聲明它們的類和結構中才可以訪問。 public:公共訪問是允許的最高訪問級別,對訪問公共成員沒有限制。 prot ...
  • using System; namespace Application { class JianDanGongChang { static void Main(string[] args) { Factory factory=new Factory(); DianNao diannao=factor... ...
  • 項目中經常會格式化數據,轉換數字的使用情況比較多,記錄一下數字轉換的方法! 如果需要轉換為繁體中文,將數組裡的漢字換成繁體中文即可。 1.阿拉伯數字轉換為中文數字 2.中文數字轉換為阿拉伯數字 ...
一周排行
  • 1. RSA加密與解密 -- 使用公鑰加密、私鑰解密 測試: RSATool myRSA = new RSATool(); Dictionary<string, string> dictK = new Dictionary<string, string>(); dictK = myRSA.GetKe ...
  • 前提 入行已經7,8年了,一直想做一套漂亮點的自定義控制項,於是就有了本系列文章。 GitHub:https://github.com/kwwwvagaa/NetWinformControl 碼雲:https://gitee.com/kwwwvagaa/net_winform_custom_contr ...
  • 1. 在WPF怎麼在UI上添加超級鏈接 這篇文章的目的是介紹怎麼在WPF里創建自定義的HyperlinkButton控制項。很神奇的,WPF居然連HyperlinkButton都沒有,不過它提供了另一種方式用於在UI上添加超級鏈接: 如果需要在超級鏈接里放圖片或其它東西,代碼如下: 這真是很怪,為什麼 ...
  • 系統環境: Windows + .Net Framework 4.0 問題描述: C#連接FTP下載文件時,在部分電腦上有異常報錯,在一部分電腦上是正常的;異常報錯的信息:System.InvalidOperationException: The requested FTP command is n ...
  • 話不多說,上圖: 整體項目結構如圖所示,我的設計初衷是基於.netCore + DI + Vue 打造一個適合初學者的簡捷開發框架。 架構模型採用基於RESTful API風格的前後臺分離框架,總體分為五層:表示層(前端UI)、交互層、業務層、數據訪問層、數據存儲層。 項目中用到的技術如下圖所示: ...
  • 前提 入行已經7,8年了,一直想做一套漂亮點的自定義控制項,於是就有了本系列文章。 GitHub:https://github.com/kwwwvagaa/NetWinformControl 碼雲:https://gitee.com/kwwwvagaa/net_winform_custom_contr ...
  • 初學者經常碰到的,即獲取HTML元素集合,迴圈給元素添加事件。在事件響應函數中(event handler)獲取對應的索引。但每次獲取的都是最後一次迴圈的索引。原因是初學者並未理解JavaScript的閉包特性。 1. <!DOCTYPE HTML> 2. <html> 3. <head> 4. < ...
  • 摘要 本文將介紹如何通過VS2019創建Xamarin.Forms應用程式,以及如何進行調試。 前言 本文介紹Xamarin.Froms應用程式的創建和調試。 開發環境 1.Visual Studio 2019 2.Xamarin.Forms 3.6.0.344457 創建 1.打開VS2019,選 ...
  • 本次應用DevExpress和C#語言製作了一個批量添加水印的程式,看界面效果圖: 界面中既可以進行文字水印添加,也可以圖片水印添加,同時還可以對水印的位置進行設置,比較實用! 文字水印的具體添加情況,看圖: 還可以文字的預覽: 整個文字水印的預覽: 同時圖片的水印預覽: 最後顯示下圖片的水印效果: ...
  • 一、Swagger是什麼 Swagger 是一款RESTFUL介面的、基於YAML、JSON語言的文檔線上自動生成、代碼自動生成的工具。 二、如何在項目中加入Swagger Swagger安裝引用 右鍵Web項目依賴項>管理NuGet程式包>在搜索框輸入"Swashbuckle.AspNetCore ...
x