asp.net后台任务hangfire框架教程

小渣渣 · 发表于 2019-5-24 09:51:10

Hangfire适用于大多数.NET平台：.NET Framework 4.5或更高版本，.NET Core 1.0或更高版本，任何与.NET Standard 1.3兼容的平台。您可以将它与几乎任何应用程序框架集成，包括ASP.NET，ASP.NET Core，控制台应用程序，Windows服务，WCF，以及像Nancy或ServiceStack这样的社区驱动。

适用场景：后台异步发送电子邮件，并尽快向用户返回响应。定时执行任务、循环执行任务、异步执行耗时任务、A任务执行完成再执行B任务、批量执行任务。
我以前的做法方式：

c# 封装了一个万能QueueHelper队列
https://www.itsvse.com/thread-5029-1-1.html
(出处: 架构师_程序员)

您可以将后台处理放在ASP.NET应用程序中，而无需使用其他进程，如Windows服务。Hangfire的代码已准备好在部署过程中意外进程终止，应用程序池回收和重新启动。由于使用了持久存储，因此您不会丢失任何后台作业。

首先，效果图如下：

QQ截图20190523173042.jpg

上图是Hangfire Dashboard仪表盘，非常有用，可以查看后台任务状况，也很炫酷，所以，是必须配置的。

仪表板UI需要启动类，仅当您使用Startup类配置Hangfire时，Dashboard UI才可用。

一开始，我没有配置Hangfire Dashboard仪表盘，会遇到以下错误：

The following errors occurred while attempting to load the app.
- No assembly found containing an OwinStartupAttribute.
- No assembly found containing a Startup or [AssemblyName].Startup class.
To disable OWIN startup discovery, add the appSetting owin:AutomaticAppStartup with a value of "false" in your web.config.
To specify the OWIN startup Assembly, Class, or Method, add the appSetting owin:AppStartup with the fully qualified startup class or configuration method name in your web.config.

解决办法：

当使用基于Global.asax.cs文件的初始化时，您可能还需要禁用OWIN的启动类检测。

登录可见。

我们开始进入正题，教程开始：

1：框架要满足hangfire的需求，我的项目是.net 4.6.2，所以，可以正常安装hangfire，.net 4.0的项目就不用试了，不支持！

2：nuget命令如下：

登录可见。

3：OWIN Startup类旨在将Web应用程序引导逻辑保留在一个位置。在Visual Studio 2013中，您可以通过右键单击项目并选择Add / OWIN Startup Class菜单项来添加它。如下图：

QQ截图20190523171131.jpg

在项目根目录新建一个Startup.cs文件。

4：配置数据库连接字符串，我这里使用的sql server 2012版本，在web.config配置如下：

登录可见。

5：配置Hangfire Dashboard仪表盘访问过滤器，新建HangfireAuthorizationFilter.cs文件。

默认情况下，只允许对Hangfire Dashboard进行本地访问。必须配置仪表板授权才能允许远程访问。

登录可见。

6：配置Startup.cs类，代码如下：

登录可见。

7：启动网站项目

按下调试模式运行应用程序F5（这需要查看Debug.WriteLine方法的输出）。然后在“ 输出”窗口中检查以下消息，以查看后台处理是否已成功启动。

QQ截图20190524093925.jpg

同时，数据库也多了11张表，保证所有的任务都能正常执行，在iis回收或者进程重启下，任务也不会丢失，如下图：

QQ截图20190523170946.jpg

http://<your-web-app>/hangfire

访问Dashboard UI网址，就可以看到文章最上面的效果图了。

附上用法

Fire-And-forget（发布/订阅）

这是一个主要的后台任务类型，持久化消息队列会去处理这个任务。当你创建了一个发布/订阅任务，该任务会被保存到默认队列里面（默认队列是"Default"，但是支持使用多队列）。多个专注的工作者（Worker）会监听这个队列，并且从中获取任务并且完成任务。

登录可见。

延迟

如果想要延迟某些任务的执行，可以是用以下任务。在给定延迟时间后，任务会被排入队列，并且和发布/订阅任务一样执行。

登录可见。

循环

按照周期性（小时，天等）来调用方法，请使用RecurringJob类。在复杂的场景，您可以使用CRON表达式指定计划时间来处理任务。

登录可见。

连续

连续性允许您通过将多个后台任务链接在一起来定义复杂的工作流。

登录可见。

官方文档链接：https://docs.hangfire.io/en/latest/

（完）