Quartz学习笔记（二）-C#Quartz的简单使用

最新推荐文章于 2024-09-14 21:53:48 发布

苏木頭

最新推荐文章于 2024-09-14 21:53:48 发布

阅读量32

点赞数

文章标签：学习笔记

Quartz的简单使用-QuartzHelper：

/**
*┌──────────────────────────────────────────────────────────────┐
*│　描    述：Quartz的简单使用
*│　介    绍：
*│          组成：
*│              调度器（调度单元）：IScheduler
*│              任务（定时任务的内容）：IJobDetail，并实现Ijob接口的Excute方法，时间到后会自动执行这个任务。
*│              触发器：ITrigger，包括SimpleTrigger和CronTrigger
*│
*│  内    容：file:///C:/Users/shuai01.zhang/Desktop/Quartz%E7%9A%84%E4%BB%BB%E5%8A%A1%E7%9A%84%E4%B8%B4%E6%97%B6%E5%90%AF%E5%8A%A8%E5%92%8C%E6%9A%82%E5%81%9C%E5%92%8C%E6%81%A2%E5%A4%8D%20-%20%E5%B0%90%E9%B1%BC%E5%84%BF%20-%20%E5%8D%9A%E5%AE%A2%E5%9B%AD.mhtml
*│      1、调度作业：
*│         	① 实例化时创建调度器Scheduler
*│         	② 启动调度器
*│         	③ 检查调度器是否启动
*│         	④ 关闭调度器
*│         	⑤ 添加Job
*│         	⑥ 删除Job
*│         	⑦ 停止Job
*│         	⑧ 重新恢复Job
*│         	⑨ 更新Trigger
*│      2、非调度作业：启动/暂停 添加 删除
*│ 
*│　作    者：执笔小白
*│　版    本：1.0
*│　创建时间：2022-05-23 17:04:56
*└──────────────────────────────────────────────────────────────┘
*┌──────────────────────────────────────────────────────────────┐
*│　命名空间: QuartzDemo
*│　类    名：QuartzHelper
*└──────────────────────────────────────────────────────────────┘
*/

using Quartz;
using Quartz.Impl;
using Quartz.Impl.Matchers;

namespace QuartzDemo
{
    /// <summary>
    /// Quartz的简单使用
    /// </summary>
    public class QuartzHelper1
    {
        #region 变量
        /// <summary>
        /// 锁对象
        /// </summary>
        private static readonly object lockobj = new object();

        /// <summary>
        /// 调度器
        /// </summary>
        private static IScheduler _scheduler;
        #endregion 变量

        #region 调度作业
        /// <summary>
        /// ① 初始化创建调度器Scheduler
        /// 第二次调用会重新实例化
        /// </summary>
        public static void InitScheduler()
        {
            lock (lockobj)
            {
                // 配置文件的方式，配置quartz实例
                ISchedulerFactory schedulerFactory = new StdSchedulerFactory();
                _scheduler = schedulerFactory.GetScheduler().Result;
            }
        }

        /// <summary>
        /// ② 启动调度器
        /// </summary>
        public static void StartScheduler()
        {
            if (_scheduler.IsStarted) return;
            _scheduler.Start();
        }

        /// <summary>
        /// ③检查调度器是否启动
        /// 停止过后需要简称是否还可以启动
        /// </summary>
        /// <returns></returns>
        public static bool IsStarted()  // 
        {
            return _scheduler.IsStarted;
        }

        /// <summary>
        /// ④ 关闭调度器
        /// </summary>
        public static void Shutdown()
        {
            _scheduler.Shutdown();
        }

        #region 添加Job
        /// <summary>
        /// ⑤ 向调度器添加JobDetail和Trigger
        /// </summary>
        /// <param name="jobDetail">任务内容</param>
        /// <param name="trigger">触发器</param>
        public static void ScheduleJob(IJobDetail jobDetail, ITrigger trigger)
        {
            _scheduler.ScheduleJob(jobDetail, trigger);
        }

        /// <summary>
        /// 向调度器添加Trigger
        /// </summary>
        /// <param name="trigger">触发器</param>
        /// <returns>日期时间偏移量</returns>
        public static DateTimeOffset ScheduleTrigger(ITrigger trigger)
        {
            return _scheduler.ScheduleJob(trigger).Result;
        }

        /// <summary>
        /// 添加多个job任务
        /// </summary>
        /// <param name="triggersAndJobs">调度任务</param>
        /// <param name="replace">是否替换已存在的任务</param>
        public static void ScheduleJobs(IReadOnlyDictionary<IJobDetail, IReadOnlyCollection<ITrigger>> triggersAndJobs,bool replace)
        {
            _scheduler.ScheduleJobs(triggersAndJobs, replace);
        }

