Spring @Scheduled 定时任务详解

2024-02-18 05:29:44

引言

定时任务是许多应用中的常见需求，Spring 框架提供了便捷的方式通过 @Scheduled 注解来实现这一功能。本文将深入讲解如何配置和使用 @Scheduled 注解，包括其基本用法、Cron 表达式编写以及触发器元数据的使用。

配置方法

要启用定时任务，需要在Spring应用中添加一个@EnableScheduling注解到至少一个@Configuration类上。这样做会激活一个配置了SchedulerFactoryBean的SchedulingTaskRegistrar。这使得所有的@Scheduled方法可以被执行。

import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableScheduling
public class SchedulerConfig {
}

Cron 表达式

Cron表达式用于定义任务执行的时间表，它由六个字段组成：秒、分钟、小时、日期、月份和星期几。例如，每15分钟运行一次的任务的Cron表达式可以是 0 0/15 * * * ?。

import org.springframework.scheduling.annotation.Scheduled;

@Scheduled(cron = "0 0/15 * * * ?")
public void scheduledTask() {
    // 每隔15分钟执行的定时任务逻辑
}

触发器元数据

Spring提供了Trigger接口来定义更复杂的调度模式，可以通过实现该接口来自定义触发策略。结合@Scheduled注解使用时，可以传递一个自定义的触发器实例。

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.support.CronTrigger;

// 自定义触发器
private CronTrigger cronTrigger = new CronTrigger("0 0/15 * * * ?");

@Scheduled(cron = "0 0/15 * * * ?", zone = "Asia/Shanghai")
public void scheduledTaskWithMetadata() {
    // 根据自定义CronTrigger执行任务
}

典型应用场景

定时发送邮件通知

import org.springframework.scheduling.annotation.Scheduled;
import javax.mail.internet.MimeMessage;

@Scheduled(cron = "0 0 * * * ?")
public void sendDailyEmail() {
    MimeMessage message = mailSender.createMimeMessage();
    // 设置收件人、主题和内容等邮件信息
    mailSender.send(message);
}

数据备份

import org.springframework.scheduling.annotation.Scheduled;

@Scheduled(cron = "0 30 2 * * ?")
public void backupDatabase() {
    // 执行数据备份操作
}

定期清理缓存

import org.springframework.cache.CacheManager;
import org.springframework.scheduling.annotation.Scheduled;

@Autowired
private CacheManager cacheManager;

@Scheduled(cron = "0 0/15 * * * ?")
public void clearCache() {
    for (String cacheName : cacheManager.getCacheNames()) {
        cacheManager.getCache(cacheName).clear();
    }
}

数据同步

import org.springframework.scheduling.annotation.Scheduled;

@Scheduled(cron = "0 5/10 * * * ?")
public void syncData() {
    // 同步数据操作，比如将本地数据库的数据更新到远程服务器的数据库中
}