SpringBoot中實(shí)現(xiàn)定時(shí)任務(wù)的幾種方式

更新時(shí)間：2023年05月24日 08:51:46 作者：JK凱

定時(shí)任務(wù)在我們項(xiàng)目開(kāi)發(fā)中也是很重要的，對(duì)于某些場(chǎng)景必須要用定時(shí)任務(wù)?，如定時(shí)發(fā)送郵件啊，定時(shí)統(tǒng)計(jì)數(shù)據(jù)等，這篇文章主要講講項(xiàng)目中實(shí)現(xiàn)定時(shí)任務(wù)的幾種方式,需要的朋友可以參考下

一、基于注解

這種方式很簡(jiǎn)單，主要就是先@EnableScheduling開(kāi)啟定時(shí)任務(wù)功能，然后在相應(yīng)的方法上添加@Scheduled()中間寫(xiě)上相應(yīng)的cron表達(dá)式即可。示例如下：

schedule.ScheduleTask:

import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
@Component
@EnableScheduling //開(kāi)啟定時(shí)任務(wù)
public class ScheduleTask {
    @Scheduled(cron = "0/5 * * * * ?") //定時(shí)任務(wù)注解+cron表達(dá)式
    public void testScheduleTask() {
        System.out.println("執(zhí)行定時(shí)任務(wù)" + LocalDateTime.now());
    }
}

Cron表達(dá)式參數(shù)參考：

秒（0~59）例如0/5表示每5秒
分（0~59）
時(shí)（0~23）
日（0~31）的某天，需計(jì)算
月（0~11）
周幾（可填1-7 或 SUN/MON/TUE/WED/THU/FRI/SAT）

建議：直接在線生成Cron表達(dá)式比較方便：www.matools.com/cron/

@Scheduled：除了支持靈活的參數(shù)表達(dá)式cron之外，還支持 fixedDelay，fixedRate，initialDelay 這些延時(shí)性的操作。

啟動(dòng)測(cè)試就實(shí)現(xiàn)了基本的定時(shí)任務(wù)功能，但是如果我們修改了cron表達(dá)式，需要重啟整個(gè)應(yīng)用才能生效，不是很方便。想要實(shí)現(xiàn)修改cron表達(dá)式就生效就需要用到接口的方式來(lái)實(shí)現(xiàn)定時(shí)任務(wù)。

二、基于接口

接口的方式是我們把定時(shí)任務(wù)的信息放在數(shù)據(jù)庫(kù)中，程序從數(shù)據(jù)庫(kù)去拉取定時(shí)任務(wù)的信息如cron表達(dá)式來(lái)實(shí)現(xiàn)實(shí)時(shí)修改生效等功能。

1. 首先在數(shù)據(jù)庫(kù)中創(chuàng)建一張用來(lái)記錄定時(shí)任務(wù)的表

CREATE TABLE `scheduled`?(
? `id` bigint NOT NULL AUTO_INCREMENT,
? `name` varchar(255) NULL,
? `cron` varchar(255) NULL,
? PRIMARY KEY (`id`)
)
INSERT INTO `mydb`.`scheduled` (`id`, `name`, `cron`) VALUES (1, '定時(shí)任務(wù)1', '0/6 * * * * ?')

2. 在項(xiàng)目中引入mabatis-plus和mysql相應(yīng)的依賴包

<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.5.3.1</version>
</dependency>
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>8.0.32</version>
</dependency>

3. 在application.yml中進(jìn)行連接數(shù)據(jù)庫(kù)相應(yīng)配置

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb?characterEncoding=utf-8&serverTimeZone=UTC
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

4. 定義查詢cron表達(dá)式的mapper

mapper.CronMapper:

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
@Mapper
public interface CronMapper {
    @Select("select cron from scheduled where id=#{id}")
    String getCron(Long id);
}

5. 實(shí)現(xiàn)定時(shí)任務(wù)

import com.jk.mapper.CronMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
@Component
@EnableScheduling //開(kāi)啟定時(shí)任務(wù)
public class ScheduleTask implements SchedulingConfigurer {
    @Autowired
    private CronMapper cronMapper;
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.addTriggerTask(
                //添加任務(wù)內(nèi)容
                () -> process(),
                //設(shè)置執(zhí)行的周期
                triggerContext -> {
                    //查詢cron表達(dá)式
                    String cron = cronMapper.getCron(1L);
                    if (cron.isEmpty()) {
                        System.out.println("cron is null");
                    }
                    return new CronTrigger(cron).nextExecutionTime(triggerContext);
                });
    }
    private void process() {
        System.out.println("基于接口的定時(shí)任務(wù)");
    }
}

這種方式需要去實(shí)現(xiàn)SchedulingConfigurer接口并重寫(xiě)configureTasks方法，然后設(shè)置任務(wù)內(nèi)容和執(zhí)行周期等，啟動(dòng)測(cè)試就實(shí)現(xiàn)了基于接口的定時(shí)任務(wù)，此時(shí)我們改動(dòng)數(shù)據(jù)庫(kù)里的cron表達(dá)式也會(huì)實(shí)時(shí)生效

三、多線程定時(shí)任務(wù)

但上面的方法定義的定時(shí)任務(wù)會(huì)有個(gè)問(wèn)題，就是如果我一個(gè)定時(shí)任務(wù)里面執(zhí)行了復(fù)雜邏輯，導(dǎo)致本身執(zhí)行花的時(shí)間就已經(jīng)超過(guò)了定時(shí)任務(wù)間隔的時(shí)間怎么辦呢？這時(shí)候定時(shí)任務(wù)的執(zhí)行就會(huì)出現(xiàn)一定的問(wèn)題，具體如下，我用線程睡眠的方式模擬處理復(fù)雜邏輯

import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
@Component
@EnableScheduling //開(kāi)啟定時(shí)任務(wù)
public class ScheduleTask {
    @Scheduled(cron = "0/5 * * * * ?") //定時(shí)任務(wù)注解+cron表達(dá)式
    public void testScheduleTask1() throws InterruptedException {
        System.out.println("執(zhí)行定時(shí)任務(wù)1 " + LocalDateTime.now());
        Thread.sleep(10 * 1000);
    }
    @Scheduled(cron = "0/5 * * * * ?") //定時(shí)任務(wù)注解+cron表達(dá)式
    public void testScheduleTask2() {
        System.out.println("執(zhí)行定時(shí)任務(wù)2 " + LocalDateTime.now());
    }
}

可以看到兩個(gè)任務(wù)的執(zhí)行時(shí)間都被影響了，和我們?cè)O(shè)置的5秒不對(duì)應(yīng)。此時(shí)就可以使用多線程定時(shí)任務(wù)

import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
@Component
@EnableScheduling //開(kāi)啟定時(shí)任務(wù)
@EnableAsync //開(kāi)啟多線程
public class ScheduleTask {
    @Scheduled(cron = "0/5 * * * * ?") //定時(shí)任務(wù)注解+cron表達(dá)式
    @Async
    public void testScheduleTask1() throws InterruptedException {
        System.out.println("執(zhí)行定時(shí)任務(wù)1 " + LocalDateTime.now());
        Thread.sleep(10 * 1000);
    }
    @Scheduled(cron = "0/5 * * * * ?") //定時(shí)任務(wù)注解+cron表達(dá)式
    @Async
    public void testScheduleTask2() {
        System.out.println("執(zhí)行定時(shí)任務(wù)2 " + LocalDateTime.now());
    }
}