MVC 使用Quartz.Net组件实现定时计划任务
最近，项目中需要执行一个计划任务，组长就让我了解一下Quartz.net 这个组件，挺简单的一个组件，实现起来特别的方便，灵活，值得推荐给大家一起学习一下这个小工具。以前我有的时候是使用定时器Timer，还有数据库中的 计划任务，后来发现这些真的太不好用了。下面我介绍一下这个组件的使用步骤和注意事项，仅供参考，有什么不对的地方，希望大家多多见谅并帮我指出来，大家 相互学习嘛。
首先，简述一下Quartz.net 组件的基本概念：它是一个简单的执行任务计划的组件，基本包括这三部分：Job(作业)、Trigger(触发器)、scheduler(调度器)。
1.Job 作业：需要在任务计划中执行的具体逻辑操作
2.Trigger 触发器：需要什么时间什么规则来去执行Job 作业
3.scheduler 调度器 ：将Job 和 Trigger 注册到 scheduler 调度器中，主要负责协调Job、Trigger 的运行
第一步：下载Quartz.net 组件
在VS 中 工具 > NuGet 程序包管理器 > 程序包管理控制台 点击打开 在控制台上输入 Install-Package Quartz 就可以成功下载下来了，详见如图所示：
第二步：在VS 中我们创建一个类库，这样方便我们移植程序，也方便我们代码的分离；一个Job 创建一个实例类，下面我会创建两个实例类一个是UpdateCompleteJob.cs、UpdateAutoCancelStateJob.cs (之所以创建两个Job是为了能方便大家了解这个组件可以同时执行多个任务)
(1) UpdateCompleteJob.cs 代码如下：
using Quartz; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using WechatMall.Application.BLL; using WechatMall.Application.Data; using WechatMall.Model.ExpressModel; namespace WechatMallJobLibrary { public class UpdateCompleteJob : IJob { /// <summary> ///在Job 中我们必须实现IJob接口中的Execute 这个方法，才能正确的使用Job /// </summary> public void Execute(IJobExecutionContext context) { using (var _ctx = new BtDbContext()) { List<string> expressCode = new List<string>(); var query = _ctx.Orders.Where(c => c.OrderStatus == WechatMall.Common.EnumHelper.OrderStatus.Sended && c.PayStatus == WechatMall.Common.EnumHelper.PayStatus.Paid).OrderBy(c => c.CreateTime).ToList().Take(20); foreach (var item in query) { if (!string.IsNullOrEmpty(item.ExpressCode)) { ExpressModel model = ExpressAPI._GetExpress(item.ExpressCode); //确定 快递已签收 修改订单状态 已完成 if (model.state == "3" && model.ischeck == "1") { var order = _ctx.Orders.FirstOrDefault( c => c.OrderId == item.OrderId); order.OrderStatus = WechatMall.Common.EnumHelper.OrderStatus.Over; order.FlowStatus = WechatMall.Common.EnumHelper.FlowStatus.Over; order.UpdateTime = DateTime.Now; _ctx.SaveChanges(); } } } } } } }
(2) UpdateAutoCancelStateJob.cs 代码如下：
using Quartz; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using WechatMall.Application.Data; namespace WechatMallJobLibrary { public class UpdateAutoCancelStateJob:IJob { public void Execute(IJobExecutionContext context) { using (var _ctx = new BtDbContext()) { var order = _ctx.Orders.FirstOrDefault(c => c.OrderStatus == WechatMall.Common.EnumHelper.OrderStatus.UnSend && c.PayStatus == WechatMall.Common.EnumHelper.PayStatus.UnPaid); if (this.DateDiff(DateTime.Now,order.CreateTime) > 30) { order.OrderStatus = WechatMall.Common.EnumHelper.OrderStatus.Cancel; order.FlowStatus = WechatMall.Common.EnumHelper.FlowStatus.Cancel; order.UpdateTime = DateTime.Now; _ctx.SaveChanges(); } } } //计算时间差的方法 private int DateDiff(DateTime DateTime1, DateTime DateTime2) { int dateDiff = 0; TimeSpan ts1 = new TimeSpan(DateTime1.Ticks); TimeSpan ts2 = new TimeSpan(DateTime2.Ticks); TimeSpan ts = ts1.Subtract(ts2).Duration(); // dateDiff = ts.Days.ToString()+"天"+ ts.Hours.ToString()+"小时"+ ts.Minutes.ToString()+"分钟"+ ts.Seconds.ToString()+"秒"; dateDiff = ts.Minutes; return dateDiff; } } }
备注：解释一下上面两个类中的方法中的IJobExecutionContext 参数是什么意思，在Execute方法有一个IJobExecutionContext的接口对象作为参数，这个参数包含了定义这个类的job(作业)的配置信息。作为实例在这里我就没有展示是怎么使用的，有时间我会补充上去的。
第三步：就该设置Trigger 触发器，在实际中我是将Trigger和Job 直接注册到 scheduler 调度器中；在这里其实还有一小步没有指出来就是需要将类库生成的DLL 拷贝到你的需要执行的项目的文件中.详见3.1 中的图
3.1 下面标红的是dll 所放文件的名字，在下面的代码中需要使用的，小伙伴们多注意一下
具体的代码如下：
using Quartz; using Quartz.Impl; using Quartz.Impl.Triggers; using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Reflection; using System.Web; using System.Xml.Linq; namespace WechatMall.SysManage.JobAutoUpdateState { public class JobManage { private static ISchedulerFactory sf = new StdSchedulerFactory(); //调度器 private static IScheduler scheduler; /// <summary> /// 读取调度器配置文件的开始时间 /// </summary> public static void StartScheduleFromConfig() { string currentDir = AppDomain.CurrentDomain.BaseDirectory; try { XDocument xDoc = XDocument.Load(Path.Combine(currentDir, "JobScheduler.config")); var jobScheduler = from x in xDoc.Descendants("JobScheduler") select x; var jobs = jobScheduler.Elements("Job"); XElement jobDetailXElement, triggerXElement; //获取调度器 scheduler = sf.GetScheduler(); //声明触发器 CronTriggerImpl cronTrigger; foreach (var job in jobs) { //加载程序集joblibaray Assembly ass = Assembly.LoadFrom(Path.Combine(currentDir+ "JobAutoUpdateState\\", job.Element("DllName").Value)); //获取任务名字 jobDetailXElement = job.Element("JobDetail"); //获取任务触发的时间 triggerXElement = job.Element("Trigger"); JobDetailImpl jobDetail = new JobDetailImpl(jobDetailXElement.Attribute("job").Value, jobDetailXElement.Attribute("group").Value, ass.GetType(jobDetailXElement.Attribute("jobtype").Value)); if (triggerXElement.Attribute("type").Value.Equals("CronTrigger")) { cronTrigger = new CronTriggerImpl(triggerXElement.Attribute("name").Value, triggerXElement.Attribute("group").Value, triggerXElement.Attribute("expression").Value); //添加定时器 scheduler.ScheduleJob(jobDetail, cronTrigger); } } //开始执行定时器 scheduler.Start(); } catch (Exception) { } } /// <summary> /// 关闭定时器 /// </summary> public static void ShutDown() { if (scheduler != null && !scheduler.IsShutdown) { scheduler.Shutdown(); } } } }
第四步：配置文件，主要是控制任务执行的时间和Job 的加载
<?xml version="1.0" encoding="utf-8"?> <configuration> <JobScheduler> <Job Description="作业1"> <DllName>WechatMallJobLibrary.dll</DllName> <JobDetail job="test1" group="test1Group" jobtype="WechatMallJobLibrary.UpdateCompleteJob" /> <Trigger name="test1" group="test1Group" type="CronTrigger" expression="0 0/30 * * * ?" /> </Job> <Job Description="作业2"> <DllName>WechatMallJobLibrary.dll</DllName> <JobDetail job="test2" group="test2Group" jobtype="WechatMallJobLibrary.UpdateAutoCancelStateJob" /> <Trigger name="test2" group="test2Group" type="CronTrigger" expression="0/30 * * * * ?" /> </Job> </JobScheduler> </configuration>
备注：下面解析一下配置中重要的几个属性 <DllName>WechatMallJobLibrary.dll</DllName> dll的名字 ；jobtype 属性是dll名字+实例类的名字；expression 这个是设置执行的时间，后续我介绍这个时间的设置
第五步：需要将scheduler 调度器注册到程序中；在程序中Global.asax.cs 中文件中添加注册，在这里启动执行任务。
protected void Application_Start() { AreaRegistration.RegisterAllAreas(); FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); RouteConfig.RegisterRoutes(RouteTable.Routes); BundleConfig.RegisterBundles(BundleTable.Bundles); //执行的任务 JobManage.StartScheduleFromConfig(); }
OK，上面的就是Quartz.Net 组件执行定时任务的全部流程了，有什么问题希望大家批评指出；下面就来说明一下设置执行任务的时间的设置：
下面的任务执行时间是参考http://blog.csdn.net/foamflower/article/details/4260645 中的，请详见
CronTrigger 配置设置格式：
1.格式: [秒] [分] [小时] [日] [月] [周] [年]
列入:0 0/30 * * * ? 时隔 30 分钟执行一次
0/30 * * * * ? 时隔 30 秒执行一次
序号
|
说明 |
是否必填
|
允许填写的值
|
允许的通配符
|
|
| 1
|
秒
|
是
|
0-59
|
, - * /
|
| 2
|
分
|
是
|
0-59
|
, - * /
|
| 3
|
小时
|
是
|
0-23
|
, - * /
|
| 4
|
日
|
是
|
1-31
|
, - * ? / L W
|
| 5
|
月
|
是
|
1-12 or JAN-DEC
|
, - * /
|
| 6
|
周
|
是
|
1-7 or SUN-SAT
|
, - * ? / L #
|
| 7
|
年
|
否
|
empty 或 1970-2099
|
, - * /
|
2.通配符
* ：表示所有值. 例如:在分的字段上设置 "*",表示每一分钟都会触发。
?
：表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为"?"
具体设置为 0 0 0 10
* ?
- ：表示区间。例如 在小时上设置 "10-12",表示 10,11,12点都会触发。
,
：表示指定多个值，例如在周字段上设置 "MON,WED,FRI"
表示周一，周三和周五触发
/ ：用于递增触发。如在秒上面设置"5/15"
表示从5秒开始，每增15秒触发(5,20,35,50)。 在月字段上设置'1/3'所示每月1号开始，每隔三天触发一次。
L
：表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]),
在周字段上表示星期六，相当于"7"或"SAT"。如果在"L"前加上数字，则表示该数据的最后一个。
例如在周字段上设置"6L"这样的格式,则表示“本月最后一个星期五"
W ：表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上设置"15W"，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 "1W",它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，"W"前只能设置具体的数字,不允许区间"-").
'L'和 'W'可以一组合使用。如果在日字段上设置"LW",则表示在本月的最后一个工作日触发
# ：序号(表示每月的第几周星期几)，例如在周字段上设置"6#3"表示在每月的第三个周星期六.注意如果指定"6#5",正好第五周没有星期六，则不会触发该配置(用在母亲节和父亲节再合适不过了)
周字段的设置，若使用英文字母是不区分大小写的 MON 与mon相同.
常用示例:
格式: [秒] [分] [小时] [日] [月] [周] [年]
0 0 12 * * ? 每天12点触发
0 15 10 ? * * 每天10点15分触发
0 15 10 * * ? 每天10点15分触发
0 15 10 * * ? * 每天10点15分触发
0 15 10 * * ? 2005 2005年每天10点15分触发
0 * 14 * * ? 每天下午的 2点到2点59分每分触发
0 0/5 14 * * ? 每天下午的 2点到2点59分(整点开始，每隔5分触发)
0 0/5 14,18 * * ? 每天下午的 18点到18点59分(整点开始，每隔5分触发)
0 0-5 14 * * ?
每天下午的 2点到2点05分每分触发
0 10,44 14 ? 3 WED 3月分每周三下午的 2点10分和2点44分触发
0 15 10 ? * MON-FRI 从周一到周五每天上午的10点15分触发
0 15 10 15 * ? 每月15号上午10点15分触发
0 15 10 L * ? 每月最后一天的10点15分触发
0 15 10 ? * 6L 每月最后一周的星期五的10点15分触发
0 15 10 ? * 6L 2002-2005 从2002年到2005年每月最后一周的星期五的10点15分触发
0 15 10 ? * 6#3
每月的第三周的星期五开始触发
0 0 12 1/5 * ? 每月的第一个中午开始每隔5天触发一次
0 11 11 11 11 ? 每年的11月11号 11点11分触发(光棍节)
