使用Scheduler

287次阅读

共计 3029 个字符，预计需要花费 8 分钟才能阅读完成。

在很多应用程序中，经常需要执行定时任务。例如，每天或每月给用户发送账户汇总报表，定期检查并发送系统状态报告，等等。

定时任务我们在使用线程池一节中已经讲到了，Java 标准库本身就提供了定时执行任务的功能。在 Spring 中，使用定时任务更简单，不需要手写线程池相关代码，只需要两个注解即可。

我们还是以实际代码为例，建立工程 spring-integration-schedule，无需额外的依赖，我们可以直接在AppConfig 中加上 @EnableScheduling 就开启了定时任务的支持：

@Configuration
@ComponentScan
@EnableWebMvc
@EnableScheduling
@EnableTransactionManagement
@PropertySource({"classpath:/jdbc.properties", "classpath:/task.properties"})
public class AppConfig {...}

接下来，我们可以直接在一个 Bean 中编写一个 public void 无参数方法，然后加上 @Scheduled 注解：

@Component
public class TaskService {final Logger logger = LoggerFactory.getLogger(getClass());

    @Scheduled(initialDelay = 60_000, fixedRate = 60_000)
    public void checkSystemStatusEveryMinute() {logger.info("Start check system status...");
    }
}

上述注解指定了启动延迟 60 秒，并以 60 秒的间隔执行任务。现在，我们直接运行应用程序，就可以在控制台看到定时任务打印的日志：

2020-06-03 18:47:32 INFO  [pool-1-thread-1] c.i.learnjava.service.TaskService - Start check system status...
2020-06-03 18:48:32 INFO  [pool-1-thread-1] c.i.learnjava.service.TaskService - Start check system status...
2020-06-03 18:49:32 INFO  [pool-1-thread-1] c.i.learnjava.service.TaskService - Start check system status...

如果没有看到定时任务的日志，需要检查：

是否忘记了在 AppConfig 中标注@EnableScheduling；
是否忘记了在定时任务的方法所在的 class 标注@Component。

除了可以使用 fixedRate 外，还可以使用fixedDelay，两者的区别我们已经在使用线程池一节中讲过，这里不再重复。

有的童鞋在实际开发中会遇到一个问题，因为 Java 的注解全部是常量，写死了fixedDelay=30000，如果根据实际情况要改成 60 秒怎么办，只能重新编译？

我们可以把定时任务的配置放到配置文件中，例如task.properties：

task.checkDiskSpace=30000

这样就可以随时修改配置文件而无需动代码。但是在代码中，我们需要用 fixedDelayString 取代fixedDelay：

@Component
public class TaskService {
    ...

    @Scheduled(initialDelay = 30_000, fixedDelayString = "${task.checkDiskSpace:30000}")
    public void checkDiskSpaceEveryMinute() {logger.info("Start check disk space...");
    }
}

注意到上述代码的注解参数 fixedDelayString 是一个属性占位符，并配有默认值 30000，Spring 在处理 @Scheduled 注解时，如果遇到String，会根据占位符自动用配置项替换，这样就可以灵活地修改定时任务的配置。

此外，fixedDelayString还可以使用更易读的Duration，例如：

@Scheduled(initialDelay = 30_000, fixedDelayString = "${task.checkDiskSpace:PT2M30S}")

以字符串 PT2M30S 表示的 Duration 就是 2 分 30 秒，请参考 LocalDateTime 一节的 Duration 相关部分。

多个 @Scheduled 方法完全可以放到一个 Bean 中，这样便于统一管理各类定时任务。

还有一类定时任务，它不是简单的重复执行，而是按时间触发，我们把这类任务称为 Cron 任务，例如：

每天凌晨 2:15 执行报表任务；
每个工作日 12:00 执行特定任务；
……

Cron 源自 Unix/Linux 系统自带的 crond 守护进程，以一个简洁的表达式定义任务触发时间。在 Spring 中，也可以使用 Cron 表达式来执行 Cron 任务，在 Spring 中，它的格式是：

秒 分 小时 天 月份 星期 年

年是可以忽略的，通常不写。每天凌晨 2:15 执行的 Cron 表达式就是：

0 15 2 * * *

每个工作日 12:00 执行的 Cron 表达式就是：

0 0 12 * * MON-FRI

每个月 1 号，2 号，3 号和 10 号 12:00 执行的 Cron 表达式就是：

0 0 12 1-3,10 * *

在 Spring 中，我们定义一个每天凌晨 2:15 执行的任务：

@Component
public class TaskService {
    ...

    @Scheduled(cron = "${task.report:0 15 2 * * *}")
    public void cronDailyReport() {logger.info("Start daily report task...");
    }
}

Cron 任务同样可以使用属性占位符，这样修改起来更加方便。

Cron 表达式还可以表达每 10 分钟执行，例如：