ScheduleUtils.java 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. package com.ruoyi.quartz.util;
  2. import org.quartz.CronScheduleBuilder;
  3. import org.quartz.CronTrigger;
  4. import org.quartz.Job;
  5. import org.quartz.JobBuilder;
  6. import org.quartz.JobDetail;
  7. import org.quartz.JobKey;
  8. import org.quartz.Scheduler;
  9. import org.quartz.SchedulerException;
  10. import org.quartz.TriggerBuilder;
  11. import org.quartz.TriggerKey;
  12. import com.ruoyi.common.constant.ScheduleConstants;
  13. import com.ruoyi.common.exception.job.TaskException;
  14. import com.ruoyi.common.exception.job.TaskException.Code;
  15. import com.ruoyi.quartz.domain.SysJob;
  16. /**
  17. * 定时任务工具类
  18. *
  19. * @deprecated 3.4.0删除 迁移至xxl-job
  20. * @author ruoyi
  21. *
  22. */
  23. public class ScheduleUtils
  24. {
  25. /**
  26. * 得到quartz任务类
  27. *
  28. * @param sysJob 执行计划
  29. * @return 具体执行任务类
  30. */
  31. private static Class<? extends Job> getQuartzJobClass(SysJob sysJob)
  32. {
  33. boolean isConcurrent = "0".equals(sysJob.getConcurrent());
  34. return isConcurrent ? QuartzJobExecution.class : QuartzDisallowConcurrentExecution.class;
  35. }
  36. /**
  37. * 构建任务触发对象
  38. */
  39. public static TriggerKey getTriggerKey(Long jobId, String jobGroup)
  40. {
  41. return TriggerKey.triggerKey(ScheduleConstants.TASK_CLASS_NAME + jobId, jobGroup);
  42. }
  43. /**
  44. * 构建任务键对象
  45. */
  46. public static JobKey getJobKey(Long jobId, String jobGroup)
  47. {
  48. return JobKey.jobKey(ScheduleConstants.TASK_CLASS_NAME + jobId, jobGroup);
  49. }
  50. /**
  51. * 创建定时任务
  52. */
  53. public static void createScheduleJob(Scheduler scheduler, SysJob job) throws SchedulerException, TaskException
  54. {
  55. Class<? extends Job> jobClass = getQuartzJobClass(job);
  56. // 构建job信息
  57. Long jobId = job.getJobId();
  58. String jobGroup = job.getJobGroup();
  59. JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(getJobKey(jobId, jobGroup)).build();
  60. // 表达式调度构建器
  61. CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(job.getCronExpression());
  62. cronScheduleBuilder = handleCronScheduleMisfirePolicy(job, cronScheduleBuilder);
  63. // 按新的cronExpression表达式构建一个新的trigger
  64. CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(getTriggerKey(jobId, jobGroup))
  65. .withSchedule(cronScheduleBuilder).build();
  66. // 放入参数,运行时的方法可以获取
  67. jobDetail.getJobDataMap().put(ScheduleConstants.TASK_PROPERTIES, job);
  68. // 判断是否存在
  69. if (scheduler.checkExists(getJobKey(jobId, jobGroup)))
  70. {
  71. // 防止创建时存在数据问题 先移除,然后在执行创建操作
  72. scheduler.deleteJob(getJobKey(jobId, jobGroup));
  73. }
  74. scheduler.scheduleJob(jobDetail, trigger);
  75. // 暂停任务
  76. if (job.getStatus().equals(ScheduleConstants.Status.PAUSE.getValue()))
  77. {
  78. scheduler.pauseJob(ScheduleUtils.getJobKey(jobId, jobGroup));
  79. }
  80. }
  81. /**
  82. * 设置定时任务策略
  83. */
  84. public static CronScheduleBuilder handleCronScheduleMisfirePolicy(SysJob job, CronScheduleBuilder cb)
  85. throws TaskException
  86. {
  87. switch (job.getMisfirePolicy())
  88. {
  89. case ScheduleConstants.MISFIRE_DEFAULT:
  90. return cb;
  91. case ScheduleConstants.MISFIRE_IGNORE_MISFIRES:
  92. return cb.withMisfireHandlingInstructionIgnoreMisfires();
  93. case ScheduleConstants.MISFIRE_FIRE_AND_PROCEED:
  94. return cb.withMisfireHandlingInstructionFireAndProceed();
  95. case ScheduleConstants.MISFIRE_DO_NOTHING:
  96. return cb.withMisfireHandlingInstructionDoNothing();
  97. default:
  98. throw new TaskException("The task misfire policy '" + job.getMisfirePolicy()
  99. + "' cannot be used in cron schedule tasks", Code.CONFIG_ERROR);
  100. }
  101. }
  102. }