欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

.Net Core中使用Quartz.Net实践记录

程序员文章站 2023-11-05 22:09:16
一、介绍 quartz.net是一个强大、开源、轻量的作业调度框架,是 opensymphony 的 quartz api 的.net移植,用c#改写,可用于winf...

一、介绍

quartz.net是一个强大、开源、轻量的作业调度框架,是 opensymphony 的 quartz api 的.net移植,用c#改写,可用于winform和asp.net应用中。它灵活而不复杂。你能够用它来为执行一个作业而创建简单的或复杂的作业调度。它有很多特征,如:数据库支持,集群,插件,支持cron-like表达式等等。

通俗说它的功能是:比如说我想每天晚上2点让程序或网站执行某些代码,或者每隔5秒种我想查看是否有新的任务要处理等。

quartz.net是根据java的quartz用c#改写而来,最新的版本是3.0.6,源码在 ()。

实践教程

以webapi项目举例,用vs脚手架功能新建webapi项目。

public void configureservices(iservicecollection services)
{
 services.addmvc();
 services.addsingleton<ischedulerfactory, stdschedulerfactory>();//注册ischedulerfactory的实例。
 }
[route("api/[controller]")]
 public class valuescontroller : controller
 {
 private readonly ischedulerfactory _schedulerfactory;
 private ischeduler _scheduler;
 public valuescontroller(ischedulerfactory schedulerfactory)
 {
  this._schedulerfactory = schedulerfactory;
 }
 [httpget]
 public async task<string[]> get()
 {
       //1、通过调度工厂获得调度器
  _scheduler = await _schedulerfactory.getscheduler();
       //2、开启调度器
  await _scheduler.start();
       //3、创建一个触发器
  var trigger = triggerbuilder.create()
    .withsimpleschedule(x => x.withintervalinseconds(2).repeatforever())//每两秒执行一次
    .build();
       //4、创建任务
  var jobdetail = jobbuilder.create<myjob>()
    .withidentity("job", "group")
    .build();
       //5、将触发器和任务器绑定到调度器中
  await _scheduler.schedulejob(jobdetail, trigger);
  return await task.fromresult(new string[] { "value1", "value2" });
 }
 }
public class myjob : ijob//创建ijob的实现类,并实现excute方法。
 {
 public task execute(ijobexecutioncontext context)
 {
      return task.run(() =>
    {
    using (streamwriter sw = new streamwriter(@"c:\users\administrator\desktop\error.log", true, encoding.utf8))
    {
     sw.writeline(datetime.now.tostring("yyyy-mm-dd hh-mm-ss"));
    }
  });
 }
 }

输出的结果:

2018-08-03 00-03-19
2018-08-03 00-03-20
2018-08-03 00-03-22
2018-08-03 00-03-24
2018-08-03 00-03-26

上面这种执行的job没有参数,当需要参数可以通过下面两种方法传递参数:

1、在trigger中添加参数值

 var trigger3 = triggerbuilder.create()
   .withsimpleschedule(x =>x.withintervalinseconds(2).repeatforever())//间隔2秒 一直执行
   .usingjobdata("key1", 321) //通过在trigger中添加参数值
   .usingjobdata("key2", "123")
   .withidentity("trigger2", "group1")
   .build();

2、在job中添加参数值

 ijobdetail job = jobbuilder.create<myjob>()
    .usingjobdata("key1", 123)//通过job添加参数值
    .usingjobdata("key2", "123")
    .withidentity("job1", "group1")
    .build();

通过下面方法在job中获取参数值

public class myjob : ijob
 {
 public task execute(ijobexecutioncontext context)
 {
  var jobdata = context.jobdetail.jobdatamap;//获取job中的参数

  var triggerdata = context.trigger.jobdatamap;//获取trigger中的参数

  var data = context.mergedjobdatamap;//获取job和trigger中合并的参数

  var value1= jobdata.getint("key1");
  var value2= jobdata.getstring("key2");

  var datestring = datetime.now.tostring("yyyy-mm-dd hh-mm-ss");return task.run(() =>
  {
  using (streamwriter sw = new streamwriter(@"c:\users\administrator\desktop\error.log", true, encoding.utf8))
  {
   sw.writeline(datestring);
  }
  });
 }
 }

当job中的参数和trigger中的参数名称一样时,用 context.mergedjobdatamap获取参数时,trigger中的值会覆盖job中的值。

3、上面那种情况只能适应那种,参数值不变的情况。

假如有这种情况,这次的参数值是上一次执行后计算的值,就不能使用上面方法了。如 每两秒实现累加一操作,现在初始值是0,如果按照上面那种获取值的操作,一直都是0+1,返回值一直都是1。为了满足这个情况,只需要加一个特性[persistjobdataafterexecution]。

[persistjobdataafterexecution]//更新jobdetail的jobdatamap的存储副本,以便下一次执行这个任务接收更新的值而不是原始存储的值
 public class myjob : ijob
 {
 public task execute(ijobexecutioncontext context)
 {
  var jobdata = context.jobdetail.jobdatamap;
  var triggerdata = context.trigger.jobdatamap;
  var data = context.mergedjobdatamap;

  var value1 = jobdata.getint("key1");
  var value2 = jobdata.getstring("key2");
  var value3 = data.getstring("key2");

  var datestring = datetime.now.tostring("yyyy-mm-dd hh-mm-ss");
  random random = new random();

  jobdata["key1"] = random.next(1, 20);//这里面给key赋值,下次再进来执行的时候,获取的值为更新的值,而不是原始值
  jobdata["key2"] = datestring;

  return task.run(() =>
  {
  using (streamwriter sw = new streamwriter(@"c:\users\administrator\desktop\error.log", true, encoding.utf8))
  {
   sw.writeline($"{datestring} value1:{value1} value2:{value2}");
  }
  //context.scheduler.deletejob(context.jobdetail.key);
  //context.scheduler.shutdown();
  });
 }
 }

三、quartz.net组成

quartz主要有三部分组成任务(job)、触发器(trigger)和调度器(schedule)。

3.1 任务 

job就是执行的作业,job需要继承ijob接口,实现execute方法。job中执行的参数从execute方法的参数中获取。

3.2 触发器

触发器常用的有两种:simpletrigger触发器和crontrigger触发器。

simpletrigger:能是实现简单业务,如每隔几分钟,几小时触发执行,并限制执行次数。

var trigger = triggerbuilder.create()
   .withsimpleschedule(x => x.withintervalinseconds(2).withrepeatcount(5))//间隔2秒 执行6次
   .usingjobdata("key1", 321)
   .withidentity("trigger", "group")
   .build();

crontrigger:cron表达式包含7个字段,秒 分 时 月内日期 月 周内日期 年(可选)。

.Net Core中使用Quartz.Net实践记录

.Net Core中使用Quartz.Net实践记录

举例:

 var trigger = triggerbuilder.create()
   .withcronschedule("0 0 0 1 1 ?")// 每年元旦1月1日 0 点触发
   .usingjobdata("key1", 321)
   .usingjobdata("key2", "trigger-key2")
   .withidentity("trigger4", "group14")
   .build();

"0 15 10 * * ? *"         每天上午10:15触发 

"0 0-5 14 * * ?"          每天下午2点到下午2:05期间的每1分钟触发 

3.3 调度器

调度器就是将任务和触发器绑定,让触发器触发的时候去执行任务。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。