在实际工作中，经常会有一些需要定时操作的业务，如：定时发邮件，定时统计信息等内容，那么如何实现才能使得我们的项目整齐划一呢？本文通过一些简单的小例子，简述在.net6 quartz实现定时任务的一些基本操作，及相关知识介绍，仅供学习分享使用，如有不足之处，还请指正。
什么是定时任务
定时任务，也叫任务调度，是指在一定的载体上，根据具体的触发规则，执行某些操作。所以定时任务需要满足三个条件：载体（scheduler），触发规则（trigger），具体业务操作（job）。如下所示：
什么是quartz
quartz 是一个开源的作业调度框架，它完全由 java 写成，并设计用于 j2se 和 j2ee 应用中。它提供了巨大的灵 活性而不牺牲简单性。你能够用它来为执行一个作业而创建简单的或复杂的调度。它有很多特征，如：数据库支持，集群，插件，ejb 作业预构 建，javamail 及其它，支持 cron-like 表达式等等。虽然quartz最初是为java编写的，但是目前已经有.net版本的quartz，所以在.net中应用quartz已经不再是奢望，而是轻而易举的事情了。
github上开源网址为：
关于quartz的快速入门和api文档，可以参考：
涉及知识点
在quartz框架中，主要接口和api如下所示：
其中ischeduler，itrigger , ijob 三者之间的关系，如下所示：
quartz安装
为了方便，本示例创建一个基于.net6.0的控制台应用程序，在vs2022中，通过nuget包管理器进行安装，如下所示：
创建一个简单的定时器任务
要开发一个简单，完整且能运行的定时器任务，步骤如下所示：
1. 创建工作单元job
创建任务需要实现ijob接口，如下所示：
using quartz;
using system.diagnostics;
namespace demoquartz.quartza.job
{
///
/// 测试任务，实现ijob接口
///
public class testjob : ijob
{
public testjob()
{
console.writeline("执行构造函数");//表示每一次计划执行，都是一次新的实例
}
public task execute(ijobexecutioncontext context)
{
return task.run(() =>
{
console.writeline($"******************************");
console.writeline($"测试信息{datetime.now.tostring("yyyy-mm-dd hh:mm:ss.fff")}");
console.writeline($"******************************");
console.writeline();
});
}
}
}
2. 创建时间轴scheduler
时间轴也是任务执行的载体，可以通过stdschedulerfactory进行获取，如下所示：
//创建计划单元（时间轴，载体） stdschedulerfactory schedulerfactory = new stdschedulerfactory(); var scheduler = await schedulerfactory.getscheduler(); await scheduler.start();
3. 创建触发规则trigger
触发规则就是那些时间点执行任务，可通过triggerbuilder进行构建，如下所示：
//trigger时间触发机制
var trigger = triggerbuilder.create()
.withidentity("testtrigger","testgroup")
//.startnow() //立即执行
.withsimpleschedule(w=>w.withintervalinseconds(5).withrepeatcount(5))//.repeatforever()//无限循环
//.withcronschedule("5/10 * * * * ?") //通过cron表达式定制时间触发规则, 示例表示从5开始，每隔10秒一次
.build();
4. 创建任务描述
任务描述定义了具体的任务名称，分组等内容。可通过jobbuilder进行构建，如下所示：
//job详细描述 var jobdetail = jobbuilder.create() .withdescription("这是一个测试job") .withidentity("testjob", "testgroup") .build();
5. 建立三者联系
通过载体，将规则和工作单元串联起来，如下所示：
//把时间和任务通过载体关联起来 await scheduler.schedulejob(jobdetail, trigger);
6. 简单示例测试
通过运行程序，示例结果如下所示：
传递参数
在quartz框架下，如果需要给执行的job传递参数，可以通过两种方式：
jobdetail.jobdatamap，工作描述时通过jobdatamap传递参数。
trigger.jobdatamap, 时间触发时通过jobdatamap传递参数。
在job工作单元中，可以通过context中对应的jobdatamap获取参数。
传递参数，如下所示：
//传递参数
jobdetail.jobdatamap.add("name", "alan");
jobdetail.jobdatamap.add("age", 20);
jobdetail.jobdatamap.add("sex", true);
//trigger同样可以传递参数
trigger.jobdatamap.add("like1", "meimei");
trigger.jobdatamap.add("like2", "football");
trigger.jobdatamap.add("like3", "sing");
获取参数，如下所示：
//获取参数
var name = context.jobdetail.jobdatamap.getstring("name");
var age = context.jobdetail.jobdatamap.getint("age");
var sex = context.jobdetail.jobdatamap.getboolean("sex") ? "男" : "女";
var like1 = context.trigger.jobdatamap.getstring("like1");
var like2 = context.trigger.jobdatamap.getstring("like2");
var like3 = context.trigger.jobdatamap.getstring("like3");
//context.mergedjobdatamap.getstring("aa");//注意如果使用mergedjobdatamap，jobdetail和trigger中用到相同的key，则后面设置的会覆盖前面设置的。
注意：如果使用mergedjobdatamap，jobdetail和trigger中用到相同的key，则后面设置的会覆盖前面设置的。
任务特性
假如我们的定时任务，执行一次需要耗时比较久，而且后一次执行需要等待前一次完成，并且需要前一次执行的结果作为参考，那么就需要设置任务的任性。因为默认情况下，工作单元在每一次运行都是一个新的实例，相互之间独立运行，互不干扰。所以如果需要存在一定的关联，就要设置任务的特性，主要有两个，如下所示：
- [persistjobdataafterexecution]//在执行完成后，保留jobdatamap数据
- [disallowconcurrentexecution]//不允许并发执行，即必须等待上次完成后才能执行下一次
以上两个特性，只需要标记在任务对应的类上即可。标记上后，只需要往对应的jobdatamap中添加值即可。
监听器
在quartz框架下，有三种监听器，分别是：时间轴监听器ischedulerlistener，触发规则监听器itriggerlistener，任务监听器ijoblistener。要实现对应监听器，实现对应接口即可。实现监听器步骤：
1. 创建监听器
根据不同的需要，可以创建不同的监听器，如下所示：
时间轴监听器schedulerlistener
public class testschedulerlistener : ischedulerlistener
{
public task jobadded(ijobdetail jobdetail, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test job is added.");
});
}
public task jobdeleted(jobkey jobkey, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test job is deleted.");
});
}
public task jobinterrupted(jobkey jobkey, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test job is interrupted.");
});
}
public task jobpaused(jobkey jobkey, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test job is paused.");
});
}
public task jobresumed(jobkey jobkey, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test job is resumed.");
});
}
public task jobscheduled(itrigger trigger, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test job is scheduled.");
});
}
public task jobspaused(string jobgroup, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test jobs is paused.");
});
}
public task jobsresumed(string jobgroup, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test jobs is resumed.");
});
}
public task jobunscheduled(triggerkey triggerkey, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test jobs is un schedulered.");
});
}
public task schedulererror(string msg, schedulerexception cause, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test scheduler is error.");
});
}
public task schedulerinstandbymode(cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test scheduler is standby mode.");
});
}
public task schedulershutdown(cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test scheduler is shut down.");
});
}
public task schedulershuttingdown(cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test scheduler is shutting down.");
});
}
public task schedulerstarted(cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test scheduleer is started.");
});
}
public task schedulerstarting(cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test scheduler is starting.");
});
}
public task schedulingdatacleared(cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test scheduling is cleared.");
});
}
public task triggerfinalized(itrigger trigger, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test trigger is finalized.");
});
}
public task triggerpaused(triggerkey triggerkey, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test trigger is paused.");
});
}
public task triggerresumed(triggerkey triggerkey, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test trigger is resumed.");
});
}
public task triggerspaused(string? triggergroup, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test triggers is paused.");
});
}
public task triggersresumed(string? triggergroup, cancellationtoken cancellationtoken = default)
{
return task.run(() => {
console.writeline("test triggers is resumed.");
});
}
}
触发规则监听器triggerlistener
////// 触发器监听 /// public class testtriggerlistener : itriggerlistener { public string name => "testtriggerlistener"; public task triggercomplete(itrigger trigger, ijobexecutioncontext context, schedulerinstruction triggerinstructioncode, cancellationtoken cancellationtoken = default) { //任务完成 return task.run(() => { console.writeline("test trigger is complete."); }); } public task triggerfired(itrigger trigger, ijobexecutioncontext context, cancellationtoken cancellationtoken = default) { return task.run(() => { console.writeline("test trigger is fired."); }); } public task triggermisfired(itrigger trigger, cancellationtoken cancellationtoken = default) { return task.run(() => { console.writeline("test trigger is misfired."); }); } public taskvetojobexecution(itrigger trigger, ijobexecutioncontext context, cancellationtoken cancellationtoken = default) { return task.run(() => { console.writeline("test trigger is veto."); return false;//是否终止 }); } }
joblistener任务监听器
////// testjob监听器 /// public class testjoblistener : ijoblistener { public string name => "testjoblistener"; public task jobexecutionvetoed(ijobexecutioncontext context, cancellationtoken cancellationtoken = default) { //任务被终止时 return task.run(() => { console.writeline("test job is vetoed."); }); } public task jobtobeexecuted(ijobexecutioncontext context, cancellationtoken cancellationtoken = default) { //任务被执行时 return task.run(() => { console.writeline("test job is to be executed."); }); } public task jobwasexecuted(ijobexecutioncontext context, jobexecutionexception? jobexception, cancellationtoken cancellationtoken = default) { //任务已经执行 return task.run(() => { console.writeline("test job was executed."); }); } }
2. 添加监听
在时间轴上的监听管理器中进行添加，如下所示：
//增加监听 scheduler.listenermanager.addjoblistener(new testjoblistener()); scheduler.listenermanager.addtriggerlistener(new testtriggerlistener()); scheduler.listenermanager.addschedulerlistener(new testschedulerlistener());
日志管理
在quartz框架中，创建之前会进行日志创建检测，所以如果需要获取框架中的日志信息，可以进行创建实现ilogprovider，如下所示：
public class testlogprovider : ilogprovider
{
public logger getlogger(string name)
{
return (level, func, exception, parameters) =>
{
if (level >= quartz.logging.loglevel.info && func != null)
{
console.writeline("[" datetime.now.tolongtimestring() "] [" level "] " func(), parameters);
}
return true;
};
}
public idisposable openmappedcontext(string key, object value, bool destructure = false)
{
throw new notimplementedexception();
}
public idisposable opennestedcontext(string message)
{
throw new notimplementedexception();
}
}
然后在当前的scheduler中，添加日志即可，如下所示：
//日志 logprovider.setcurrentlogprovider(new testlogprovider());
完整示例
在添加了监听器，日志，参数传递，任务特性后，完整的目录结构，如下所示：
示例截图
