若依之定时任务

柔光的暖阳◎ 2024-03-25 09:59 69阅读 0赞

## 若依之定时任务 ##

### 定时任务实现与介绍 ###

若依中定时任务是使用Quartz实现的，首先需要导入Quartz的依赖

<dependency>
                <groupId>org.quartz-scheduler</groupId>
                <artifactId>quartz</artifactId>
                <version>2.3.2</version>
            </dependency>

定时任务逻辑

/**
     * 实现Job接口，重写Execute方法
     */
    public class QuartzJobFactory implements Job {
        
    
        private Logger logger = Logger.getLogger(QuartzJobFactory.class);
    
        @Override
        public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        
            //todo 定时任务逻辑
            logger.info("=============定时任务==============");
        }
    }

这里在系统初始化时触发定时任务，这里是添加了@PostConstruct注解，也可以实现InitializingBean接口

@Component
    public class QuartzService {
        
    
        private Logger logger = Logger.getLogger(QuartzJobFactory.class);
    	
    	//每5秒执行一次
        private static final String CRON_TIME = "*/5 * * * * ?";
    
        private static final String TRIGGER_KEY_NAME = "00000000001";
    
        @PostConstruct
        public void taskInit() {
        
            logger.info("系统初始化加载定时任务开始===========");
            try {
        
                StdSchedulerFactory schedulerFactory = new StdSchedulerFactory();
                Scheduler scheduler = schedulerFactory.getScheduler();
                TriggerKey triggerKey = TriggerKey.triggerKey(TRIGGER_KEY_NAME, Scheduler.DEFAULT_GROUP);
                JobDetail jobDetail = JobBuilder.newJob(QuartzJobFactory.class).withDescription("quartz测试定制化定时任务").withIdentity(TRIGGER_KEY_NAME, Scheduler.DEFAULT_GROUP).build();
                CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(CRON_TIME);
                CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity(triggerKey).withSchedule(cronScheduleBuilder).build();
                scheduler.scheduleJob(jobDetail, cronTrigger);
                scheduler.start();
                logger.info("初始化定时任务加载完成");
            } catch (Exception e) {
        
                logger.info("初始化加载定时任务失败===========");
                e.printStackTrace();
            }
        }
    }

通过上面三步就实现了一个简单的定时任务。接下来我们看看Quartz的核心组件。  
Quartz的核心组件主要是Scheduler、Job 、JobDetail、Trigger。

*  Job：用于定义任务具体的逻辑。这里面需要注意的是怎么传入参数、获取参数；  
    ![a844881c2dc34979b9224f4b91e285f4.png][]  
    ![在这里插入图片描述][c78746ea94e04724ae08f612c843d0b6.png]
 *  JobDetail：定义任务详情。包含执行任务的Job、任务的一些身份信息（方便找到Job），传入参数到任务中去；Job key是任务的唯一标识，可以通过Job key找到任务。

public interface JobDetail {
        
    
        /**
         * job的身份，通过他来找到对应的job
         */
        public JobKey getKey();
    
        /**
         * job描述
         */
        public String getDescription();
    
        /**
         * 执行job的具体类，定时任务的动作都在这个类里面完成
         */
        public Class<? extends Job> getJobClass();
    
        /**
         * 给job传递数据(把需要的参数带到job执行的类里面去)
         */
        public JobDataMap getJobDataMap();
    
        /**
         * 任务孤立的时候是否需要继续报错(孤立:没有触发器关联该任务)
         */
        public boolean isDurable();
    
        /**
         * 和@PersistJobDataAfterExecution注解一样
         * PersistJobDataAfterExecution注解是添加在Job类上的：表示 Quartz 将会在成功执行 execute()
         * 方法后（没有抛出异常）更新 JobDetail 的 JobDataMap，下一次执行相同的任务（JobDetail）
         * 将会得到更新后的值，而不是原始的值
         */
        public boolean isPersistJobDataAfterExecution();
    
        /**
         * 和DisallowConcurrentExecution注解的功能一样
         * DisallowConcurrentExecution注解添加到Job之后，Quartz 将不会同时执行多个 Job 实例，
         * 怕有数据更新的时候不知道取哪一个数据
         */
        public boolean isConcurrentExectionDisallowed();
    
        /**
         * 指示调度程序在遇到“恢复”或“故障转移”情况时是否应重新执行作业
         */
        public boolean requestsRecovery();
    
    
        /**
         * JobDetail是通过构建者模式来实现的
         */
        public JobBuilder getJobBuilder();
    }

*  Trigger：触发器，设置Job什么时候执行。Quartz框架默认提供了四种触发器。

<table> 
 <thead> 
  <tr> 
   <th align="center">触发器</th> 
   <th align="right">作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">SimpleTrigger</td> 
   <td align="right">简单触发器，适用于按指定的时间间隔执行多少次任务的情况</td> 
  </tr> 
  <tr> 
   <td align="center">CronTrigger</td> 
   <td align="right">Cron触发器，通过Cron表达式来控制任务的执行时间</td> 
  </tr> 
  <tr> 
   <td align="center">通过Cron表达式来控制任务的执行时间</td> 
   <td align="right">日期触发器，在给定的时间范围内或指定的星期内以秒、分钟或者小时为周期进行重复的情况</td> 
  </tr> 
  <tr> 
   <td align="center">CalendarIntervalTrigger</td> 
   <td align="right">日历触发器，根据一个给定的日历时间进行重复</td> 
  </tr> 
 </tbody> 
