Java Quartz 构建定时调度任务

前言

在日常开发中，我们经常会遇见这样的情况，我们要在指定的时间去执行一个任务，或者周期性在某个时间点上执行一个任务，这种事情让人去操作显然是不合适的，因此，我们可以使用Quartz来实现我们的要求。
Quartz对于Java提供友好的API和文档，帮助我们构建定时调度任务，本文中的quartz版本为2.2版本。

介绍Quartz

quartz是一个开源的定时调度类库，使用它可以简单方便的在指定的时间或时间周期内执行定时任务，关于quartz的几个核心API需要先介绍一下：

• Scheduler：核心任务调度器
• Job：你需要被调度器执行的任务需要实现的一个接口
• JobDetail：每个任务的具体细节
• Trigger：一个定义了调度器上面需要有哪些任务需要被执行的组件
• JobBuilder：通常用来构建/定义 JobDetail实例
• TriggerBuilder：通常用来构建/定义 Trigger实例

实现

maven依赖：

        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.2.3</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>4.2.5.RELEASE</version>
        </dependency>

如果使用的Spring容器，需要多加一个Spring的支持依赖。

然后我们首先开始创建一个Job任务：

public class ExecuteJob implements Job {
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        String  name = context.getJobDetail().getKey().getName();
        System.out.println("定时调度启动成功");
    }
}

我们创建了一个Job定时任务，这里获取了一个name属性，这个我们到后边再说。

然后我们开始创建定时任务调度：

public class schedule {
    public void operateSchedule() {
        //1.创建Scheduler的工厂
        SchedulerFactory sf = new StdSchedulerFactory();
        try {
            //2.从工厂中获取调度器实例
            Scheduler scheduler = sf.getScheduler();
            //3.启动 调度器
            scheduler.start();
            //4.创建JobDetail
            JobDetail jobDetail =
            JobBuilder.newJob(ExecuteJob.class)
            .withDescription("数据库操作定时任务")
            .withIdentity("jobName", "group")
            .usingJobData("name", 1)
            .build();

            //5.创建Trigger
            Trigger trigger = TriggerBuilder.newTrigger()
            .withDescription("定时任务，可自定义时间，执行一次")
            .withIdentity("jobName", "group")
            //默认在当前时间启动
            .startAt(new Date())    
            //重复执行的次数       
            .withSchedule(            
            SimpleScheduleBuilder.simpleSchedule()
            .withRepeatCount(0))
            .build();

            //6.注册任务和定时器
            scheduler.scheduleJob(jobDetail, trigger);          
        } catch (Exception e) {
            e.printStackTrace();    
        }
    }
}

上面的代码展示创建一个定时调度任务每一步；
第一步需要创建Scheduler的工厂；
第二步从工厂中获取调度器实例；
第三步启动调度器；
第四步创建JobDetail，在JobDetail中，我们可以设置job的名称与group名称，并传递一个参数值进去，这里传递的值在Job具体执行的地方可以获取到，就是在我们最开始的地方看到的代码；
第五步创建Trigger，Trigger需要配置一下Job的name与group，并设定任务开始执行的时间，与执行的周期频度
第六步注册任务和定时器，注册完成后，任务将会在指定的时间去调用Job执行。

总结

相比于在Spring中通过配置文件的方式，通过API进行调用的方式更加的灵活，可以动态执行执行，也可以动态停止执行定时任务，在本文中只展示了如何创建并启动一个任务，关于更多使用的方式可以参见官方的文档Quartz Tutorials