.Net6 中的托管服务

---

前言

在 ASP.NET Core 中，后台任务作为托管服务实现。 托管服务是一个类，具有实现 IHostedService 接口的后台任务逻辑。 (来源自微软官方文档)

---

一、托管服务是什么？

托管服务就相当于在后台程序启动后，除了接受和处理前端发过来的请求之外，独立运行的一段代码。常见的场景：
1、系统启动后，将数据库中的信息加载到Redis中
2、定时备份数据库
当然用托管服务来实现定时任务的话，会比较麻烦，如果是需要定时任务的话，推荐使用HangFire

二、使用步骤

1.创建一个类用来实现托管业务

代码如下：

需要注意的是，在异步方法中需要暂停这个进程时，需要使用await Task.Delay() 而不是sleep()。

namespace HostedServices
{
    public class HostedService1 : BackgroundService
    {   
        /// <summary>
        /// BackgroundService 是用于实现长时间运行的 IHostedService 的基类。
        /// </summary>
        /// <param name="stoppingToken"></param>
        /// <returns></returns>
        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            Console.WriteLine("服务启动了");
            await Task.Delay(3000);
            string text = await File.ReadAllTextAsync("D:/1.txt");
            Console.WriteLine("文件读取完成");
            await Task.Delay(3000);
            Console.WriteLine(text);
        }
        /// <summary>
        /// 在主机执行正常关闭时触发
        /// </summary>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public override Task StopAsync(CancellationToken cancellationToken)
        {
            Console.WriteLine("服务关闭了");
            return base.StopAsync(cancellationToken);
        }

        /// <summary>
        /// 包含用于启动后台任务的逻辑
        /// </summary>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public override Task StartAsync(CancellationToken cancellationToken)
        {
            Console.WriteLine("要准备启动托管服务了");
            return base.StartAsync(cancellationToken);
        }

        /// <summary>
        /// 销毁
        /// </summary>
        public override void Dispose()
        {
            base.Dispose();
        }
    }
}

2.在Program注入HostedService服务

代码如下：

builder.Services.AddHostedService<HostedService1>();

---

3.启动项目，查询执行情况

注意事项：.Net6中 如果在后台托管服务中有任何异常，则整个服务将自动停止运行。在 .Net5 和 Asp.Net Core 3.1 中不会。要用 try catch 包裹整个后台托管代码，已避免出现BUG导致整个项目停止运行。

---

三、在托管服务中注入瞬时生命周期、范围生命周期的解决办法

托管服务是以单例声明周期注入到容器中，所以不能再注入瞬时和范围模式。
解决办法如下：

1.创建一个类并声明为范围生命周期

namespace HostedServices
{
    public class TestScope
    {
        public int Add(int i, int b)
        {
            return i + b;
        }
    }
}

---

2.在Program注入TestScope实体

builder.Services.AddScoped<TestScope>();

---

3.在托管服务中使用范围服务

namespace HostedServices
{
    public class HostedService1 : BackgroundService
    {
        private readonly IServiceScope _Scope;

        public HostedService1(IServiceScopeFactory serviceScopeFactory)
        {
            //创建范围服务
            this._Scope = serviceScopeFactory.CreateScope();
        }



        /// <summary>
        /// BackgroundService 是用于实现长时间运行的 IHostedService 的基类。
        /// </summary>
        /// <param name="stoppingToken"></param>
        /// <returns></returns>
        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            Console.WriteLine("服务启动了");
             
            //调用范围服务
            Console.WriteLine("Scope：" + _Scope.ServiceProvider.GetRequiredService<TestScope>().Add(3, 5));

            await Task.Delay(3000);
            string text = await File.ReadAllTextAsync("D:/1.txt");
            Console.WriteLine("文件读取完成");
            await Task.Delay(3000);
            Console.WriteLine(text);
        }
        /// <summary>
        /// 在主机执行正常关闭时触发
        /// </summary>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public override Task StopAsync(CancellationToken cancellationToken)
        {
            Console.WriteLine("服务关闭了");
            return base.StopAsync(cancellationToken);
        }

        /// <summary>
        /// 包含用于启动后台任务的逻辑
        /// </summary>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public override Task StartAsync(CancellationToken cancellationToken)
        {
            Console.WriteLine("要准备启动托管服务了");
            return base.StartAsync(cancellationToken);
        }

        /// <summary>
        /// 销毁
        /// </summary>
        public override void Dispose()
        {
            base.Dispose();
        }
    }
}

---

4.运行程序查看结果