</table>

*  Scheduler：Scheduler调度器用来管理Trigger和Job，并保证Job能在Trigger设置的时间被触发执行

### 若依中定时任务实现 ###

若依中定时任务主要在quartz模块中。  
![在这里插入图片描述][69649ef83a144dc194fbc2377e0fa61e.png]

若依中定时任务监控页面：  
![在这里插入图片描述][70fa9af7a69e4b43aa3388c71fceacdf.png]

若依中设计了sys\_job：来记录定时任务的信息，sys\_job\_log：来记录定时任务执行的信息。  
![在这里插入图片描述][362a7099d6cf40f4938e886f7f35119b.png]  
![在这里插入图片描述][6575f2f2ecaa48d18791cadb7d925567.png]

若依中Job的设计如下，QuartzJobExecution支持并发，QuartzDisallowCOncurrentExceution不支持并发执行。  
![在这里插入图片描述][b58166e46634411aa22b1a2376a87a22.png]

在AbstractQuartzJob类中保存了定时任务执行的日志。  
![在这里插入图片描述][9d74ad3275d645ca9bc49bd8c6fefdc8.png]

当我们创建一个定时任务时，其核心方法是ScheduleUtils类的createScheduleJob方法。  
![在这里插入图片描述][d70f37ef76fc41ac9d8885d3f78259e1.png]  
定时任务的执行，则是在AbstractQuartzJob的实现类中调用JobInvokeUtil的invokeMethod方法，然后通过反射找到要执行的类的方法去执行。  
![在这里插入图片描述][a0a33103379b4337957cc0d23115f81d.png]

通过要执行的类的类名TASK\_CLASS\_NAME、jobId还有jobGroup作为Job的key，后面删除、修改Job的时候需要通过Job key获取Job；![在这里插入图片描述][51d8870b7ebf4a5e92119a76aeebd0f1.png]  
修改的时候除了修改sys\_job表中的信息，还需要修改Quartz中Job的信息。而若依中的修改是先把原来的Job删除以后，再创建一个和原来一样得到。  
![在这里插入图片描述][ba934cf3b7484578bd11c0cecd634e9a.png]  
![在这里插入图片描述][90e4ae7fec8542c59476cee6369b0b41.png]  
项目启动时需要把数据库中定时任务表的记录读取出来，然后根据这些记录还原出定时任务，然后执行，具体逻辑如下：  
![在这里插入图片描述][360828165dfe461f862abb10e09bcefb.png]

### 参考 ###

1.  [Spring Boot Quartz 使用介绍][Spring Boot Quartz]
2.  若依开源项目
3.  [Java中定时任务的6种实现方式，你知道几种？][Java_6]
4.  [使用Quartz实现定时任务（包含管理界面）][Quartz]

[a844881c2dc34979b9224f4b91e285f4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/6f5e62bdea114be4b4d24b75fa30df36.png
[c78746ea94e04724ae08f612c843d0b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/fcd683b7999a470c99b4674616672e3f.png
[69649ef83a144dc194fbc2377e0fa61e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/2005b3ca3dbb4b5a91108957fea48cbf.png
[70fa9af7a69e4b43aa3388c71fceacdf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/c7c72e23e70d475984064d4000a1d396.png
[362a7099d6cf40f4938e886f7f35119b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/3fd2e0c5819541c6a4a18e3f21bdeed2.png
[6575f2f2ecaa48d18791cadb7d925567.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/79aa5b084c89458782409cd01ccaa798.png
[b58166e46634411aa22b1a2376a87a22.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f43c0bce52144ea9bf015df2fd4c1eab.png
[9d74ad3275d645ca9bc49bd8c6fefdc8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/170d84b91fe848008a51bb5131804c16.png
[d70f37ef76fc41ac9d8885d3f78259e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/628ac89e547242e29ebad37d90c77850.png
[a0a33103379b4337957cc0d23115f81d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/d100e21629af49f5a2c60c21caf7b92c.png
[51d8870b7ebf4a5e92119a76aeebd0f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/8b388125eb4a4ac78b290e0abed3494e.png
[ba934cf3b7484578bd11c0cecd634e9a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/becbc28c9ed04d509b74b503de2c2671.png
[90e4ae7fec8542c59476cee6369b0b41.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/024a2398fce44b398d18200174d24951.png
[360828165dfe461f862abb10e09bcefb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/b50777d8d0ea4c2b88ee709793203d9f.png
[Spring Boot Quartz]: https://www.jianshu.com/p/06c4307214b7
[Java_6]: https://blog.csdn.net/wo541075754/article/details/119405514
[Quartz]: https://blog.csdn.net/fanrenxiang/article/details/85539918