[Spring]@Scheduled定时任务

[Spring]@Scheduled定时任务

package org.springframework.scheduling.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// ElementType 这个枚举类型的常量提供了一个简单的分类：注释可能出现在Java程序中的语法位置（这些常量与元注释类型(@Target)一起指定在何处写入注释的合法位置）
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
// RetentionPolicy这个枚举类型的常量描述保留注释的各种策略，它们与元注释(@Retention)一起指定注释要保留多长时间
@Retention(RetentionPolicy.RUNTIME)
// Documented注解表明这个注释是由 javadoc记录的，在默认情况下也有类似的记录工具。 如果一个类型声明被注释了文档化，它的注释成为公共API的一部分。
@Documented
// @Repeatable 注解是用于声明其它类型注解的元注解，来表示这个声明的注解是可重复的。@Repeatable的值是另一个注解，其可以通过这个另一个注解的值来包含这个可重复的注解。
@Repeatable(Schedules.class)
public @interface Scheduled {
    String cron() default "";

    String zone() default "";

    long fixedDelay() default -1L;

    String fixedDelayString() default "";

    long fixedRate() default -1L;

    String fixedRateString() default "";

    long initialDelay() default -1L;

    String initialDelayString() default "";
}

Spring Boot中@Scheduled注解的使用方法
一、定时任务注解为@Scheduled，使用方式举例如下

//定义一个按时间执行的定时任务，在每天16:00执行一次。
@Scheduled(cron = "0 0 16 * * ?")
public void depositJob() {
  //执行代码
}
//定义一个按一定频率执行的定时任务，每隔1分钟执行一次
@Scheduled(fixedRate = 1000 * 60)
public void job2() {
//执行代码
}
//定义一个按一定频率执行的定时任务，每隔1分钟执行一次，延迟1秒执行
@Scheduled(fixedRate = 1000 * 60,initialDelay = 1000)
public void updatePayRecords() {
//执行代码
}

对于fixedRate属性来说，它接受的是一个Long类型的参数，该数值的单位是毫秒（1000毫秒=1秒）。
二、@Scheduled代码执行原理说明
简要介绍：spring在初始化bean后，通过“postProcessAfterInitialization”拦截到所有的用到“@Scheduled”注解的方法，并解析相应的的注解参数，放入“定时任务列表”等待后续处理；之后再“定时任务列表”中统一执行相应的定时任务（任务为顺序执行，先执行cron，之后再执行fixedRate）。
三、再介绍一下fixedRate和fixedDelay和cron的区别
注解@Scheduled 可以作为一个触发源添加到一个方法中，例如，以下的方法将以一个固定延迟时间5秒钟调用一次执行，这个周期是以上一个调用任务的完成时间为基准，在上一个任务完成之后，5s后再次执行：·

@Scheduled(fixedDelay=5000)
public void doSomething() {    
    // something that should execute periodically
}

如果需要以固定速率执行，只要将注解中指定的属性名称改成fixedRate即可，以下方法将以一个固定速率5s来调用一次执行，这个周期是以上一个任务开始时间为基准，从上一任务开始执行后5s再次调用：

@Scheduled(fixedRate=5000)
public void doSomething() {
    // something that should execute periodically
}

对于固定延迟和固定速率的任务，可以指定一个初始延迟表示该方法在第一被调用执行之前等待的毫秒数：

@Scheduled(initialDelay=1000, fixedRate=5000)
public void doSomething() {    
    // something that should execute periodically
}

如果简单的定期调度不能满足，那么cron表达式提供了可能。例如，下面的方法将只会在工作日执行：

@Scheduled(cron="*/5 * * * * MON-FRI")
public void doSomething() {    
   // something that should execute on weekdays only
}

还可以通过使用zone属性来指定cron表达式被调用的时区。

注意：
1、spring的注解@Scheduled 需要写在实现方法上；
2、定时器的任务方法不能有返回值（如果有返回值，spring初始化的时候会告诉你有个错误、需要设定一个proxytargetclass的某个值为true），不能指向任何的参数；
3、如果该方法需要与应用程序上下文的其他对象进行交互，通常是通过依赖注入来实现；
4、实现类上要有组件的注解@Component。