        /// <summary>
        /// 添加job任务
        /// </summary>
        /// <param name="jobDetail">Job内容</param>
        /// <param name="replace">是否替换已存在的任务</param>
        public static void AddJob(IJobDetail jobDetail,bool replace)
        {
            _scheduler.AddJob(jobDetail, replace);
        }

        #endregion

        #region 删除Job
        /// <summary>
        /// ⑥ 删除某个Job任务
        /// </summary>
        /// <param name="jobName">Job名字</param>
        public static void DeleteJob(JobKey jobKey)
        {
            if (_scheduler.CheckExists(jobKey).Result)
            {
                //任务已经存在则删除
                _scheduler.DeleteJob(jobKey);
            }
        }
        
        /// <summary>
        /// 删除多个任务
        /// </summary>
        /// <param name="jobNames"></param>
        public static void DeleteJobs(List<JobKey> jobKeys)
        {
            //任务已经存在则删除
            _scheduler.DeleteJobs(jobKeys);
        }

        /// <summary>
        /// 删除某个触发器关联的Job任务
        /// </summary>
        /// <param name="triggerKey">触发器</param>
        /// <returns></returns>
        public static bool UnScheduleJob(TriggerKey triggerKey)
        {
            return _scheduler.UnscheduleJob(triggerKey).Result;
        }

        /// <summary>
        /// 删除多个触发器关联的Job任务
        /// </summary>
        /// <param name="triggerKeys"></param>
        /// <returns></returns>
        public static bool UnScheduleJobs(List<TriggerKey> triggerKeys)
        {
            return _scheduler.UnscheduleJobs(triggerKeys).Result;
        }
        #endregion 删除

        #region 停止Job
        /// <summary>
        /// ⑨ 停止全部的Job任务
        /// </summary>
        public static void PauseAll()
        {
            _scheduler.PauseAll();
        }

        /// <summary>
        /// 停止某个Job任务
        /// </summary>
        /// <param name="jobKey">JobKey</param>
        public static void pauseJob(JobKey jobKey)
        {
            _scheduler.PauseJob(jobKey);
        }

        /// <summary>
        /// 停止多个Job任务
        /// </summary>
        /// <param name="jobKey">JobKey</param>
        public static void pauseJobs(GroupMatcher<JobKey> jobKeys)
        {
            _scheduler.PauseJobs(jobKeys);
        }

        /// <summary>
        /// 停止相关触发器的使用
        /// </summary>
        /// <param name="triggerKey">触发器</param>
        public static void PauseTrigger(TriggerKey triggerKey)
        {
            _scheduler.PauseTrigger(triggerKey);
        }
        
        /// <summary>
        /// 停止多个相关的触发器的使用
        /// </summary>
        /// <param name="triggerKeys">触发器list</param>
        public static void PauseTriggers(GroupMatcher<TriggerKey> triggerKeys)
        {
            _scheduler.PauseTriggers(triggerKeys);
        }
        #endregion 停止Job

        #region 重新恢复
        /// <summary>
        /// 恢复调度中所有的job的任务
        /// </summary>
        public static void ResumeAll()
        {
            _scheduler.ResumeAll();
        }

        /// <summary>
        /// 恢复某个相关的job任务
        /// </summary>
        /// <param name="jobKey">jobKey</param>
        public static void ResumeJob(JobKey jobKey)
        {
            _scheduler.ResumeJob(jobKey);
        }

        /// <summary>
        /// 恢复多个相关的job任务
        /// </summary>
        /// <param name="jobKeys">jobKeys</param>
        public static void ResumeJobs(GroupMatcher<JobKey> jobKeys)
        {
            _scheduler.ResumeJobs(jobKeys);
        }

        /// <summary>
        /// 恢复某个相关的job任务
        /// </summary>
        /// <param name="triggerKey">触发器的Key</param>
        public static void ResumeTrigger(TriggerKey triggerKey)
        {
            _scheduler.ResumeTrigger(triggerKey);
        }

        /// <summary>
        /// 恢复多个触发器相关的job任务
        /// </summary>
        /// <param name="triggerKeys">触发器的Keys</param>
        public static void ResumeTriggers(GroupMatcher<TriggerKey> triggerKeys)
        {
            _scheduler.ResumeTriggers(triggerKeys);
        }
        #endregion 重新恢复

        #region 更新Trigger
        /// <summary>
        /// 给触发器Key设置新的触发器
        /// </summary>
        /// <param name="triggerKey">触发器的Key值</param>
        /// <param name="trigger">触发器</param>
        /// <returns></returns>
        public static DateTimeOffset? RescheduleJob(TriggerKey triggerKey, ITrigger trigger)
        {
            return _scheduler.RescheduleJob(triggerKey, trigger).Result;
        }
        #endregion
        #endregion 调度作业

        #region 非调度作业
        // 启动

        // 停止

        // 添加

        // 删除

        #endregion
    }
}