调度任务
本指南将引导您完成使用Spring安排任务的步骤。
你会建立什么
您将构建一个应用程序,使用Spring的@Scheduled
注释每五秒打印一次当前时间。
你需要什么
-
大约15分钟
-
最喜欢的文本编辑器或IDE
-
JDK 1.8或更高版本
-
您还可以直接将代码导入到您的IDE中:
如何完成本指南
像大多数Spring 入门指南一样,您可以从头开始并完成每个步骤,也可以绕过已熟悉的基本设置步骤。无论哪种方式,你最终得到工作代码。
要从头开始,请继续阅读使用Gradle构建。
要跳过这些基础知识,请执行以下操作:
-
下载并解压缩本指南的源代码库,或使用Git克隆它:
git clone https://github.com/spring-guides/gs-scheduling-tasks.git
-
cd进入
gs-scheduling-tasks/initial
-
跳转到创建计划任务。
完成后,您可以根据代码检查结果gs-scheduling-tasks/complete
。
用Gradle构建
用Maven构建
创建目录结构
在您选择的项目目录中,创建以下子目录结构; 例如,使用mkdir -p src/main/java/hello
on * nix系统:
└──src └──主 └──java └──你好
pom.xml
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.springframework</groupId> <artifactId>gs-scheduling-tasks</artifactId> <version>0.1.0</version> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.1.RELEASE</version> </parent> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
在春季启动Maven插件提供了许多便捷的功能:
-
它收集类路径上的所有jar,并构建一个可运行的“über-jar”,这使得执行和传输服务更为方便。
-
它搜索
public static void main()
标记为可运行类的方法。 -
它提供了一个内置的依赖关系解析器,用于设置版本号以匹配Spring Boot依赖关系。你可以覆盖你想要的任何版本,但是它会默认使用Boot的选择版本。
用您的IDE构建
创建一个计划任务
现在您已经设置了项目,您可以创建一个计划任务。
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 class ScheduledTasks { private static final Logger log = LoggerFactory.getLogger(ScheduledTasks.class); private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss"); @Scheduled(fixedRate = 5000) public void reportCurrentTime() { log.info("The time is now {}", dateFormat.format(new Date())); } }
在Scheduled
当特定的方法运行注解定义。注意:此示例使用fixedRate
,它指定从每次调用的开始时间开始测量的方法调用之间的时间间隔。还有其他选项,例如fixedDelay
,它指定了从完成任务开始测量的调用之间的时间间隔。您还可以使用@Scheduled(cron=". . .")
表达式进行更复杂的任务调度。
启用计划
虽然计划任务可以嵌入到Web应用程序和WAR文件中,但下面演示的更简单的方法会创建一个独立的应用程序。您将所有内容都打包在一个单独的,可执行的JAR文件中,并由一个优秀的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 class Application { public static void main(String[] args) throws Exception { SpringApplication.run(Application.class); } }
@SpringBootApplication
是一个方便的注释,它增加了以下所有内容:
-
@Configuration
将该类标记为应用程序上下文的bean定义的来源。 -
@EnableAutoConfiguration
告诉Spring Boot开始添加基于类路径设置,其他bean和各种属性设置的bean。 -
通常你会添加
@EnableWebMvc
一个Spring MVC应用程序,但Spring Boot会在类路径中看到spring-webmvc时自动添加它。这将该应用程序标记为Web应用程序并激活关键行为,例如设置一个DispatcherServlet
。 -
@ComponentScan
告诉Spring在包中查找其他组件,配置和服务hello
,以便找到控制器。
该main()
方法使用Spring Boot的SpringApplication.run()
方法启动应用程序。你有没有注意到没有一行XML?没有web.xml文件。这个Web应用程序是100%纯Java,您不必处理配置任何管道或基础设施。
@EnableScheduling
确保创建后台任务执行程序。没有它,没有任何计划。
构建一个可执行的JAR
您可以使用Gradle或Maven从命令行运行应用程序。或者您可以构建一个包含所有必需的依赖项,类和资源的可执行JAR文件,并运行该文件。这使得在整个开发生命周期内跨越不同环境等,将服务作为应用程序发布,版本化和部署变得非常容易。
如果您正在使用Gradle,则可以使用运行该应用程序./gradlew bootRun
。或者你可以使用构建JAR文件./gradlew build
。然后你可以运行JAR文件:
如果你正在使用Maven,你可以使用运行该应用程序./mvnw spring-boot:run
。或者您可以使用构建JAR文件./mvnw clean package
。然后你可以运行JAR文件:
上述过程将创建一个可运行的JAR。您也可以选择构建经典的WAR文件。 |
记录输出显示,您可以从日志中看到它在后台线程上。你应该看到你的计划任务每5秒触发一次:
[...] 2016-08-25 13:10:00.143信息31565 --- [pool-1-thread-1] hello.ScheduledTasks:现在是13:10:00 2016-08-25 13:10:05.143信息31565 --- [pool-1-thread-1] hello.ScheduledTasks:现在的时间是13:10:05 2016-08-25 13:10:10.143信息31565 --- [pool-1-thread-1] hello.ScheduledTasks:现在是13:10:10 2016-08-25 13:10:15.143信息31565 --- [pool-1-thread-1] hello.ScheduledTasks:现在是13:10:15
概要
恭喜!您使用计划任务创建了一个应用程序。哎呀,实际的代码比构建文件更短!这种技术适用于任何类型的应用程序。