logo头像
Snippet 博客主题

Spring Boot 与 Kotlin 定时任务(Scheduling Tasks)

在编写Spring Boot应用中会遇到这样的场景,比如:需要定时地发送一些短信、邮件之类的操作,也可能会定时地检查和监控一些标志、参数等。

创建定时任务

在Spring Boot中编写定时任务是非常简单的事,下面通过实例介绍如何在Spring Boot中创建定时任务,实现每过5秒输出一下当前时间。

在Spring Boot的主类中加入@EnableScheduling注解,启用定时任务的配置

import org.springframework.boot.SpringApplication
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.scheduling.annotation.EnableScheduling
/**
* Created by http://quanke.name on 2018/1/12.
*/
@SpringBootApplication
@EnableScheduling
class Application
fun main(args: Array<String>) {
SpringApplication.run(Application::class.java, *args)
}

创建定时任务实现类

import org.apache.commons.logging.LogFactory
import org.springframework.scheduling.annotation.Scheduled
import org.springframework.stereotype.Component
import java.text.SimpleDateFormat
import java.util.*
/**
* Created by http://quanke.name on 2018/1/12.
*/
@Component
class ScheduledTasks {
val log = LogFactory.getLog(ScheduledTasks::class.java)!!
private val dateFormat = SimpleDateFormat("HH:mm:ss")
@Scheduled(fixedRate = 1000)
fun reportCurrentTime() {
log.info("现在时间 , ${dateFormat.format(Date())}")
}
}

运行程序,控制台中可以看到类似如下输出,定时任务开始正常运作了。

2018-01-21 23:09:01.112 INFO 23832 --- [ main] n.q.kotlin.chaper11_8_1.ApplicationKt : Started ApplicationKt in 8.024 seconds (JVM running for 8.724)
2018-01-21 23:09:02.112 INFO 23832 --- [pool-2-thread-1] n.q.k.chaper11_8_1.task.ScheduledTasks : 现在时间 , 23:09:02
2018-01-21 23:09:03.042 INFO 23832 --- [pool-2-thread-1] n.q.k.chaper11_8_1.task.ScheduledTasks : 现在时间 , 23:09:03
2018-01-21 23:09:04.042 INFO 23832 --- [pool-2-thread-1] n.q.k.chaper11_8_1.task.ScheduledTasks : 现在时间 , 23:09:04
2018-01-21 23:09:05.042 INFO 23832 --- [pool-2-thread-1] n.q.k.chaper11_8_1.task.ScheduledTasks : 现在时间 , 23:09:05

@Scheduled详解

在上面的入门例子中,使用了@Scheduled(fixedRate = 1000) 注解来定义每过1秒执行的任务,对于@Scheduled的使用可以总结如下几种方式:

  • @Scheduled(fixedRate = 1000) :上一次开始执行时间点之后1秒再执行
  • @Scheduled(fixedDelay = 1000) :上一次执行完毕时间点之后1秒再执行
  • @Scheduled(initialDelay=1000, fixedRate=5000) :第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次
  • @Scheduled(cron=”/1 “) :通过cron表达式定义规则

@Scheduled 注解是单线程的,如果需要多线程,请增加@Async

欢迎关注:

《Spring Boot in kotlin 实战》