我要评论前言
在.net 8中，ihostedservice 和 backgroundservice 两个核心接口的引入，增强了项目开发中处理定时任务的能力。这两个接口不仅简化了定时任务、后台处理作业以及定期维护任务的实现过程，还提升了在asp.net core 或任何基于.net的宿主应用程序中的集成与管理效率。
ihostedservice接口提供了一个基本的框架，允许自定义后台服务的启动和停止逻辑。通过实现该接口，可以灵活地控制服务的生命周期，确保任务在应用程序启动时自动运行，并在应用程序关闭时结束。
而 backgroundservice 类则是对 ihostedservice 接口的进一步封装，它专为需要长时间运行的任务而设计。
通过继承 backgroundservice并重写其 executeasync方法，可以轻松地实现复杂的后台逻辑，如循环执行的任务、基于时间间隔的操作等。这种设计模式让代码的可读性和可维护性变的更好。
利用这些功能，可以快速构建出高效、可靠的定时任务系统，用于执行诸如消息推送、数据更新、定时发布等关键业务操作。这些任务可以在不影响应用程序主流程的情况下独立运行，从而提高了整个系统的性能和稳定性。
介绍
.net 中的后台服务允许在后台独立于主应用程序线程运行任务。这对于需要连续或定期运行而不阻塞主应用程序流的任务至关重要。
ihostedservice
ihostedservice 是一个简单的接口，用于实现后台服务。当需要实现自定义的托管服务时，可以通过实现这个接口来创建。
该接口定义了两个方法：startasync(cancellationtoken cancellationtoken) 和 stopasync(cancellationtoken cancellationtoken)，分别用于启动和停止服务。
backgroundservice
backgroundservice 是一个抽象类，它继承自 ihostedservice 并提供了更简洁的方式来编写后台服务。它通常用于需要长时间运行的任务，如监听器、工作队列处理器等。通过重写 executeasync(cancellationtoken stoppingtoken)方法，可以在其中编写任务的逻辑。executeasync方法会循环在后台执行，直到服务停止。
ihostedservice 示例
1、注册服务
program.cs 中添加配置，.net 5 及以下在需要在 startup.cs 注册服务。
// .net 8 using managecore.api; var builder = webapplication.createbuilder(args); builder.services.addcontrollers(); builder.services.addendpointsapiexplorer(); builder.services.addswaggergen(); builder.services.addhostedservice<demohostedservice>(); var app = builder.build();
2、创建服务接口
创建一个类，该类继承 ihostedservice 接口，并实现该接口成员.
在不需要定时执行任务的时候，也可以在这里进行应用启动后的操作，例如创建 rabbitmq 连接
using microsoft.extensions.hosting;
namespace managecore.api
{
public class demohostedservice : ihostedservice, idisposable
{
private timer? _timer;
public task startasync(cancellationtoken cancellationtoken)
{
_timer = new timer(dowork, null, timespan.zero, timespan.fromseconds(5));
return task.completedtask;
}
private void dowork(object? state)
{
console.writeline($"{datetime.now:yyyy-mm-dd hh:mm:ss}");
}
public task stopasync(cancellationtoken cancellationtoken)
{
console.writeline("stopasync");
return task.completedtask;
}
public void dispose()
{
_timer?.dispose();
}
}
}上面的demo代码非常简单，应用在运行后，会去执行 startasync 函数，应用关闭执行 stopasync，由于这里使用的定时器，所以每过5秒都会执行一次 dowork 函数。
3、运行效果
4、ihostedservice 说明
注意：定时是不等待任务执行完成，只要时间一到，就会调用 dowork 函数，所以适合一些简单、特定的场景。
以下为官方文档对 ihostedservice 接口 的说明
ihostedservice 接口为主机托管的对象定义了两种方法：
- startasync(cancellationtoken)
- stopasync(cancellationtoken)
startasync(cancellationtoken) 包含用于启动后台任务的逻辑。 在以下操作之前调用 `startasync`：已配置应用的请求处理管道。已启动服务器且已触发 iapplicationlifetime.applicationstarted。
startasync应仅限于短期任务，因为托管服务是按顺序运行的，在 startasync 运行完成之前不会启动其他服务。
stopasync(cancellationtoken) 在主机执行正常关闭时触发。 stopasync`包含结束后台任务的逻辑。 实现 idisposable 和终结器（析构函数）以处置任何非托管资源。
默认情况下，取消令牌会有五秒超时，以指示关闭进程不再正常。 在令牌上请求取消时：
- 应中止应用正在执行的任何剩余后台操作。
- stopasync 中调用的任何方法都应及时返回。
但是，在请求取消后，将不会放弃任务，调用方会等待所有任务完成。
如果应用意外关闭（例如，应用的进程失败），则可能不会调用 stopasync。 因此，在 stopasync 中执行的任何方法或操作都可能不会发生。
若要延长默认值为 5 秒的关闭超时值，请设置：
- shutdowntimeout（当使用通用主机时）
- 使用 web 主机时为关闭超时值主机配置设置
托管服务在应用启动时激活一次，在应用关闭时正常关闭。 如果在执行后台任务期间引发错误，即使未调用 stopasync，也应调用 dispose。
backgroundservice 示例
1、注册服务
首先，同样需要在配置中注册服务接口。
using managecore.api; var builder = webapplication.createbuilder(args); builder.services.addcontrollers(); builder.services.addendpointsapiexplorer(); builder.services.addswaggergen(); builder.services.addscoped<idemotaskworkservice, demotaskworkservice>();
2、backgroundservice 源码
查看 backgroundservice 的源码，帮助我们理解backgroundservice 实现原理。backgroundservice 是 ihostedservice的一个简单实现，内部 ihostedservice 的 startasync 调用了 executeasync，本质上就是使用了 ihostedservice。
public abstract class backgroundservice : ihostedservice, idisposable
{
private task _executingtask;
private readonly cancellationtokensource _stoppingcts = new cancellationtokensource();
/// <summary>
/// this method is called when the <see cref="ihostedservice"/> starts. the implementation should return a task that represents
/// the lifetime of the long running operation(s) being performed.
/// /// </summary>
/// <param name="stoppingtoken">triggered when <see cref="ihostedservice.stopasync(cancellationtoken)"/> is called.</param>
/// <returns>a <see cref="task"/> that represents the long running operations.</returns>
protected abstract task executeasync(cancellationtoken stoppingtoken);
/// <summary>
/// triggered when the application host is ready to start the service.
/// </summary>
/// <param name="cancellationtoken">indicates that the start process has been aborted.</param>
public virtual task startasync(cancellationtoken cancellationtoken)
{
// store the task we're executing
_executingtask = executeasync(_stoppingcts.token);
// if the task is completed then return it, this will bubble cancellation and failure to the caller
if (_executingtask.iscompleted)
{
return _executingtask;
}
// otherwise it's running
return task.completedtask;
}
/// <summary>
/// triggered when the application host is performing a graceful shutdown.
/// </summary>
/// <param name="cancellationtoken">indicates that the shutdown process should no longer be graceful.</param>
public virtual async task stopasync(cancellationtoken cancellationtoken)
{
// stop called without start
if (_executingtask == null)
{
return;
}
try
{
// signal cancellation to the executing method
_stoppingcts.cancel();
}
finally
{
// wait until the task completes or the stop token triggers
await task.whenany(_executingtask, task.delay(timeout.infinite, cancellationtoken));
}
}
public virtual void dispose()
{
_stoppingcts.cancel();
}
}3、创建服务接口
创建一个服务接口，定义需要实现的任务，以及对应的实现，如果需要执行异步方法，记得加上 await，不然任务将不会等待执行结果，直接进行下一个任务。
namespace managecore.api
{
public interface idemotaskworkservice
{
/// <summary>
/// 测试任务
/// </summary>
/// <param name="stoppingtoken"></param>
/// <returns></returns>
task taskworkasync(cancellationtoken stoppingtoken);
}
}public class demotaskworkservice : idemotaskworkservice
{
/// <summary>
/// 任务执行
/// </summary>
/// <param name="stoppingtoken"></param>
/// <returns></returns>
public async task taskworkasync(cancellationtoken stoppingtoken)
{
while (!stoppingtoken.iscancellationrequested)
{
//执行任务
console.writeline($"{datetime.now}");
//周期性任务，于上次任务执行完成后，等待5秒，执行下一次任务
await task.delay(500);
}
}
}创建后台服务类，继承基类 backgroundservice，这里需要注意的是，要在 backgroundservice 中使用有作用域的服务，请创建作用域， 默认情况下，不会为托管服务创建作用域，得自己管理服务的生命周期，切记！于构造函数中注入 iserviceprovider即可。
namespace managecore.api
{
public class demobackgroundservice : backgroundservice
{
private readonly iserviceprovider _services;
public demobackgroundservice(iserviceprovider services)
{
_services = services;
}
protected override async task executeasync(cancellationtoken stoppingtoken)
{
using var scope = _services.createscope();
var taskworkservice = scope.serviceprovider.getrequiredservice<idemotaskworkservice>();
await taskworkservice.taskworkasync(stoppingtoken);
}
}
}demobackgroundservice类也是需要注册的，注册方式与 ihostedservice 接口的方式一样
builder.services.addhostedservice<demobackgroundservice>();
4、运行效果
5、backgroundservice 说明
backgroundservice 是用于实现长时间运行的 ihostedservice 的基类。
调用 executeasync(cancellationtoken) 来运行后台服务。 实现返回一个 task，其表示后台服务的整个生存期。
在 executeasync 变为异步（例如通过调用 await）之前，不会启动任何其他服务。 避免在 executeasync 中执行长时间的阻塞初始化工作。
stopasync(cancellationtoken) 中的主机块等待完成 executeasync。
调用 ihostedservice.stopasync 时，将触发取消令牌。 当激发取消令牌以便正常关闭服务时，executeasync 的实现应立即完成。 否则，服务将在关闭超时后不正常关闭。
startasync 应仅限于短期任务，因为托管服务是按顺序运行的，在 startasync 运行完成之前不会启动其他服务。
长期任务应放置在 executeasync 中。
ihostedservice 和 backgroundservice 区别
抽象级别
- ihostedservice：需要手动实现启动和停止逻辑。
- backgroundservice：通过提供具有要重写的单个方法的基类来简化实现。
使用案例
- ihostedservice：适用于需要对服务生命周期进行精细控制的更复杂的方案。
- backgroundservice：非常适合受益于减少样板代码的更简单、长时间运行的任务。
总结
总之.net 8 中的 ihostedservice 和 backgroundservice 提供了强大的工具集，使定时任务、后台处理以及定期维护等功能的实现变得更加直接、高效和灵活。无论是构建复杂的企业级应用还是简单的服务应用，这两个组件都能提供稳定且高效的解决方案。
到此这篇关于.net 8 强大功能 ihostedservice 与 backgroundservice 实战的文章就介绍到这了,更多相关.net 8 ihostedservice 与 backgroundservice 内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！
发表评论