Asp.net Core 2.1新功能Generic Host(通用主机)，了解一下

时间  2019-12-08
标签 asp.net asp core 2.1 功能 generic host 通用 主机 了解 一下 栏目 ASP 繁體版
原文   原文链接

什么是Generic Host ?

image

 

这是在Asp.Net Core 2.1加入了一种新的Host，如今2.1版本的Asp.Net Core中，有了两种可用的Host。git

  • Web Host –适用于托管Web程序的Host,就是咱们所熟悉的在Asp.Net Core应用程序的Mai函数中用CreateWebHostBuilder建立出来的经常使用的WebHost。

clip_image001

  • Generic Host (ASP.NET Core 2.1版本才有) – 适用于托管非 Web 应用（例如，运行后台任务的应用）。 在将来的版本中，通用主机将适用于托管任何类型的应用，包括 Web 应用。 通用主机最终将取代 Web 主机，这大概也是这种类型的主机叫作通用主机的缘由，在本博客中，咱们将结合源码，讨论通用主机的工做原理。

为何要用通用主机？

通用主机，让我能够用编写Asp.Net Core的思想（例如控制反转、依赖注入、IOC容器）来简化控制台应用程序的建立（我的看法），主机负责程序的启动和生存周期的管理，这对于不处理HTTP请求的应用程序很是有用（处理HTTP请求的是Web应用程序，用Web Host托管），通用主机的目标是将HTTP管道从Web Host中脱离出来，使得Asp.Net Core的那套东西也适用于其余.Net Core程序。github

Demo下载

在开始跟随我分析通用主机以前，你们能够到Github下载这个官方Demo。web

https://github.com/aspnet/Docs/tree/master/aspnetcore/fundamentals/host/generic-host/samples/json

若是以为下载一整个比较慢，能够从个人这个Github仓库下载，没有其余多余内容，国内Github比较慢，若是你从官方那个仓库下载可能会须要很长时间甚至失败。app

https://github.com/liuzhenyulive/Generic-Host-Demoasync

 

Generic Host 和Web Host 对比

首先，你们打开下载下来的这个官方Demo,进入Main函数。函数

image

能够看到，这简直就是一个精简版的Asp.Net Core应用程序，对这个Main函数中出现的全部方法，你们对Asp.Net Core Web应用程序比较熟悉，因此我与Asp.net core 的Webhost作了一个对比，来帮助你们找找感受。源码分析

