Spring Boot 如何实现定时任务

news2025/6/2 15:09:40

Spring Boot 如何实现定时任务

在现代的微服务架构中，定时任务是一个常见的需求。无论是数据定时同步、定时清理缓存，还是定时发送通知，Spring Boot 提供了非常强大且灵活的定时任务支持。本文将详细介绍如何在 Spring Boot 中实现定时任务，包括使用 @Scheduled 注解和集成 Quartz 调度框架的两种方式。

一、使用 `@Scheduled` 注解实现定时任务

Spring Boot 提供了内置的 @Scheduled 注解，可以非常方便地实现简单的定时任务。这种方式适合轻量级的定时任务，且不需要复杂的调度逻辑。

1.1 添加依赖

在 Spring Boot 项目中，@Scheduled 注解是内置支持的，因此不需要额外添加依赖。

1.2 启用定时任务支持

在主类或配置类上添加 @EnableScheduling 注解，启用定时任务支持。

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

@SpringBootApplication
@EnableScheduling
public class MySpringBootApplication {
    public static void main(String[] args) {
        SpringApplication.run(MySpringBootApplication.class, args);
    }
}

1.3 定义定时任务

在任意的 @Component 或 @Service 类中，使用 @Scheduled 注解定义定时任务。

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@Component
public class MyScheduledTasks {

    // 每两小时运行一次
    @Scheduled(cron = "0 0 0/2 * * ?")
    public void runTask() {
        System.out.println("任务执行了！当前时间：" + new java.util.Date());
    }
}

1.4 常见的 Cron 表达式

0 0/30 * * * ?：每30分钟执行一次。
0 0 9-17 * * ?：每天的9点到17点之间，每小时执行一次。
0 0 8,14 * * ?：每天的8点和14点各执行一次。
0 0-5 14 * * ?：在每天14点的第0分钟至第5分钟的每分钟执行一次。
0 0-5 14,18 * * ?：在每天14点和18点的第0分钟至第5分钟的每分钟执行一次。

1.5 注意事项

线程池配置：默认情况下，Spring 的 @Scheduled 使用单线程执行任务。如果任务较多或任务执行时间较长，可能会导致任务延迟。可以通过配置 ThreadPoolTaskExecutor 来指定线程池大小：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

@Configuration
public class SchedulingConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10); // 设置线程池大小
        executor.setThreadNamePrefix("scheduled-task-");
        executor.initialize();
        taskRegistrar.setTaskExecutor(executor);
    }
}

任务执行时间：@Scheduled 的任务执行时间是基于服务器的系统时间，因此需要确保服务器时间准确。

二、使用 Quartz 调度框架实现定时任务

对于更复杂的调度需求，如任务持久化、任务恢复、任务分组等，Quartz 是一个强大的调度框架。Spring Boot 提供了对 Quartz 的集成支持。

2.1 添加依赖

在 pom.xml 文件中添加 Quartz 和 Spring Boot 的集成依赖：

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

2.2 配置 Quartz

在 application.properties 文件中配置 Quartz 的相关参数：

# 配置Quartz的调度器名称
spring.quartz.scheduler.name=myScheduler
# 配置线程池大小
spring.quartz.scheduler.thread-count=10
# 配置任务存储类型为内存
spring.quartz.job-store.type=memory
# 配置任务存储的数据库连接（如果使用数据库存储任务）
# spring.quartz.job-store.driver-class-name=com.mysql.cj.jdbc.Driver
# spring.quartz.job-store.url=jdbc:mysql://localhost:3306/quartz_db
# spring.quartz.job-store.user=root
# spring.quartz.job-store.password=root

2.3 定义任务类

创建一个实现 Job 接口的任务类：

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class MyJob implements Job {
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("任务执行了！当前时间：" + new java.util.Date());
    }
}

2.4 配置任务和触发器

在配置类中定义任务和触发器：

import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class QuartzConfig {

    @Bean
    public JobDetail myJobDetail() {
        return JobBuilder.newJob(MyJob.class)
                .withIdentity("myJob", "group1")
                .build();
    }

    @Bean
    public Trigger myJobTrigger() {
        return TriggerBuilder.newTrigger()
                .withIdentity("myTrigger", "group1")
                .startNow()
                .withSchedule(CronScheduleBuilder.cronSchedule("0 0 0/2 * * ?"))
                .forJob(myJobDetail())
                .build();
    }
}