SpringBoot实战(二)之计划任务

计划任务这个对于Java开发者们，应该不陌生了，非常常用又非常常见。比如jdk自带的Timer

实现例子如下:

class MyTask extends TimerTask{
    @Override
    public void run() {
        System.out.println("hello world");
    }
}
public class TimerDemo {
    public static void main(String[] args) {
        //创建定时器对象
        Timer t=new Timer();
        //在3秒后执行MyTask类中的run方法,后面每10秒跑一次
        t.schedule(new MyTask(), 3000,10000);

    }
}

或者是Spring中的定时任务

  @Scheduled(cron = "0 0/1 * * * ? ")
    public void test() {
        MonitorUrl.testUrlWithTimeOut2018("http://www.test.com:2018/", 2000);
        logger.info("每分钟执行" + System.currentTimeMillis());
    }

关于Spring中的定时任务如何使用，可以参考我的这篇博客:Spring定时任务使用和如何使用邮件监控服务器

 环境为：JDK8+MAVEN3+Eclipse

下面演示SpringBoot的定时任务，总的来说与上面这些没有什么区别。

一、maven依赖

<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>cn.springboot</groupId>
  <artifactId>springboot002</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.8.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>

二、编写定时任务类

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=". . .")表达式进行更复杂的任务调度。

 

在这里顺便说说@Component注解，这个注解的意思可理解为扫描

与在对应的配置文件中配置
<bean id="" class=""/>是一样的。

这里配置bean意思相当于将这个对象实例化到Spring容器中进行管理。
   

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(cron = "0 0/1 * * * ? ")
    public void reportCurrentTime() {
        log.info("The time is now {}", dateFormat.format(new Date()));
    }
}

cron表达式和Linux中的cron基本一致，并无差别要说差别的话，一个是Java的类库，一个是Linux系统自带的系统软件。

cron是表达式，表示在什么时候进行任务调度。

对于cron表达式的解释如下：

一个cron表达式有至少6个（也可能7个）有空格分隔的时间元素。 
按顺序依次为 
秒（0~59） 
分钟（0~59） 
小时（0~23） 
天（月）（0~31，但是你需要考虑你月的天数） 
月（0~11） 
天（星期）（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，FRI，SAT） 
年份（1970－2099）

其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于”月份中的日期”和”星期中的日期”这两个元素互斥的,必须要对其中一个设置?.

“0 0 10,14,16 * * ?” 每天上午10点，下午2点，4点 
“0 0/30 9-17 * * ?” 朝九晚五工作时间内每半小时 
“0 0 12 ? * WED” 表示每个星期三中午12点 
“0 0 12 * * ?” 每天中午12点触发 
“0 15 10 ? * *” 每天上午10:15触发 
“0 15 10 * * ?” 每天上午10:15触发 
“0 15 10 * * ? *” 每天上午10:15触发 
“0 15 10 * * ? 2005” 2005年的每天上午10:15触发 
“0 * 14 * * ?” 在每天下午2点到下午2:59期间的每1分钟触发 
“0 0/5 14 * * ?” 在每天下午2点到下午2:55期间的每5分钟触发 
“0 0/5 14,18 * * ?” 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发 
“0 0-5 14 * * ?” 在每天下午2点到下午2:05期间的每1分钟触发 
“0 10,44 14 ? 3 WED” 每年三月的星期三的下午2:10和2:44触发 
“0 15 10 ? * MON-FRI” 周一至周五的上午10:15触发 
“0 15 10 15 * ?” 每月15日上午10:15触发 
“0 15 10 L * ?” 每月最后一日的上午10:15触发 
“0 15 10 ? * 6L” 每月的最后一个星期五上午10:15触发 
“0 15 10 ? * 6L 2002-2005” 2002年至2005年的每月的最后一个星期五上午10:15触发 
“0 15 10 ? * 6#3” 每月的第三个星期五上午10:15触发

有些子表达式能包含一些范围或列表

例如：子表达式（天（星期） ）可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT” 
“*”字符代表所有可能的值

因此，“”在子表达式（月 ）里表示每个月的含义，“”在子表达式（天（星期） ）表示星期的每一天 
“/”字符用来指定数值的增量

例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟 
在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样 
“？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值

当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？” 
“L” 字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写

但是它在两个子表达式里的含义是不同的。

在天（月）子表达式中，“L”表示一个月的最后一天

在天（星期）自表达式中，“L”表示一个星期的最后一天，也就是SAT

如果在“L”前有具体的内容，它就具有其他的含义了

例如：“6L”表示这个月的倒数第６天，“ＦＲＩＬ”表示这个月的最一个星期五

注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题

字段 允许值 允许的特殊字符

秒 0-59 , - * /

分 0-59 , - * /

小时 0-23 , - * /

日期 1-31 , - * ? / L W C

月份 1-12 或者 JAN-DEC , - * /

星期 1-7 或者 SUN-SAT , - * ? / L C #

年（可选） 留空, 1970-2099 , - * /

三、编写启动类

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

 @ComponentScan告诉Spring在包中寻找其他组件，配置和服务hello，允许它找到控制器。

与上述@Component结合 就可以保证我配置bean，从而让@ComponentScan，@ComponentScan顾名思义，即扫描组件，也就是扫描bean

这样就可以保证加上@Component注解的Java类被扫描到，从而初始化，从而执行对应的定时任务。

@EnableScheduling

要实现计划任务，首先通过在配置类注解@EnableScheduling来开启对计划任务的支持，然后在要执行计划任务的方法上注解@Scheduled，声明这是一个计划任务。