MVC中使用Hangfire执行定时任务

程序员文章站 2022-07-10 18:05:57

需求描述项目中有一个通知公告的功能，在后台管理员添加公告后需要推送消息给所有注册用户，让其查看消息。消息推送移动端采用极光推送，但是消息在何时发送是个问题，比如说有一个重要的会议通知，可能希望在会议开始前半天进行提醒，仅仅使用后台代码处理起来可能比较麻烦，这时就需要考虑到使用作业来处理这种定时执行... ......

需求描述

项目中有一个通知公告的功能，在后台管理员添加公告后需要推送消息给所有注册用户，让其查看消息。消息推送移动端采用极光推送，但是消息在何时发送是个问题，比如说有一个重要的会议通知，可能希望在会议开始前半天进行提醒，仅仅使用后台代码处理起来可能比较麻烦，这时就需要考虑到使用作业来处理这种定时执行的业务。

在NET平台，作业有很多方式，可以diy一个系统作业，或者使用数据库的作业功能写一个定时执行，再有一种方案就是使用外部开源的定时任务系统来完成。

首先来说，采用系统DIY作业的方式。在不同平台上都有相应的命令来支持这一操作，完成起来也不是很难，但是这样的话应用程序会和系统高耦合，万一想换系统或者换服务器，作业内容直接丢失，再者如果搞不好维护起来也比较麻烦。所以这个pass掉了

再者说数据库，各大数据库也都支持作业功能，sql server 或者mysql等。同样面临的问题第一，不同数据库命令不一致；第二，添加了作业以后在数据库调整，比如数据库服务迁移会导致作业中断；还有一点，数据库作业如果做定时数据更新，数据库备份是比较不错的选择，都在持久层层面，与业务无关。但是如果牵扯到业务，那就有些麻烦了，想象一下，数据库定时执行了一个邮件发送的任务，生成了一条邮件的记录，然后通知IIS相关进程发送邮件，很有些本末倒置的感觉。

前两者其实各有各的使用场景，还是那句话，技术没有好坏，只有适合不适合。针对我们的业务来说，发起于应用内，在应用内部解决是比较好的方案。这样就需要第三个方案，集成一个定时任务的系统进来（或者自己写一个，实话说真没写过不知道有大的工作量）。

NET平台定时任务

net平台开源的定时任务系统也有不少吧，比较知名的有Quartz.net、Hangfire等等。初次使用这些，选择的时候以满足业务的同时简单快速为主，综合看了一下，最后选择Hangfire。一下是摘自园子关于二者区别的部分：

与quartz.net对比

在项目没有引入Hangfire之前，一直使用的是Quartz.net。个人认为Quartz.net在定时任务处理方面优势如下：

支持秒级单位的定时任务处理，但是Hangfire只能支持分钟及以上的定时任务处理

原因在于Hangfire用的是开源的NCrontab组件，跟linux上的crontab指令相似。

更加复杂的触发器，日历以及任务调度处理
可配置的定时任务

但是为什么要换Hangfire? 很大的原因在于项目需要一个后台可监控的应用，不用每次都要从服务器拉取日志查看，在没有ELK的时候相当不方便。Hangfire控制面板不仅提供监控，也可以手动的触发执行定时任务。如果在定时任务处理方面没有很高的要求，比如一定要5s定时执行，Hangfire值得拥有。抛开这些，Hangfire优势太明显了：

持久化保存任务、队列、统计信息
重试机制
多语言支持
支持任务取消
支持按指定Job Queue处理任务
服务器端工作线程可控，即job执行并发数控制
分布式部署，支持高可用
良好的扩展性，如支持IOC、Hangfire Dashboard授权控制、Asp.net Core、持久化存储等

说了这么多的优点，我们可以有个案例，例如秒杀场景：用户下单->订单生成->扣减库存，Hangfire对于这种分布式的应用处理也是适用的，最后会给出实现。

想了解更多参见原文：Hangfire项目实践分享

在MVC中使用Hangfire

下文中开发环境为 Vs 2017，Net Framework 4.5+，数据库为sql server 2008 r2 （要求sql server 2008+）

首先在项目使用nuget引入相关包
项目上右键，管理Nuget程序包→浏览，输入Hangfire,分别安装Hangfire、Hangfire.core、Hangfire.Sqlserver；

在安装hangfire时会关联安装owin,如果不想引入Owin的话可以去掉，在注册服务的时候需要单独处理

右键当前项目，添加OWIN Startup类，在文件中编写代码

如下

//指定使用Sqlserver进行定时任务的持久化
            GlobalConfiguration.Configuration.UseSqlServerStorage("DefaultConnection");
            
            //启用服务
            app.UseHangfireServer();
            
            //启用Dashboard面板
            app.UseHangfireDashboard();

在项目中进入Controller文件夹，在HomeController中添加代码

public ActionResult Index()
        {
            //支持基于队列的任务处理：任务执行不是同步的，而是放到一个持久化队列中，以便马上把请求控制权返回给调用者。
            var jobId = BackgroundJob.Enqueue(() => WriteLog("队列任务"));

            //延迟任务执行：不是马上调用方法，而是设定一个未来时间点再来执行。
            BackgroundJob.Schedule(() => WriteLog("延时任务"), TimeSpan.FromSeconds(10));

            //循环任务执行：一行代码添加重复执行的任务，其内置了常见的时间循环模式，也可基于CRON表达式来设定复杂的模式。
            RecurringJob.AddOrUpdate(() => WriteLog("每分钟执行任务"), Cron.Minutely); //注意最小单位是分钟

            //延续性任务执行：类似于.NET中的Task,可以在第一个任务执行完之后紧接着再次执行另外的任务
            BackgroundJob.ContinueWith(jobId, () => WriteLog("连续任务"));
            return View();
        }

WriteLog方法在控制台输出了一些当前的任务信息，实际业务中可以做很多事情，发邮件提醒、更新数据等等

public void WriteLog(string msg)
        {
            Debug.WriteLine($"Hangfire于{DateTime.Now}执行了任务[{msg}]");
        }

F5运行程序，打开输出视图，看到如下内容
到此为止，Hangfire就已经可以使用了，我们打开数据库

可以看到数据库中增加了不少以HangFire起头的表，这些表就是Hangfire相关持久化生成的表。
回到浏览器，在当前浏览地址后输入/hangfire ，访问以下Hangfire的dashboard页面，看一下任务的执行情况