在之前的文章《推荐一个简单、轻量、功能非常强大的C#/ASP.NET定时任务执行管理器组件–FluentScheduler》和《简单、轻量、功能非常强大的C#/ASP.NET定时调度任务执行管理组件–FluentScheduler之实例篇》中,我们认识和了解了FluentScheduler这款轻量的定时任务调度执行组件。今天再给大家介绍一款关于定时任务调度执行的组件–Quartz.NET,Quartz.Net是Java版Quartz的.NET实现。
相对FluentScheduler实现定时调度任务的使用简单,配置少的特点,Quartz.Net则配置稍微复杂一些。下面我们就接合一个 ASP.NET MVC网站应用程序的定时执行任务调试的小实例来了解Quartz.Net的简单用法,当然Webform的Web应用也是可以使用Quartz.Net 来作定时任务的。
首先,我们打开Visual Studio 2015,创建一个ASP.NET MVC的Web应用程序项目,命名为QuartzNetMvcDemo:
然后通过程序包管理器控制台来安装Quartz.Net组件:Install-Package Quartz
Quartz.Net一个最简单任务至少包括三部分实现:job(作业),trigger(触发器)以及scheduler(调度器)。其中job 是你需要在一个定时任务中具体执行的业务逻辑,trigger则规定job何时并按照何种规则执行,最终job和trigger会被注册到 scheduler(调度器)中,scheduler负责协调job和trigger的运行。
在Quartz.Net中,一个job(作业)即为一个类,为了让job能在Quartz.Net的体系中执行,我们必须实现Quartz.Net提供的IJob接口的Execute方法,如本例所实现的IJob接口ReportJob类:
using System; using Quartz; using System.IO; namespace QuartzNetMvcDemo { public class ReportJob : IJob { public void Execute(IJobExecutionContext context) { var reportDirectory = string.Format("~/reports/{0}/", DateTime.Now.ToString("yyyy-MM")); reportDirectory = System.Web.Hosting.HostingEnvironment.MapPath(reportDirectory); if (!Directory.Exists(reportDirectory)) { Directory.CreateDirectory(reportDirectory); } var dailyReportFullPath = string.Format("{0}report_{1}.log", reportDirectory, DateTime.Now.Day); var logContent = string.Format("{0}==>>{1}{2}", DateTime.Now, "create new log.", Environment.NewLine); File.AppendAllText(dailyReportFullPath, logContent); } } }
Execute方法有一个IJobExecutionContext的接口对象作为参数,这个参数包含了定义这个类的job(作业)的配置信息。当然,作为示例,在本例中,我们没有使用到这个参数。
接下来,我们需要实现一个trigge(触发器),示例代码如下:
using Quartz; using Quartz.Impl; namespace QuartzNetMvcDemo { public class ReportJobScheduler { public static void Start() { IScheduler scheduler = StdSchedulerFactory.GetDefaultScheduler(); scheduler.Start(); IJobDetail job = JobBuilder.Create<ReportJob>().Build(); ITrigger trigger = TriggerBuilder.Create() .WithIdentity("triggerName", "groupName") .WithSimpleSchedule(t => t.WithIntervalInSeconds(5) .RepeatForever()) .Build(); scheduler.ScheduleJob(job, trigger); } } }
这个代码片段你可以放在你项目程序的任何可以被调用的地方,类名你也可以随意取,这没有什么关系的。只要在使用这个类时正确引用即可。
在代码中,我们使用StdSchedulerFactory.GetDefaultScheduler()创建了一个scheduler(调度器) 并随之 启动了这个调度器,然后创建了一个简单的Quartz.Net触发器并对这个触发器进行了一些配置:指定了触发器的名称为triggerName,触发器 的分组为groupName,指定每5秒触发一次并一直循环触发。最后通过scheduler.ScheduleJob()方法把job(作业)和 trigger(触发器)注册到了调度器中,这样一个完整的定时任务就定制完成了。
最后,我们还要做的一件事情就是启动我们定制好的定时任务,我们把这个任务放到项目程序的全局cs文件(Global.asax)的Application_Start方法中来执行:
1 using System.Web.Mvc; 2 using System.Web.Optimization; 3 using System.Web.Routing; 4 5 namespace QuartzNetMvcDemo 6 { 7 public class MvcApplication : System.Web.HttpApplication 8 { 9 protected void Application_Start() 10 { 11 AreaRegistration.RegisterAllAreas(); 12 FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); 13 RouteConfig.RegisterRoutes(RouteTable.Routes); 14 BundleConfig.RegisterBundles(BundleTable.Bundles); 15 16 //启动定时任务 17 ReportJobScheduler.Start(); 18 } 19 } 20 }
好了,现在所有的操作都已完成,按下F5运行我们的ASP.NET MVC定时任务调度执行示例程序。过一分钟去打开我们的日志文件,如果程序正常运行,那么你将看到如下的日志
怎么样,Quartz.Net实现的定时执行任务调度是不是也比较简单呢?当然,这只是Quartz.Net的简单示例,Quartz.Net还有许多更高级的功能,如支持配置文件的作业调度,支持cron的作业周期等