Spring Boot：实现定时任务的多种方式

1、定时任务实现方式

1、Timer：这是java自带的java.util.Timer类，这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行，但不能在指定时间运行。一般用的较少。
2、ScheduledExecutorService：也jdk自带的一个类；是基于线程池设计的定时任务类,每个调度任务都会分配到线程池中的一个线程去执行,也就是说,任务是并发执行,互不影响。
3、Spring Task：Spring3.0以后自带的task，可以将它看成一个轻量级的Quartz，而且使用起来比Quartz简单许多。
4、Quartz：这是一个功能比较强大的的调度器，可以让你的程序在指定时间执行，也可以按照某一个频度执行，配置起来稍显复杂。

2、使用Spring Task定时任务

Spring boot中使用定时任务只要使用两个注解@EnableScheduling、@Scheduled

2.1 在Spring boot的启动类上添加@EnableScheduling注解，开启基于注解的定时任务。

package com.ieslab.powergrid.demosvr;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling  //开启基于注解的定时任务
public class DemosvrApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemosvrApplication.class, args);
    }
}

2.2 在我们的任务类的业务方法上添加@Scheduled注解。

package com.ieslab.powergrid.demosvr.service;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;
import java.text.SimpleDateFormat;
import java.util.Date;

@Service
public class JobService {
    //cron = "0/3 40 11 * * ?" 每天19:50触发，每隔三秒执行一次
    @Scheduled(cron = "0/3 50 19 * * ?")
    public void printTime() {
        System.out.println("current time :"+new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }
}

运行程序，观察控制台打印如下日志，说明配置成功。

3、Spring Boot集成Quartz

3.1 引入Maven的依赖

如果SpringBoot版本是2.0.0以后的，则在spring-boot-starter中已经包含了quart的依赖，则可以直接使用spring-boot-starter-quartz依赖：

<!--定时任务-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

这里我使用SpringBoot版本是2.2.4.RELEASE ，该版本开始集成了Quartz，所以事实现起来很方便。

3.2 创建任务类MyQuartz

该类主要是继承了QuartzJobBean，代码如下：

package com.ieslab.powergrid.demosvr.utils;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;
import java.text.SimpleDateFormat;
import java.util.Date;

/** <p>Title: MyQuartz </p>
 * <p>Description: 测试任务 </p>
 *
 * @author bingge
 * @date 2020-2-20 下午7:15:30
 * @version V1.0
 */
public class MyQuartz extends QuartzJobBean {
    /**
     * 执行定时任务
     * @param context
     * @throws JobExecutionException
     */
    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        //获取JobDetail中关联的数据
        String msg = (String) context.getJobDetail().getJobDataMap().get("msg");
        System.out.println("current time :"
                +new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "---" + msg);
    }
}

这个任务每次执行时，就打印一行日志。

3.3 创建QuartzConfig配置类

 	package com.ieslab.powergrid.demosvr.config;

import com.ieslab.powergrid.demosvr.utils.MyQuartz;
import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/** <p>Title: QuartzConfig </p>
 * <p>Description: 调度任务配置类 </p>
 *
 * @author bingge
 * @date 2020-2-20 下午7:15:30
 * @version V1.0
 */
@Configuration
public class QuartzConfig {
    @Bean
    public JobDetail printTimeJobDetail(){
        return JobBuilder.newJob(MyQuartz.class)//PrintTimeJob我们的业务类
                .withIdentity("MyQuartz")//可以给该JobDetail起一个id
                //每个JobDetail内都有一个Map，包含了关联到这个Job的数据，在Job类中可以通过context获取
                .usingJobData("msg", "Hello Quartz")//关联键值对
                .storeDurably()//即使没有Trigger关联时，也不需要删除该JobDetail
                .build();
    }
    @Bean
    public Trigger printTimeJobTrigger() {
        CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/3 1 20 * * ?");
        return TriggerBuilder.newTrigger()
                .forJob(printTimeJobDetail())//关联上述的JobDetail
                .withIdentity("quartzTaskService")//给Trigger起个名字
                .withSchedule(cronScheduleBuilder)
                .build();
    }
}

其中配置了执行策略：0/3 1 20 * * ? 意思就是20：01分执行，每三秒执行一次。
运行效果如下：

4、TimerTask任务实现定时任务

这个比较简单，缺点时，不支持cron表达式

public class TestTimer {
    public static void main(String[] args) {
        TimerTask timerTask = new TimerTask() {
            @Override
            public void run() {
                System.out.println("task  run:"+ new Date());
            }
        };
        Timer timer = new Timer();
        //安排指定的任务在指定的时间开始进行重复的固定延迟执行。这里是每3秒执行一次
        timer.schedule(timerTask,10,3000);
    }
}

5、使用ScheduledExecutorService

public class TestScheduledExecutorService {
    public static void main(String[] args) {
        ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();
        service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService "+new Date()), 0, 3, TimeUnit.SECONDS);
    }
}

参数

1. 任务体
2. 首次执行的延时时间
3. 任务执行间隔
4. 间隔时间单位

6、总结

本文介绍了4中方式实现定时任务，不过目前用的较多的是分布式调度任务：Quartz，集成很简单，后续会介绍怎么结合界面进行动态任务的创建。