springboot实现定时任务

springboot实现定时任务有两种，一种是使用 Spring 自带的定时任务处理器 @Scheduled 注解，另一种就是使用第三方框架 Quartz ，下面看一下在springboot中如何使用这两种定时器。

@Scheduled

使用 @Scheduled 非常容易，直接创建一个 Spring Boot 项目，并且添加 web 依赖 spring-boot-starter-web，项目创建成功后，添加 @EnableScheduling 注解，开启定时任务：

如下：

@SpringBootApplication
@EnableScheduling //开启定时任务
public class ScheduledApplication {
​
    public static void main(String[] args) {
        SpringApplication.run(ScheduledApplication.class, args);
    }
​
}

接下来配置定时任务：

@Service
public class HelloService {
    @Scheduled(fixedDelay = 2000)//前面任务的结束时间和后面任务的开始时间间隔是2秒
    public void fixDelay(){
        //System.out.println("fixDelay>>>"+new Date());
    }
​
    //两次定时任务开启的时间间隔为2秒，不管第一个任务有没有执行完毕，2秒后开启下一个任务
    @Scheduled(fixedRate = 2000)
    public void fixedRate(){
        //System.out.println("fixedRate"+new Date());
    }
​
    //cron表达式写法
    //分别表示秒、分、时、日、月、周、年（可以不写）
    @Scheduled(cron = "0/5 56 * * * ?")
    public void corn(){
        System.out.println("corn>>>"+new Date());
    }
}

1. 首先使用 @Scheduled 注解开启一个定时任务。

2. fixedRate 表示任务执行之间的时间间隔，具体是指两次任务的开始时间间隔，即第二次任务开始时，第一次任务可能还没结束。

3. fixedDelay 表示任务执行之间的时间间隔，具体是指本次任务结束到下次任务开始之间的时间间隔。

4. initialDelay 表示首次任务启动的延迟时间。

5. 所有时间的单位都是毫秒。

上面这是一个基本用法，除了这几个基本属性之外，@Scheduled 注解也支持 cron 表达式，使用 cron 表达式，可以非常丰富的描述定时任务的时间。cron 表达式格式如下：

从左到右依次表示 秒、分、时、日、月、周、年

具体取值如下：

序号	说明	是否必填	允许填写的值	允许的通配符
1	秒	是	0-59	- * /
2	分	是	0-59	- * /
3	时	是	0-23	- * /
4	日	是	1-31	- * ? / L W
5	月	是	1-12 or JAN-DEC	- * /
6	周	是	1-7 or SUN-SAT	- * ? / L #
7	年	否	1970-2099	- * /

这一块需要大家注意的是，月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?

通配符含义：

• ? 表示不指定值，即不关心某个字段的取值时使用。需要注意的是，月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?

• * 表示所有值，例如:在秒的字段上设置 *,表示每一秒都会触发

• , 用来分开多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发

• - 表示区间，例如在秒上设置 “10-12”,表示 10,11,12秒都会触发

• / 用于递增触发，如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)

• # 序号(表示每月的第几个周几)，例如在周字段上设置”6#3”表示在每月的第三个周六，(用 在母亲节和父亲节再合适不过了)

• 周字段的设置，若使用英文字母是不区分大小写的 ，即 MON 与mon相同

• L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会自动判断是否是润年), 在周字段上表示星期六，相当于”7”或”SAT”（注意周日算是第一天）。如果在”L”前加上数字，则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示”本月最后一个星期五”

• W 表示离指定日期的最近工作日(周一至周五)，例如在日字段上设置”15W”，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发，如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，”W”前只能设置具体的数字,不允许区间”-“)

• L 和 W 可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发(一般指发工资 )

例如，在 @Scheduled 注解中来一个简单的 cron 表达式，每隔5秒触发一次，如下：

//cron表达式写法
    //分别表示秒、分、时、日、月、周、年（可以不写）
    @Scheduled(cron = "0/5 * * * * ?")
    public void corn(){
        System.out.println("corn>>>"+new Date());
    }

上面是使用@Scheduled 注解的方式来实现定时任务 。

Quartz

使用Quartz做定时任务在建项目的时候要导入相应的依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