通用主机 Web主机
new HostBuilder() WebHost.CreateDefaultBuilder(args)
ConfigureAppConfiguration
(用于配置Configuration)		 WebHost也有这个方法，只是你们默承认能没有调用。
image
ConfigureServices
(用于配置Service，也就是依赖注入)		 WebHost其实也有ConfigureServices方法，能够这么调用。
image
可是咱们通常不多这么用，通常都是放在Startup的ConfigureServices方法中进行依赖注入。
ConfigureLogging
(是本应用程序所须要的配置，非必需）		 WebHost仍是有！
image
builder.RunConsoleAsync()
image
RunConsoleAsync中实际上是对hostbuilder进行
Builder而后Run		 CreateWebHostBuilder(args).Build().Run();

也就是Main函数中的Build().Run();

无无无无
 Startup中的Configure()方法
Asp.net core在此方法中进行Http请求管道的配置

 

综上对比，我作了以下归纳！ui

  1. 通用主机（Generic Host）有的 Web Host都有。
  2. Web Host的Http Pipeline即Startup.Configure() 在通用主机中没有。

这就应证了开头所说的：通用主机的目标是将HTTP管道从Web Host中脱离出来，使得Asp.Net Core的那套东西也适用于其余.Net Core程序。this

如何使用？

Run函数解读

我以为要知道怎么用，那么咱们就首先要知道Host的Run方法内究竟是在执行什么？

因此咱们深刻源码，一路F12!

builder.RunConsoleAsync(); =>hostBuilder.UseConsoleLifetime().Build().RunAsync(cancellationToken);=> await host.StartAsync(token);

总算找到了，最关键的在这里。

public async Task StartAsync(CancellationToken cancellationToken = default (CancellationToken))
    {
      this._logger.Starting();
      TaskCompletionSource<object> completionSource1 = new TaskCompletionSource<object>();

      ref CancellationToken local = ref cancellationToken;
      TaskCompletionSource<object> completionSource2 = completionSource1;
      local.Register((Action<object>) (obj => ((TaskCompletionSource<object>) obj).TrySetCanceled()), (object) completionSource2);

      IHostLifetime hostLifetime1 = this._hostLifetime;
      TaskCompletionSource<object> completionSource3 = completionSource1;
      hostLifetime1.RegisterDelayStartCallback((Action<object>) (obj => ((TaskCompletionSource<object>) obj).TrySetResult((object) null)), (object) completionSource3);

      IHostLifetime hostLifetime2 = this._hostLifetime;
      ApplicationLifetime applicationLifetime = this._applicationLifetime;
      hostLifetime2.RegisterStopCallback((Action<object>) (obj => (obj as IApplicationLifetime)?.StopApplication()), (object) applicationLifetime);

      object task = await completionSource1.Task;
this._hostedServices = this.Services.GetService<IEnumerable<IHostedService>> (); foreach (IHostedService hostedService in this ._hostedServices) await hostedService.StartAsync(cancellationToken).ConfigureAwait(false 
);

      this._applicationLifetime?.NotifyStarted();
      this._logger.Started();
    }

 

知道你们都喜欢Yellow色，因此我用Yellow把最关键的代码标示出来了，那么这些代码有什么含义呢？

this._hostedServices = this.Services.GetService<IEnumerable<IHostedService>>();

这一行的意思是，从容器中取出全部实现了IHostedService的服务。

这就意味着，咱们实现了IHostedService后，须要把该Service注册到IOC容器中。

foreach (IHostedService hostedService in this._hostedServices)
      await hostedService.StartAsync(cancellationToken).ConfigureAwait(false);

执行每一个服务的StartAsync方法。

因此，你们是否是冥冥中猜到了怎么用的呢？大声笑

我总结的步骤以下：

  1. 自定义一个Service,继承 IHostedService接口。
  2. 实现 IHostedService的StartAsync方法，把须要执行的任务放到这个方法中。
  3. 把该服务注册到IOC容器（ServiceCollection）中。

自定义任务的运行

对于步骤1和2,对应的代码以下：

public class PrintTextToConsoleService : IHostedService, IDisposable
    {
        private readonly ILogger _logger;
        private readonly IOptions<AppConfig> _appConfig;
        private Timer _timer;

        public PrintTextToConsoleService(ILogger<PrintTextToConsoleService> logger, IOptions<AppConfig> appConfig)
        {
            _logger = logger;
            _appConfig = appConfig;
        }

        public Task StartAsync(CancellationToken cancellationToken)
        {
            _logger.LogInformation("Starting");

            _timer = new Timer(DoWork, null, TimeSpan.Zero,
                TimeSpan.FromSeconds(5));

            return Task.CompletedTask;
        }

        private void DoWork(object state)
        {
            _logger.LogInformation($"Background work with text: {_appConfig.Value.TextToPrint}");
        }

        public Task StopAsync(CancellationToken cancellationToken)
        {
            _logger.LogInformation("Stopping.");

            _timer?.Change(Timeout.Infinite, 0);

            return Task.CompletedTask;
        }

        public void Dispose()
        {
            _timer?.Dispose();
        }
    }

能够看到，在StartAsync中，定义了一个定时任务，带定时任务每五秒执行一次DoWork方法。

在DoWork方法中，日志记录器记录了一段内容。

由于在Main方法中，对Log进行了以下的配置。

image

因此，一旦日志记录了内容，该内容就会在控制台中输出。

对于步骤3,对应的代码以下

public static async Task Main(string[] args)
        {
            var builder = new HostBuilder()    //实例化一个通用主机
                .ConfigureAppConfiguration((hostingContext, config) =>
                {
                    config.AddJsonFile("appsettings.json", optional: true);
                    config.AddEnvironmentVariables();

                    if (args != null)
                    {
                        config.AddCommandLine(args);
                    }
                }) //配置Configuration
                .ConfigureServices((hostContext, services) =>
                {
                    services.AddOptions();
                    services.Configure<AppConfig>(hostContext.Configuration.GetSection("AppConfig"));
                    services.AddSingleton
<IHostedService, PrintTextToConsoleService> 
();
                })    //配置Service （依赖注入）
                .ConfigureLogging((hostingContext, logging) => {
                    logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
                    logging.AddConsole();
                });   //配置Log （本项目中要利用Log把内容在控制台输出）

            await builder.RunConsoleAsync();    //在控制台应用程序中运行通用主机
        }

黄色部分，把实现了IHostedService接口的PrintTextToConsoleService注册到容器中。

 

F5 运行

image

能够看到，控制台中，每五秒就有一次内容输出，说明DoWork方法没五秒被执行了一次，也说明PrintTextToConsoleService的StartAsync被成功调用了。

 

但愿本文对帮助你们理解通用主机可以有所帮助，若是对.Net Core的源码分析、潮流新技术感兴趣

欢迎关注我

不按期推出实用干活，谢谢！

参考文献

https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/host/generic-host?view=aspnetcore-2.1

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程