栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > C/C++/C#

如何在 ASP.Net Core 中使用 IHostedService

C/C++/C# 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

如何在 ASP.Net Core 中使用 IHostedService

在我们应用程序中常常会有一些执行后台任务和任务调度的需求,那如何在 ASP.Net Core 中实现呢? 可以利用 Azure WebJobs 或者其他一些第三方任务调度框架,如:Quartz 和 Hangfire。

在 ASP.Net Core 中,也可以将 后台任务 作为托管服务的模式,所谓的 托管服务 只需要实现框架中的 IHostedService 接口并囊括进你需要的业务逻辑作为后台任务,这篇文章将会讨论如何在 ASP.Net Core 中构建托管服务。

创建托管服务

要想创建托管服务,只需要实现 IHostedService 接口即可,下面就是 IHostedService 接口的声明。


public interface IHostedService
{
    Task StartAsync(CancellationToken cancellationToken);
    Task StopAsync(CancellationToken cancellationToken);
}

这一节中我们在 ASP.Net Core 中做一个极简版的 托管服务, 首先自定义一个 MyFirstHostedService 托管类,代码如下:


    public class MyFirstHostedService : IHostedService
    {
 protected async override Task ExecuteAsync(CancellationToken token)
 {
     throw new NotImplementedException();
 }
    }

创建 BackgroundService

有一点要注意,上一节的 MyFirstHostedService 实现了 IHostedService 接口,实际开发中并不需要这样做,因为 .Net Core 中已经提供了抽象类 BackgroundService,所以接下来重写抽象类的 ExecuteAsync 方法即可,如下代码所示:


    public class MyFirstHostedService : BackgroundService
    {
 protected async override Task ExecuteAsync(CancellationToken token)
 {
     throw new NotImplementedException();
 }
    }

下面的代码片段展示了一个简单的 Log 方法,用于记录当前时间到文件中,这个方法由 托管服务 触发。


 private async Task Log()
 {
     using (StreamWriter sw = new StreamWriter(@"D:log.txt",true))
     {
  await sw.WriteLineAsync(DateTime.Now.ToLongTimeString());
     }
 }

使用 ExecuteAsync 方法

接下来看看如何实现 ExecuteAsync 方法,这个方法的逻辑就是周期性(second/s)的调用 Log() 方法,如下代码所示:


    protected async override Task ExecuteAsync(CancellationToken token)
    {
 while (!token.IsCancellationRequested)
 {
     await Log();
     await Task.Delay(1000, token);
 }
    }

好了,下面是完整的 MyFirstHostedService 类代码,仅供参考。


using Microsoft.Extensions.Hosting;
using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
namespace HostedServicesApp
{
    public class MyFirstHostedService : BackgroundService
    {
 protected async override Task ExecuteAsync(CancellationToken token)
 {
     while (!token.IsCancellationRequested)
     {
  await Log();
  await Task.Delay(1000, token);
     }
 }
 private async Task Log()
 {
     using (StreamWriter sw = new StreamWriter(@"D:log.txt",true))
     {
  await sw.WriteLineAsync(DateTime.Now.ToLongTimeString());
     }
 }
    }  
}

托管服务注册

托管服务类已经写好了,要想注入到 Asp.NET Core 中,需要在 Startup.ConfigureServices 中将 托管服务类 注入到 ServiceCollection 中,如下代码所示:


    public void ConfigureServices(IServiceCollection services)
    {
 services.AddHostedService();
 services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
    } 

当把应用程序跑起来后,你会看见程序每秒都会往 D:log.txt 文件中记录日志。

在 IHostedService 中提供的 StartAsync 和 StopAsync 可用于在 ASP.NET Core 中执行或停止后台任务,你可以用它在你的应用程序中更新数据或其他操作,还有这些周期性业务逻辑是跑在后台线程中的,这样就不会导致主请求线程的阻塞。

**更多高质量干货:参见我的 GitHub: [csharptranslate] github.com/ctripxchuang/csharptranslate **

转载请注明:文章转载自 www.mshxw.com
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号