SpringTask定时任务笔记

1 简介

Spring Task 是 Spring 框架中用于调度和管理定时任务的模块。它提供了简单、灵活且强大的任务调度功能，可以帮助开发者在应用程序中轻松实现任务的自动执行。
Spring Task 常用于以下场景：

• 定时任务：如定时生成报告、清理临时文件、发送邮件提醒等。
• 异步任务：可以在应用程序主线程之外执行一些异步任务，不会阻塞主线程。
• 周期性任务：周期性地执行某些操作，如定期同步数据、监控系统状态等。

优点：

• 易用性：通过简单的注解即可配置定时任务，无需编写复杂的代码。
• 灵活性：支持多种任务调度方式，灵活满足不同需求。
• 集成性：与 Spring 生态系统的其他组件紧密集成，如 Spring Boot、Spring Data 等，易于在现有项目中添加。

2 主要功能

2.1 @Scheduled注解

Spring Task 中最常用的功能，它允许开发者在方法上定义定时任务。通过配置不同的属性，可以实现多种调度方式。

Cron表达式

使用 Cron 表达式来指定任务的执行时间。Cron 表达式由 6 或 7 个字段组成，表示秒、分、小时、日、月、星期、年（可选）。例如：

@Scheduled(cron = "0 0 * * * ?")
public void hourlyTask() {
    // 每小时执行一次的任务
}

上述表达式表示每小时的整点执行任务。cron表达式其实就是一个字符串，通过cron表达式可以定义任务触发的时间。
**构成规则：**分为6或7个域，由空格分隔开，每个域代表一个含义，分别为：秒、分钟、小时、日、月、周、年(可选)
举例：2022年10月12日上午9点整 对应的cron表达式为：0 0 9 12 10 ? 2022
说明：一般日和周的值不同时设置，其中一个设置，另一个用 ？表示。
**比如：**描述2月份的最后一天，最后一天具体是几号呢？可能是28号，也有可能是29号，所以就不能写具体数字。为了描述这些信息，提供一些特殊的字符。这些具体的细节，我们就不用自己去手写，因为这个cron表达式，它其实有在线生成器：https://cron.qqe2.com/。可以直接在这个网站上面，只要根据自己的要求去生成corn表达式即可。

1）corn 表达式常用通配符

1. * 表示所有值；
2. ? 表示未说明的值，即不关心它为何值；
3. - 表示一个指定的范围；
4. , 表示附加一个可能值；
5. / 符号前表示开始时间，符号后表示每次递增的值；

2）corn 表达式常用的案例

1. */5 * * * * ? 每隔5秒执行一次
2. 0 */1 * * * ? 每隔1分钟执行一次
3. 0 0 5-15 * * ? 每天5-15点整点触发
4. 0 0/3 * * * ? 每三分钟触发一次
5. 0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发
6. 0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发
7. 0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
8. 0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
9. 0 0 10,14,16 * * ? 每天上午10点，下午2点，4点

固定频率执行

fixedRate属性用于以固定的速率（单位：ms）执行任务， 任务之间的间隔时间是固定的，而不管任务本身的执行时间。

@Scheduled(fixedRate = 5000)
public void fixedRateTask() {
    // 每5秒执行一次的任务
}

固定延迟执行

fixedDelay属性表示在上一个任务完成后，经过固定的延迟时间再执行下一个任务。

@Scheduled(fixedDelay = 5000)
public void fixedDelayTask() {
    // 上一次任务完成后，延迟5秒再执行
}

初始延迟

initialDelay属性可以与fixedRate或fixedDelay一起使用，表示任务启动时的初始延迟。

@Scheduled(initialDelay = 10000, fixedRate = 5000)
public void initialDelayTask() {
    // 在应用启动10秒后开始，每5秒执行一次
}

2.2 TaskScheduler接口

TaskScheduler 接口是 Spring Task 提供的底层调度接口，它允许开发者更灵活地管理任务调度。TaskScheduler 的实现类能够处理多种调度任务，并且可以通过编程的方式进行复杂的调度配置。

常用的实现类

ThreadPoolTaskScheduler：这个实现类可以使用线程池来处理并发任务。它可以同时执行多个任务，并且可以根据需求配置线程池的大小。

@Bean
public TaskScheduler taskScheduler() {
    ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
    scheduler.setPoolSize(10);
    scheduler.setThreadNamePrefix("scheduled-task-");
    return scheduler;
}

ConcurrentTaskScheduler：这个实现类可以将任务委派给 java.util.concurrent.ScheduledExecutorService，适用于简单的并发任务调度。

编程方式调度任务

可以使用 TaskScheduler 进行编程式调度。例如，调度一个任务在指定的时间点执行：

@Autowired
private TaskScheduler taskScheduler;

public void scheduleTaskWithFixedRate() {
    taskScheduler.scheduleAtFixedRate(() -> {
        // 任务执行逻辑
    }, 5000);
}

2.3 TaskExecutor 接口

TaskExecutor 是 Spring 框架提供的一个通用接口，用于处理异步任务。它与 TaskScheduler 不同，TaskExecutor 侧重于任务的异步执行而非调度。

常用实现类

SimpleAsyncTaskExecutor：这个实现类不使用实际的线程池，每次调用时都会启动一个新的线程。适用于轻量级的任务。
ThreadPoolTaskExecutor：这个实现类基于 Java 的 ThreadPoolExecutor，可以管理一个线程池并处理并发任务。通常用于需要处理大量并发任务的场景。

@Bean
public TaskExecutor taskExecutor() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setCorePoolSize(5);
    executor.setMaxPoolSize(10);
    executor.setQueueCapacity(25);
    executor.setThreadNamePrefix("async-task-");
    executor.initialize();
    return executor;
}

异步任务执行

在需要异步执行的任务上添加 @Async 注解，并且配置好 TaskExecutor 即可。例如：

@Async
public void asyncMethod() {
    // 这是一个异步执行的方法
}

2.4 @EnableScheduling 注解

@EnableScheduling 是一个简单但至关重要的注解，用于启用 Spring 的调度任务功能。只需在 Spring 配置类上添加此注解，即可扫描并自动启用所有使用 @Scheduled 注解的任务。

@Configuration
@EnableScheduling
public class AppConfig {
    // 其他 Bean 配置
}

通过上述的 @Scheduled 注解、TaskScheduler 接口、TaskExecutor 接口和 @EnableScheduling 注解，Spring Task 提供了一个非常灵活和强大的定时任务调度框架。可以根据具体需求选择合适的工具和配置方式来实现定时任务和异步任务的管理。

3 定时任务简单示例

3.1 效果展示

3.2 基本步骤

1）创建 SpringBoot 项目

2）启动类上添加开启定时任务的注解

3）模拟一个在线时长统计类开始定时任务

使用日志配合控制台输出，查看结果，每隔 5 秒就会输出一条日志。见上图。

@Component
@Slf4j
public class TimeTaskDemo {

    private static int onlineTime = 0; // 模拟在线时长的累加 静态变量

    @Scheduled(cron = "0/5 * * * * ?")
    public void increaseOnlineDay() {
        onlineTime++;
        log.info("定时任务开始，累加上线时长————{}", onlineTime);
    }
}