本指南将指导您完成使用Spring计划任务(即大家常说的定时任务)的步骤。
你将构建一个应用程序,使用Spring的’@ Scheduled’注释每五秒打印一次当前时间。
与大多数Spring 入门指南 一样,您可以从头开始并完成每个步骤,也可以绕过已经熟悉的基本设置步骤。 无论如何,你最终得到工作代码。
要从头开始, 请转到 使用Gradle构建 .
要跳过基本操作,请执行以下操作:
git clone https://github.com/spring-guides/gs-scheduling-tasks.git
gs-scheduling-tasks/initial
当你做完这一切, 你可以根据 gs-scheduling-tasks/complete
中的代码检查结果.
见 使用RESTful Web服务
见 使用RESTful Web服务
完成项目设置后,您可以创建一个计划任务。
src/main/java/hello/ScheduledTasks.java
package hello; import java.text.SimpleDateFormat; import java.util.Date; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; @Component public classScheduledTasks{ private static final Logger log = LoggerFactory.getLogger(ScheduledTasks.class); private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss"); @Scheduled(fixedRate = 5000) publicvoidreportCurrentTime(){ log.info("The time is now {}", dateFormat.format(new Date())); } }
Scheduled
注解定义了一个特定方法在何时运行。 注意:此示例使用 fixedRate
,它指定从每次调用的开始时间开始测量的方法调用之间的间隔。 有 其他选项
,如 fixedDelay
,其中 指定从任务完成起测量的调用之间的间隔。 您还可以
使用 @Scheduled(cron=". . .")
表达式来进行更复杂的任务调度
.
尽管计划任务可以嵌入在Web应用程序和WAR文件中,但下面演示的更简单的方法创建了一个独立的应用程序。 你把一切都包装在一个可执行的JAR文件中,由一个大家初学Java时的Java main()
方法驱动。
src/main/java/hello/Application.java
package hello; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.scheduling.annotation.EnableScheduling; @SpringBootApplication @EnableScheduling public classApplication{ publicstaticvoidmain(String[] args)throwsException{ SpringApplication.run(Application.class); } }
@SpringBootApplication
是一个很方便的注解,查看其源码可以发现添加了以下所有内容:
@Configuration
将类标记为应用程序上下文的bean定义的源。 @EnableAutoConfiguration
告诉Spring Boot根据类路径设置,其他bean和各种属性设置开始添加bean。 @EnableWebMvc
,但是Spring Boot在类路径上看到 spring-webmvc
时会自动添加它。这将应用程序标记为Web应用程序,并激活关键行为,如设置一个“DispatcherServlet”。 @ComponentScan
告诉Spring在 hello
包中寻找其他组件,配置和服务,允许它找到控制器。
main()
方法使用Spring Boot的 SpringApplication.run()
方法来启动应用程序。你注意到没有一行XML?没有 web.xml
文件。这个Web应用程序是100%纯Java,你不必处理配置任何管道或基础设施。
@EnableScheduling
确保创建了后台任务执行器。没有它,鬼知道什么时候运行定时计划任务,更不用说执行了。
您可以使用Gradle或Maven从命令行运行应用程序。 或者,您可以构建单个可执行文件,其中包含所有必需的依赖关系,类和资源,并运行它。 这使得在整个开发生命周期中,易于跨不同环境将服务作为应用程序进行发布,维护版本和部署等等。
如果您使用Gradle,可以使用 ./gradlew bootRun
运行应用程序。 或者你可以使用 ./gradlew build
来构建JAR文件。 然后可以运行JAR文件:
java -jar build/libs/gs-scheduling-tasks-0.1.0.jar
如果您使用Maven,可以使用 ./mvnw spring-boot:run
.运行应用程序。 或者你可以用 ./mvnw clean package
构建JAR文件。 然后可以运行JAR文件:
java -jar target/gs-scheduling-tasks-0.1.0.jar
** | 上面的过程将创建一个可运行的JAR。 您也可以选择 build a classic WAR file |
---|
将显示日志输出,你可以从日志中看到它在后台线程上运行。 你应该会看到你的预定任务每5秒钟触发一次:
[...] 2016-08-25 13:10:00.143 INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:00 2016-08-25 13:10:05.143 INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:05 2016-08-25 13:10:10.143 INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:10 2016-08-25 13:10:15.143 INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:15