当前位置：首页 > article >正文

Java定时任务实现方案(四)——Spring Task

article 2025/1/30 22:56:00

Spring Task

这篇笔记，我们要来介绍实现Java定时任务的第四个方案，使用Spring Task，以及该方案的优点和缺点。

Spring Task是Spring框架提供的一个轻量级任务调度框架，用于简化任务调度的开放，通过注解或XML配置的方式，可以轻松实现定时任务、异步任务等功能，我们这里主要介绍它的定时任务。

使用

1.添加依赖

既然要使用Spring框架提供的SpringTask，我们就要引入相关的依赖，同时，我们后面要通过自定义注解+AOP的方式实现任务监听，所以也要引入SpringAop的相关依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
            <version>3.3.0</version>
        </dependency>

2.启用定时任务支持

要使用SpringTask实现定时任务，我们首先要启用定时任务支持，这个我们只需要在Spring应用的启动类上加上@EnableScheduling就可以了。

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

3.配置定时任务注册器

我们可以通过配置类，对SpringTask执行定时任务的调度器进行相关的配置和初始化，并注册到Spring容器中，便于统一管理调度任务。

@Configuration
@EnableScheduling
public class SchedulingConfig implements SchedulingConfigurer {
    /**
     * 配置定时任务处理方式
     *
     * @param taskRegistrar 定时任务注册器，用于管理和调度定时任务
     */
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        // 创建一个线程池任务调度器
        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
        //设置线程池大小
        taskScheduler.setPoolSize(10);
        // 设置线程名称前缀，便于识别和管理
        taskScheduler.setThreadNamePrefix("perform-");
        // 初始化线程池任务调度器
        taskScheduler.initialize();
        // 将任务调度器设置到定时任务注册器中，以便统一管理调度任务
        taskRegistrar.setTaskScheduler(taskScheduler);

    }
}

4.创建定时任务

接着，我们就可以编写定时任务了，这里我们采用注解的形式提供示例。只需要在外面的定时方法上面加上一个@Scheduled注解，Spring容器就可以帮我们实现定时任务了。这个@Scheduled注解可以设置一些参数便于更灵活的调度任务，例如fixedRate参数可以让我们设置间隔多长时间执行一次、initialDelay参数可以设置第一次执行任务前延迟的时间，fixedDelay参数也可以设置每一次延迟多长时间再执行定时任务。同时，该注解还支持使用cron表达式来灵活的设置任务调度的方式。

@Component
@ConditionalOnProperty(prefix = "scheduled",name = "task.enabled",havingValue = "true")//条件注解控制定时任务的启用和禁用
public class ScheduledTask {
    /**
     * 每5s执行一次
     */
    @Scheduled(fixedRate = 5000)
    @TaskListener
    public void performTask1(){
        System.out.println(getTime()+"执行定时任务1");
    }

    /**
     * 每分钟的第10s执行一次
     */
    @Scheduled(cron = "10 * * * * ?")
    @TaskListener
    public void performTask2(){
        System.out.println(getTime()+"执行定时任务2");
    }

    /**
     * 第一次执行任务前的延迟时间1s,后面每隔5s执行一次
     */
    @Scheduled(initialDelay = 1000,fixedDelay = 5000)
    @TaskListener
    public void performTask3(){
        System.out.println(getTime()+"执行定时任务3");
    }
    /**
     * 获取当前系统时间
     * @return
     */
    public static String getTime(){
        //获取当前的系统时间
        LocalDateTime now = LocalDateTime.now();
        //定义时间格式
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        //格式化时间
        return now.format(formatter);
    }
}

这里需要补充的是，我们可以使用条件注解来控制定时任务的启动或禁止。

scheduled:
  task:
    enabled: true

补充知识点:cron表达式

cron表达式是一种用于指定定时任务执行时间的字符串格式，广泛用于Linux系统的cron作业调度器以及各种编程框架中。

一个标准的CRON表达式由6个或7个字段组成(取决于是否包含年份字段)，各字段之间用空格分隔:[秒] [分钟] [小时] [日期] [月份] [星期] [年份] (可选)

各字段的取值范围如下:

字段	范围
秒	0-59
分钟	0-59
小时	0-23
日期	1-31
月份	1-12或JAN-DEC
星期	0-7或SUN-SAT(0和7都表示星期日)
年份	(可选)1970-2099

常见符号说明:

符号	含义
*	表示该字段的所有可能值，例如*在分钟字段表示每分钟
,	分隔多个具体的值，例如1,15表示第1分钟和第15分钟
-	定义一个值范围，例如10-15表示从第10分钟到第15分钟
/	指定增量，例如*/5表示每隔5个单位执行一次
?	用于日期或星期字段，表示不指定明确的值，通常用于其中一个字段时，另一个字段有具体值
L	表示最后一天或最后一个工作日，例如L在日期字段表示每月最后一天。
W	表示最近的工作日，例如15W表示离15号最近的工作日
#	用于星期字段，表示某个月的第几个星期几，例如2#3表示每月的第三个星期二

注意:cron表达式的星期和日期不能同时为具体的值，如果同时指定具体的值，可能会导致逻辑冲突或不明确的行为。

示例:

cron表达式	含义
0 30 * * * ?	每小时第30分钟执行
0 0 2 * * ?	每天凌晨2点执行
0 0 8 ? * MON	每周一的上午8点执行
0 0 0 L * ?	每月的最后一天的午夜执行
0 0/5 * * * ?	每5分钟执行一次

5.通过自定义注解+AOP实现任务监听(可选)

如果需要对定时任务进行监听并做出其他相应的处理的话，我们还可以自己通过自定义注解+AOP的方式实现任务监听器来进行监听处理。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TaskListener {
}

@Component
@Aspect
public class TaskListenerAspect {
    @Before("@annotation(xiaoxin.Timer.SpringTask.TaskListener)")
    public void beforeTask(JoinPoint joinPoint){
        System.out.println("task:"+joinPoint.getSignature().getName()+" 即将开始...");
    }
    @After("@annotation(xiaoxin.Timer.SpringTask.TaskListener)")
    public void afterTask(JoinPoint joinPoint){
        System.out.println("task:"+joinPoint.getSignature().getName()+" 已结束...");
    }
}