ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

  • ASP.NET Core MVC+Quartz实现定时任务可视化管理页面已关闭评论
  • 133 次浏览
  • A+
所属分类:.NET技术
摘要

在前一篇文章,我们了解了如何通过.NET6+Quartz开发基于控制台应用程序的定时任务,今天继续在之前的基础上,进一步讲解基于ASP.NET Core MVC+Quartz实现定时任务的可视化管理页面,仅供学习分享使用,如有不足之处,还请指正。

在前一篇文章,我们了解了如何通过.NET6+Quartz开发基于控制台应用程序的定时任务,今天继续在之前的基础上,进一步讲解基于ASP.NET Core MVC+Quartz实现定时任务的可视化管理页面,仅供学习分享使用,如有不足之处,还请指正。

涉及知识点

  1. Quartz组件,关于Quartz组件的基本介绍,可参考前一篇文章或官网。
  2. GZY.Quartz.MUI,基于Quartz的定时任务维护UI,具有新增,删除,启动,停止等功能,之处DLL和WebAPI接口调用两种模式。

创建ASP.NET Core MVC项目

在Visual Studio 2022中,首先创建基于ASP.NET Core MVC 的项目,根据步骤进行创建即可,如下所示:

ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

 

安装组件

项目创建成功后,通过NuGet包管理器,安装对应组件,本示例仅演示Quartz相关内容,所以只需要安装相关组件即可,如下所示:

ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

 

组件注入

组件安装后,需要在Progrom.cs中进行注入,才可以在启动时加载对应内容。如下所示:

 1 using GZY.Quartz.MUI.Extensions;  2 using QuartzAdmin.QuartzA;  3   4 var builder = WebApplication.CreateBuilder(args);  5 // Add services to the container.  6 builder.Services.AddControllersWithViews();  7 builder.Services.AddControllers();  8 //1. 添加QuartzUI服务  9 builder.Services.AddQuartzUI(); 10 //2. 添加基于DLL模式的Quartz任务支持 11 builder.Services.AddQuartzClassJobs(); 12 var app = builder.Build(); 13  14 // Configure the HTTP request pipeline. 15 if (!app.Environment.IsDevelopment()) 16 { 17     app.UseExceptionHandler("/Home/Error"); 18     // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts. 19     app.UseHsts(); 20 } 21  22 app.UseHttpsRedirection(); 23 app.UseStaticFiles(); 24  25 app.UseRouting(); 26  27 app.UseAuthorization(); 28 //3.使用Quartz组件 29 app.UseQuartz(); 30  31 app.MapControllerRoute( 32     name: "default", 33     pattern: "{controller=Home}/{action=Index}/{id?}"); 34 //在Use中注册单例实例 35 app.Use(async (context, next) => 36 { 37      38      39     if (next != null) 40     { 41         await next.Invoke(); 42     } 43 }); 44 app.Run();

运行测试

在配置好后,运行程序,默认打开的是首页,手动输入网址https://localhost:7172/QuartzUI,即可看到Quartz管理页面,如下所示:

ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

 

 基于DLL的定时任务

在小型项目中,如果为了定时任务,再去创建WebAPI接口,会比较麻烦,所以基于DLL方式的任务更常见,在Quartz框架下,创建基于DLL方式的任务,需要实现IJobService接口,此接口是GZY.Quartz.MUI组件库自带的默认接口,如下所示:

 1 using GZY.Quartz.MUI.BaseService;  2   3 namespace QuartzAdmin.QuartzA.Job  4 {  5     public class TestJob : IJobService  6     {  7         public string ExecuteService(string parameter)  8         {  9             Console.WriteLine($"测试任务被执行了:{parameter}."); 10             return String.Empty; 11         } 12     } 13 }

任务创建成功后,在页面新建任务时,选择DLL方式,会自动识别TestJob,选择即可,如下所示:

ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

 

 基于WebAPI的定时任务

基于WebAPI的定时任务,是所有的WebAPI接口都可以作为调用的任务,无需特殊处理。在ASP.NET Core MVC项目中,默认情况下是支持WebAPI的,首先创建测试WebAPI接口,如下所示:

 1 using Microsoft.AspNetCore.Http;  2 using Microsoft.AspNetCore.Mvc;  3   4 namespace QuartzAdmin.Controllers  5 {  6     [Route("api/[controller]/[action]")]  7     [ApiController]  8     public class TestApiController : ControllerBase  9     { 10         [HttpGet] 11         public void Test(string parameters) 12         { 13             Console.WriteLine($"test web api {parameters},---{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}"); 14         } 15     } 16 }

在任务管理页面,新建任务,任务类型选择API,URL就是WebAPI的接口网址,如下所示:

ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

 

启动与暂停任务

默认情况下,创建的任务是停止状态,选择任务,开启任务即可。如果任务正在运行,也可以暂停任务。或者删除任务。如下所示:

ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

 

 查看任务执行记录

通过点击具体任务右侧的执行记录按钮,可以查看执行日志。如果有执行过程中有错误,也会显示,成功则不显示任何信息,如下所示:

ASP.NET Core MVC+Quartz实现定时任务可视化管理页面

 

好了,以上就是ASP.NET Core MVC+Quartz开发定时任务管理页面的全部内容,旨在抛砖引玉,一起学习,共同进步。