.Net Core中使用Quartz.Net實踐記錄

Quartz.NET是一套很好的任務調度框架。下面這篇文章主要給大家介紹了關於.Net Core中使用Quartz.Net的相關資料，文中通過示例代碼介紹的非常詳細，需要的朋友可以參考借鑑，下面隨着小編來一起學習學習吧

一、介紹

Quartz.NET是一個強大、開源、輕量的作業調度框架，是 OpenSymphony 的 Quartz API 的.NET移植，用C#改寫，可用於winform和asp.net應用中。它靈活而不復雜。你能夠用它來爲執行一個作業而創建簡單的或複雜的作業調度。它有很多特徵，如：數據庫支持，集羣，插件，支持cron-like表達式等等。

通俗說它的功能是：比如說我想每天晚上2點讓程序或網站執行某些代碼，或者每隔5秒種我想查看是否有新的任務要處理等。

Quartz.Net是根據Java的Quartz用C#改寫而來，最新的版本是3.0.6，源碼在https://github.com/quartznet/quartznet （本地下載）。

實踐教程

以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個字段，秒分時月內日期月周內日期年(可選)。

舉例：

 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 調度器

調度器就是將任務和觸發器綁定，讓觸發器觸發的時候去執行任務。

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對神馬文庫的支持。

.Net Core中使用Quartz.Net實踐記錄

一鍵自動化博客發佈工具,用過的人都說好(頭條篇)

.Net Core中使用ElasticSearch（二）

.Net Core中使用ElasticSearch（一）

使用.Net Core做個爬蟲

.Net Core中使用Grpc

開源日誌組件Exceptionless

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結