• Quartz 基本使用,任务调度quartz详解,动态定时任务,job,Trigger,Scheduler

    一，Quartz的核心概念

    Quartz是什么？Quartz是一个强大任务调度框架，可以用来干嘛？如一个OA系统需要在每周五9点自动生成数据报表，或者想每月10号自动还款，又或者每周给暗恋的女生定时发送邮件等等。下面介绍Quartz的三个核心概念（job,Trigger,Scheduler）。

    导入依赖：

    1.         
    2. 		<dependency>
    3. 			<groupId>org.springframework.bootgroupId>
    4. 			<artifactId>spring-boot-starter-quartzartifactId>
    5. 		dependency>

    1，任务job

    job就是你想实现的任务类，每一个job必须实现org.quartz.job接口，且只需实现接口定义的execute()方法。

    Job：工作任务调度的接口，任务类需要实现该接口，该接口中定义execute方法，类似jdk提供的TimeTask类的run方法，在里面编写任务执行的业务逻辑。

    例如：

    1. import org.quartz.Job;
    2. import org.quartz.JobDataMap;
    3. import org.quartz.JobExecutionContext;
    4. import org.quartz.JobExecutionException;
    5. import org.slf4j.Logger;
    6. import org.slf4j.LoggerFactory;
    7.  
    8. /**
    9.  * @create: 2022-09-17
    10.  **/
    11. public class ScheduleExportJobDTO implements Job {
    12.  
    13.     private final Logger logger = LoggerFactory.getLogger(this.getClass());
    14.  
    15.     @Override
    16.     public void execute(JobExecutionContext context) throws JobExecutionException {
    17.         try {
    18.             JobDataMap jobDataMap = context.getMergedJobDataMap();
    19.             Integer documentId = jobDataMap.getInt("documentId");
    20.             logger.info("执行导出任务,documentId:{}", documentId);
    21.  
    22.             //这个下面调用的就是你想执行的任务方法，我这里是调用一个类里面的导出任务。
    23.             ICEDEvidenceDocumentExportScheduleManager exportScheduleManager = SpringUtils.getBean(ICEDEvidenceDocumentExportScheduleManager.class);
    24.             exportScheduleManager.scheduleExport(documentId);
    25.  
    26.  
    27.         }catch (Exception e){
    28.             logger.info("执行导出任务失败, msg:{}", e.getMessage());
    29.             context.setResult(null);
    30.             throw new JobExecutionException("执行导出任务失败",e);
    31.         }
    32.     }
    33.  
    34. }


    JobDetall ：使用JobDetail来定义定时任务的实例，JobDetail实例是通过JobBuilder类创建。实例在Quartz中的生命周期，每次调度器执行job时它在调用execute方法前，会创建一个新的job实例，当调用完成后，关联
    的job对象实例会被是释放，释放的实例会被垃圾回收机制回收。

    例如：

    1. JobDetail jobDetail=JobBuilder.newJob(ScheduleExportJobDTO .class)//加载任务类，与任务类绑定
    2. 				.withIdentity("job", "group")//参数1：任务名称，参数2：组名称
    3. 				.usingJobData("dataMap", "message")//可以设置JobDataMap，获取存取信息
    4. 				.build();//创建实例

    2，触发器Trigger
    Trigger 为你执行任务的触发器，比如你想每天定时1点发送邮件，Trigger将会设置1点执行该任务。
    Trigger主要包含两种：SimpleTrigger和CronTriggerr。

    Trgger触发器 ：Trigger对象是用于触发执行Job的，当调度一个Job时，我们实例一个触发器然后调整它的属性来满足Job执行的条件，表明任务在什么时候执行。定义了一个已经被安排的任务将在什么时候执行的时间条件，比如每秒执行一次。

    例如：

    1. //2,触发器,Quartz里有多个触发器，最常用的是SimpleTrigger,CronTrigger;
    2. 		SimpleTrigger trigger=TriggerBuilder.newTrigger().withIdentity("trigger", "group")
    3. 				.withSchedule(SimpleScheduleBuilder.simpleSchedule()//属性有开始时间，结束时间，重复次数，重复时间间隔
    4. 						.repeatSecondlyForTotalCount(5, 1))//参数1：count,参数2：second.每一秒重复执行，总共执行3遍
    5. //				.startNow()//立刻执行
    6. 				.startAt(new Date())//设置任务开始时间
    7. 				.endAt(date)//设置任务结束时间
    8. 				.build();
    9.  
    1.         //触发器
    2. 		CronTrigger trigger=TriggerBuilder.newTrigger().withIdentity("trigger", "group").startNow()//立刻执行
    3. 				.withSchedule(CronScheduleBuilder.cronSchedule("0 * * * * ?"))//表示每次0秒时候执行。
    4. 				.build();


    3，调度器Scheduler
    Scheduler是任务的调度器，会将任务job和触发器TRigger结合，负责基于Trigger设定的时间执行job。
     

    1. //		方法之二：从工厂中获取默认的
    2. 		Scheduler scheduler=StdSchedulerFactory.getDefaultScheduler();
    3.         scheduler.scheduleJob(jobDetail,trigger);//关联两者
    1.     //方法之一
    2.     @Autowired
    3.     private Scheduler scheduler;
    4.  
    5.     scheduler.scheduleJob(jobDetail, trigger);

    4.JobDataMap ：可包含数据对象，在job实例执行的是好，可使用包含的数据；JobDataMap是java Map接口的实现，增加了一些存取基本类型方法。

    案例提供：

            需求关于对导出文档这个任务实现定时策略。

            关键代码：包含二个类   1.job类，实现导出任务的任务类，只在execute方法中实现了导出任务。

                                                   2.ScheduleManager管理类，其中有addJob-增加定时导出文档任务，startJob-恢复定时导出文档任务（若以往没有该任务则新增定时导出任务），stopJob-停止定时导出文档任务，getScheduler-获取当前正在执行的定时导出文档任务。

    1.job类

    1. import org.quartz.Job;
    2. import org.quartz.JobDataMap;
    3. import org.quartz.JobExecutionContext;
    4. import org.quartz.JobExecutionException;
    5. import org.slf4j.Logger;
    6. import org.slf4j.LoggerFactory;
    7.  
    8. /**
    9.  * @create: 2022-09-17
    10.  **/
    11. public class ScheduleExportJobDTO implements Job {
    12.  
    13.     private final Logger logger = LoggerFactory.getLogger(this.getClass());
    14.  
    15.     @Override
    16.     public void execute(JobExecutionContext context) throws JobExecutionException {
    17.         try {
    18.             JobDataMap jobDataMap = context.getMergedJobDataMap();
    19.             Integer documentId = jobDataMap.getInt("documentId");
    20.             logger.info("执行导出任务,documentId:{}", documentId);
    21.  
    22.             //这个下面调用的就是你想执行的任务方法，我这里是调用一个类里面的导出任务。
    23.             ICEDEvidenceDocumentExportScheduleManager exportScheduleManager = SpringUtils.getBean(ICEDEvidenceDocumentExportScheduleManager.class);
    24.             exportScheduleManager.scheduleExport(documentId);
    25.  
    26.  
    27.         }catch (Exception e){
    28.             logger.info("执行导出任务失败, msg:{}", e.getMessage());
    29.             context.setResult(null);
    30.             throw new JobExecutionException("执行导出任务失败",e);
    31.         }
    32.     }
    33.  
    34. }

    2.ScheduleManager管理类

    1. import org.quartz.*;
    2. import org.slf4j.Logger;
    3. import org.slf4j.LoggerFactory;
    4. import org.springframework.beans.factory.annotation.Autowired;
    5. import org.springframework.stereotype.Component;
    6.  
    7. import java.util.ArrayList;
    8. import java.util.Date;
    9. import java.util.List;
    10.  
    11. /**
    12.  * @create: 2022-09-18
    13.  **/
    14. @Component
    15. public class ICEDEvidenceDocumentExportScheduleManager {
    16.  
    17.     @Autowired
    18.     private ICEDEvidenceDocumentExportScheduleMapper exportScheduleMapper;
    19.     @Autowired
    20.     private ICEDEvidenceDocumentManager documentManager;
    21.     @Autowired
    22.     private ICEDEvidenceDocumentExportManager documentExportManager;
    23.     @Autowired
    24.     private ICEDEvidenceDocumentStructureMapper documentStructureMapper;
    25.     @Autowired
    26.     private ICEDEvidenceDocumentOperationLogService operationLogService;
    27.     @Autowired
    28.     private ICEDEvidenceDocumentService documentService;
    29.     @Autowired
    30.     private TokenService tokenService;
    31.     @Autowired
    32.     private Scheduler scheduler;
    33.  
    34.     private final CopyOptions copyOptions = CopyOptions.create(null, true);
    35.  
    36.     private static final String JOB_NAME_PREFIX = "export-job-";
    37.  
    38.     private static final String TRIGGER_NAME_PREFIX = "export-trigger-";
    39.  
    40.     private static final Integer ADMIN_USER_ID = 1;
    41.  
    42.     private final Logger logger = LoggerFactory.getLogger(this.getClass());
    43.  
    44.     public void addJob(Integer documentId, String cronExpression) throws SchedulerException {
    45.         JobKey jobKey = getJobKey(documentId);
    46.         logger.info("创建调度任务 jobKey:{}, cronExpression:{}", jobKey, cronExpression);
    47.         JobDetail jobDetail = JobBuilder.newJob(ScheduleExportJobDTO.class)
    48.                 .withIdentity(jobKey)
    49.                 .usingJobData("documentId", documentId)
    50.                 .build();
    51.         CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(getTriggerKey(documentId))
    52.                 .withSchedule(CronScheduleBuilder.cronSchedule(cronExpression))
    53.                 .build();
    54.         scheduler.scheduleJob(jobDetail, trigger);
    55.     }
    56.  
    57.     public void startJob(Integer documentId, String cronExpression) throws SchedulerException {
    58.         JobKey jobKey = getJobKey(documentId);
    59.         if (scheduler.checkExists(jobKey)){
    60.             logger.info("恢复调度任务 jobKey:{}", jobKey);
    61.             scheduler.resumeJob(jobKey);
    62.         }else {
    63.             logger.info("创建调度任务 jobKey:{}, cronExpression:{}", jobKey, cronExpression);
    64.             JobDetail jobDetail = JobBuilder.newJob(ScheduleExportJobDTO.class)
    65.                     .withIdentity(getJobKey(documentId))
    66.                     .usingJobData("documentId", documentId)
    67.                     .build();
    68.             CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(getTriggerKey(documentId))
    69.                     .withSchedule(CronScheduleBuilder.cronSchedule(cronExpression))
    70.                     .build();
    71.             scheduler.scheduleJob(jobDetail, trigger);
    72.         }
    73.     }
    74.  
    75.     public void stopJob(Integer documentId) throws SchedulerException {
    76.         JobKey jobKey = getJobKey(documentId);
    77.         logger.info("停止调度任务 jobKey:{}", jobKey);
    78.         scheduler.pauseJob(jobKey);
    79.     }
    80.  
    81.     private JobKey getJobKey(Integer documentId){
    82.         return JobKey.jobKey(JOB_NAME_PREFIX + documentId);
    83.     }
    84.  
    85.     private TriggerKey getTriggerKey(Integer documentId){
    86.         return TriggerKey.triggerKey(TRIGGER_NAME_PREFIX + documentId);
    87.     }
    88.  
    89.     public Integer saveExportSchedule(ICEDEvidenceDocumentExportScheduleReqDTO exportScheduleReqDTO) {
    90.         Integer loginUserId = getLoginUserId();
    91.         Integer loginUserDeptId = getLoginUserDeptId();
    92.         Date now = new Date();
    93.  
    94.         ICEDEvidenceDocumentExportSchedule exportSchedule = new ICEDEvidenceDocumentExportSchedule();
    95.         BeanUtil.copyProperties(exportScheduleReqDTO, exportSchedule, copyOptions);
    96.         exportSchedule.setOper(loginUserId);
    97.         exportSchedule.setUpdator(loginUserId);
    98.         exportSchedule.setOpTime(now);
    99.         exportSchedule.setUpdateTime(now);
    100.         exportSchedule.setDeptId(loginUserDeptId);
    101.         exportScheduleMapper.insertSelective(exportSchedule);
    102.         return exportSchedule.getId();
    103.     }
    104.  
    105.     public void scheduleExport(Integer documentId){
    106.         ICEvidenceDocument document = documentManager.getEvidenceDocument(documentId);
    107.  
    108.         List documentStructureList = documentStructureMapper.selectChapterDocumentStructure(documentId);
    109.         List dataDTOList = new ArrayList<>();
    110.         for (ICEDEvidenceDocumentStructure documentStructure : documentStructureList) {
    111.             //dataTree 中已经进行权限过滤
    112.             dataDTOList.add(documentService.dataTree(documentStructure.getId()));
    113.         }
    114.         logger.info("查询导出文档数据完成");
    115.         //记录操作日志
    116.         Integer operationLogId = operationLogService.recordLogBeforeOperation(documentId,
    117.                 ICEDEvidenceDocumentOperationType.EXPORT, dataDTOList, null);
    118.         logger.info("记录导出文档操作日志,operationLogId:{}, status: {}", operationLogId, ICEDEvidenceDocumentOperationStatus.getStatusMeaning(ICEDEvidenceDocumentOperationStatus.OPERATING));
    119.         documentExportManager.scheduleExport(document.getTemplateId(), dataDTOList, operationLogId, ADMIN_USER_ID);
    120.     }
    121.  
    122.  
    123.     public Integer getLoginUserId(){
    124.         LoginUser loginUser = tokenService.getLoginUser();
    125.         if (loginUser == null){
    126.             throw new CheckedException("获取当前登录用户失败");
    127.         }
    128.         return Math.toIntExact(loginUser.getUserid());
    129.     }
    130.  
    131.     public Integer getLoginUserDeptId(){
    132.         LoginUser loginUser = tokenService.getLoginUser();
    133.         if (loginUser == null){
    134.             throw new CheckedException("获取当前登录用户失败");
    135.         }
    136.         SysUser sysUser = loginUser.getSysUser();
    137.         if (sysUser == null){
    138.             throw new CheckedException("获取当前登录用户信息失败");
    139.         }
    140.         return Math.toIntExact(sysUser.getDeptId());
    141.     }
    142.  
    143.  
    144.     public String getScheduler() throws SchedulerException {
    145.         List currentlyExecutingJobList = scheduler.getCurrentlyExecutingJobs();
    146.         return JSON.toJSONString(currentlyExecutingJobList);
    147.     }
    148. }
  • 相关阅读:
    我的世界Minecraft基岩版开服服务器教程（Windows)开服器开服包下载开服网站服务器要多少钱开服核心开服端下载
    玩机搞机---mtk芯片机型线刷救砖的一些基本解决方法和步骤解析 mtk报错代码 SP_Flash平台刷机
    abortControllerMap: Map＜string, AbortController＞
    JavaScript基础——巩固练习（3）
    Vue模板语法的缩写是什么？
    Jupyter Notebook 怎么在虚拟环境之间切换
    如何破解压缩包密码，CTF压缩包处理
    商业网络中数字孪生的未开发潜力
    关于Comparable、Comparator接口返回值决定顺序的问题
    0704~springboot整合ES&RabbitMQ
  • 原文地址：https://blog.csdn.net/qq_48964306/article/details/126935096