[SpringBoot guides系列翻译]调度任务

原文

调度任务

用spring实现一个任务调度。

你将做的

你将做一个应用每5秒钟打印当前时间，用@Scheduled注解。

你需要啥

• 15分钟
• 文本编辑器或者IDE
• JDK1.8+
• Gradle4+或Maven3.2+
• 你可以把代码直接导入到IDE里面

如何完成

选择走Maven的方式

创建目录结构

通过mkdir -p src/main/java/hello创建文件夹。

创建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.5.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>

spring-boot-maven-plugin插件。他提供了很多便捷的特性。

• 把用到的所有依赖打包成一个整体，这样方便服务的执行以及分发。
• 把public static void main()标记成可执行类。
• 提供了内置的依赖解析器用于设置相符的Spring Boot依赖的版本号。

创建一个调度任务

目录src/main/java/hello/ScheduledTasks.java

/*
 * Copyright 2012-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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()));
    }
}

首先是@Component，这个属于Spring里面比较常见的注解。@Service，@Repository，@Controller，都属于@Component，用在特定的地方。他们都会在启动的时候被标记为Spring Bean。Bean可以理解为Spring的骨架，核心的东西。

@Scheduled用来指定特定的方法，例子中用的参数是fixedRate，表示是固定频率，每次执行的开始时间的间隔。其他类似的参数例如fixedDelay用来表示在上一次完成之后下次开始的间隔。你也可以用cron表达式。

启用调度

虽然调度任务可以放在一个war文件的web应用里面，下面用一种更简单的方式。打包成一个单独的jar文件，通过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) {
        SpringApplication.run(Application.class);
    }
}

@SpringBootApplication是一种简写，做了几件事情。

• 自动添加了@Configuration用来标记一个类是bean文件的来源类。
• @EnableAutoConfiguration告诉SpringBoot依据包括classpath的设置，其他bean，各种属性的设置来添加bean。
• 通常来说你需要添加@EableWebMvc用于SpringMvc的应用，但是SpringBoot会帮你自动添加如果在classpath里面看到spring-webmvc的。他会帮你设置DispatcherServlet。
• @ComponentScan告诉Spring去查找hello包里面的组件配置，controller。

main()方法使用SpringBoot的SpringApplication.run()方法来启动一个应用。是的，没有xml。

@EnableScheduling确保创建后台任务执行器。

构建一个可执行的jar

这里通过Maven来执行以及打包

• 执行 mvn spring-boot:run

• 打包成jar文件并执行

  打包：

  mvn clean package

  执行：

  java -jar target/gs-scheduling-tasks-0.1.0.jar

总结

• Maven使用(定义，运行，打包)
• 设置一个SpringBootApplication应用
• EnableScheduling来启用任务调度