若依之定时任务

若依之定时任务

定时任务实现与介绍

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

        <dependency>
            <groupId>org.quartz-schedulergroupId>
            <artifactId>quartzartifactId>
            <version>2.3.2version>
        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：用于定义任务具体的逻辑。这里面需要注意的是怎么传入参数、获取参数；
  
  
• 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框架默认提供了四种触发器。

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

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

若依中定时任务实现

若依中定时任务主要在quartz模块中。

若依中定时任务监控页面：

若依中设计了sys_job：来记录定时任务的信息，sys_job_log：来记录定时任务执行的信息。

若依中Job的设计如下，QuartzJobExecution支持并发，QuartzDisallowCOncurrentExceution不支持并发执行。

在AbstractQuartzJob类中保存了定时任务执行的日志。

当我们创建一个定时任务时，其核心方法是ScheduleUtils类的createScheduleJob方法。

定时任务的执行，则是在AbstractQuartzJob的实现类中调用JobInvokeUtil的invokeMethod方法，然后通过反射找到要执行的类的方法去执行。

通过要执行的类的类名TASK_CLASS_NAME、jobId还有jobGroup作为Job的key，后面删除、修改Job的时候需要通过Job key获取Job；
修改的时候除了修改sys_job表中的信息，还需要修改Quartz中Job的信息。而若依中的修改是先把原来的Job删除以后，再创建一个和原来一样得到。

参考

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