项目创建完成后，也需要添加开启定时任务的注解：

@SpringBootApplication
@EnableScheduling //开启定时任务
public class ScheduledApplication {
​
    public static void main(String[] args) {
        SpringApplication.run(ScheduledApplication.class, args);
    }
​
}

Quartz 在使用过程中，有两个关键概念，一个是JobDetail（要做的事情），另一个是触发器（什么时候做），要定义 JobDetail，需要先定义 Job，Job 的定义有两种方式：

第一种方式：

@Component//MyFirst定义一个bean，使用springboot直接将该类定义成一个bean，这种方式无法传参
public class MyFirstJob {
    public void sayHello(){
        System.out.println("first say hello"+new Date());
    }
}

第二种定义方式，则是继承 QuartzJobBean 并实现默认的方法：

public class MySecondJob extends QuartzJobBean {
    private String name;
​
    public void setName(String name) {
        this.name = name;
    }
​
    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("second say hello:"+name+new Date());
    }
}

和第1种方式相比，这种方式支持传参，任务启动时，executeInternal 方法将会被执行。

Job 有了之后，接下来创建类，配置 JobDetail 和 Trigger 触发器，如下：

@Configuration
public class QuartzConfig {
    //配置MyFirstJob的定时方式
    @Bean
    MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean(){
        MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("myFirstJob");//配置定时任务的类(bean名称)
        bean.setTargetMethod("sayHello");//配置要执行的定时任务的方法
        return bean;
    }
​
    //第二种配置方式（MySecondJob实现定时任务方式）
    @Bean
    JobDetailFactoryBean jobDetailFactoryBean(){
        JobDetailFactoryBean factoryBean = new JobDetailFactoryBean();
        JobDataMap map = new JobDataMap();
        //传递参数
        map.put("name","changan");
        factoryBean.setJobDataMap(map);
        factoryBean.setJobClass(MySecondJob.class);
        return factoryBean;
​
    }
​
    //配置触发器
    @Bean
    SimpleTriggerFactoryBean simpleTriggerFactoryBean(){
        SimpleTriggerFactoryBean triggerFactoryBean = new SimpleTriggerFactoryBean();
        triggerFactoryBean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
        //设置开始时间
        triggerFactoryBean.setStartTime(new Date());
        //设置间隔时间
        triggerFactoryBean.setRepeatInterval(2000);
        //设置重复次数
        triggerFactoryBean.setRepeatCount(5);
        return triggerFactoryBean;
    }
​
    //cron表达式方式配置触发器
    @Bean
    CronTriggerFactoryBean cronTriggerFactoryBean(){
        CronTriggerFactoryBean cronTriggerFactoryBean = new CronTriggerFactoryBean();
        cronTriggerFactoryBean.setJobDetail(jobDetailFactoryBean().getObject());
        cronTriggerFactoryBean.setCronExpression("* * * * * ?");
        return cronTriggerFactoryBean;
    }
​
    @Bean
    SchedulerFactoryBean schedulerFactoryBean(){
        SchedulerFactoryBean bean = new SchedulerFactoryBean();
        bean.setTriggers(simpleTriggerFactoryBean().getObject(),cronTriggerFactoryBean().getObject());
        return bean;
    }
}

​

关于这个配置说如下几点：

1. JobDetail 的配置有两种方式：MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。

2. 使用 MethodInvokingJobDetailFactoryBean 可以配置目标 Bean 的名字和目标方法的名字，这种方式不支持传参。

3. 使用 JobDetailFactoryBean 可以配置 JobDetail ，任务类继承自 QuartzJobBean ，这种方式支持传参，将参数封装在 JobDataMap 中进行传递。

4. Trigger 是指触发器，Quartz 中定义了多个触发器，这里向大家展示其中两种的用法，SimpleTrigger 和 CronTrigger 。

5. SimpleTrigger 有点类似于前面说的 @Scheduled 的基本用法。

6. CronTrigger 则有点类似于 @Scheduled 中 cron 表达式的用法。

以上就是在springboot中使用两种定时任务的方式

 

参考自：http://springboot.javaboy.org/2019/0418/springboot-schedule-task