Quartz在.NET中的使用

• 2021 年 12 月 10 日
• 筆記
• .NET

一、背景

例如需要在某年某月去將資料庫的某個數據更新或者同步,又或者是每隔一段時間來執行一部分程式碼去調用介面,但是又不想人為的手動去執行

針對此類業務可以使用”定時調用任務”,市面上有很多的定時調度任務框架,甚至你可以使用定時器來結合Windows服務做一個簡易版的任務調度程式,此處我們學習Quartz,因為Quartz是一個強大、開源、輕量級的任務調度框架,支援cron-like表達式其他一些優秀的特性。

二、Quartz

1.基本概念

2.初步使用

1.Nuget引入QuartZ程式集

2.創建一個Scheduler任務調度容器

3.指定具體執行的任務Job和觸發器

4.把策略和任務放入到Scheduler並啟動

public class QuartzManager
{
    public async static void Init()
    {
        StdSchedulerFactory factory = new StdSchedulerFactory();
        //創建一個Scheduler任務調度容器
        IScheduler scheduler = await factory.GetScheduler();
        
        //指定具體執行的任務Job
        IJobDetail sendEmailJob = JobBuilder.Create<SendMailJob>()
        .WithIdentity("sendEmailJob", "sendEmailJobGrop")
        .WithDescription("定時發送郵件").Build();
        
        //設置觸發條件為五秒執行一次
        ITrigger sendEmailTrigger = TriggerBuilder.Create()
        .WithIdentity("sendEmailTrigger", "sendEmailJobGrop"
        .WithDescription("QuartZ")
        .WithCronSchedule("3/5 * * * * ?") 
        .Build();

        //把策略和任務放入到Scheduler
        await scheduler.ScheduleJob(sendEmailJob, sendEmailTrigger);
        //執行任務
        await scheduler.Start();
    } 
}


//增加特性保證任務不會重疊執行
[DisallowConcurrentExecution]
public class SendMailJob : IJob
{
    //Job類
    public async Task Execute(IJobExecutionContext context)
    {
        await  Task.Run(() =>
        {
            //doSomthing
            Console.WriteLine($"開始發送郵件{DateTime.Now}");
        });
    }
}

三、傳遞參數

有時候我們想在Job執行時需要一些參數，並根據這些參數來做一些邏輯處理,這時候就需要使用Quartz傳參了。
在Quartz中傳參主要有一些幾種方式

1.job傳參

2.Trigger傳參

1.job傳參和Trigger傳參

使用JobDataMap.Add添加參數，在job內部使用上下文的JobDataMap.GetString獲取

IJobDetail sendEmailJob = JobBuilder.Create<SendMailJob>().Build(); 
//往Job傳一個參數
sendEmailJob.JobDataMap.Add("params","job測試傳參");

ITrigger trigger = TriggerBuilder.Create().Build();
//往trigger傳一個參數
trigger.JobDataMap.Add("params", "trigger測試傳參");

//在job中獲取參數
public async Task Execute(IJobExecutionContext context)
{
    await  Task.Run(() =>
    {
        //獲取job傳參
        string paramJob = context.JobDetail.JobDataMap.GetString("params");
        
        //獲取Trigger傳參
        string paramTrigger = context.Trigger.JobDataMap.GetString("params");
        //doSomthing
        Console.WriteLine($"開始發送郵件{DateTime.Now}");
    });
}

四、在scheduler中註冊監聽器

監聽器是為調度程式中發生的事件執行操作而創建的對象,主要有一下三種監聽器

1.調度監聽器ISchedulerListener主要用於調度過程的監聽。

2.觸發器監聽器ITriggerListener主要用於接收和觸發器相關的事件監聽。

3.作業監聽器IJobListener用於接收Job運行生命周期相關事件監聽。

1.實現監聽器

以作業監聽器為例,因為觸發和調度監聽一樣的實現。

1.自定義作業監聽器需要繼承自IJobListener介面並實現方法.

2.在調度器的監聽管理中添加自定義監聽器.

//實現監聽器
public class CustomJobListener :  IJobListener
{
    public string Name => "CustomJobListener";  
}

//添加到監聽管理中
scheduler.ListenerManager.AddJobListener(new CustomJobListener());

五、可視化管理介面

用於可視化工具來查看當前運行Job的資訊。

1.需要新建一個web項目或者控制台項目。

2.在web項目中 Nuget 引入Quartz 和CrystalQuartz.Remote程式包

3.在Job調度中配置StdSchedulerFactory相關資訊指定監聽埠

 var properties = new NameValueCollection();
 properties["quartz.scheduler.instanceName"] = "Test Monitor System";

 // 設置執行緒池
 properties["quartz.threadPool.type"] = "Quartz.Simpl.SimpleThreadPool, Quartz";
 properties["quartz.threadPool.threadCount"] = "5";
 properties["quartz.threadPool.threadPriority"] = "Normal";

// 遠程輸出配置
properties["quartz.scheduler.exporter.type"] = "Quartz.Simpl.RemotingSchedulerExporter, Quartz";
properties["quartz.scheduler.exporter.port"] = "8081";
properties["quartz.scheduler.exporter.bindName"] = "QuartzScheduler";
properties["quartz.scheduler.exporter.channelType"] = "tcp";

var schedulerFactory = new StdSchedulerFactory(properties);
IScheduler _scheduler = await schedulerFactory.GetScheduler();

4.web監控端去訪問統一的埠號下的CrystalQuartzPanel.axd即可查看。

六、配置文件配置任務

我們除了在程式碼中定義任務的各種調度和觸發器之外，還可以使用xml配置文件的方式來創建Job任務

1.準備配置文件，配置Job+trigger相關資訊,一定要將此文件屬性設為”始終複製”

<?xml version="1.0" encoding="UTF-8"?>
<job-scheduling-data xmlns="//quartznet.sourceforge.net/JobSchedulingData" xmlns:xsi="//www.w3.org/2001/XMLSchema-instance" version="2.0">

  <processing-directives>
    <overwrite-existing-data>true</overwrite-existing-data>
  </processing-directives>
  <schedule>
    <job>
      <name>sendEmailJob</name>
      <group>Test Mail Job</group>
      <description>This is Test Mail Job</description>
      <!--此處為Job所在的類，及程式集-->
      <job-type>DispatcherProject.Job.SendMailJob,DispatcherProject</job-type>
      <durable>true</durable>
      <recover>false</recover>
    </job>
    <trigger>
      <cron>
        <name>sendEmailTrigger</name>
        <group>sendEmailJobGrop</group>
        <job-name>sendEmailJob</job-name>
        <job-group>Test Mail Job</job-group>
        <cron-expression>5/3 * * * * ?</cron-expression>
      </cron>
    </trigger>
  </schedule>
</job-scheduling-data>

2.讀取配置文件，獲取資訊，生成對應的Job和Trigger

XMLSchedulingDataProcessor processor = new XMLSchedulingDataProcessor(new SimpleTypeLoadHelper());
//讀取配置文件
await processor.ProcessFileAndScheduleJobs("~/config/quartz.xml", scheduler);
//啟動調度任務
await scheduler.Start();