Spring的@schedule註解實現定時任務
阿新 • • 發佈：2018-11-30
專案經常會用到定時任務，實現定時任務的方式有很多種。在Spring框架中，實現定時任務很簡單，常用的實現方式是使用註解@Schedule。
@Schedule 常用來實現簡單的定時任務。例如凌晨1點跑批，每1小時更新訂單狀態等
非SpringBoot專案
在springmvc-servlet.xml中新增配置
<!-- xmlns加入 --> xmlns:task="http://www.springframework.org/schema/task" <!-- xsi:schemaLocation中加入 --> http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd" <!-- 定時任務掃描配置 --> <!-- 方式一： --> <task:executorid="executor" pool-size="5" /> <task:schedulerid="scheduler" pool-size="10" /> <task:annotation-drivenexecutor="executor" scheduler="scheduler" /> <!-- 方式二：--> <task:annotation-driven scheduler="scheduler" mode="proxy"/> <task:scheduler id="scheduler" pool-size="10"/>
例
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:task="http://www.springframework.org/schema/task" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/jdbc/spring-jdbc-3.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd" default-lazy-init="false"> <context:annotation-config /> <!— spring掃描註解的配置 --> <context:component-scan base-package="com.it.mytask" /> <!—開啟這個配置，spring才能識別@Scheduled註解 --> <task:annotation-driven scheduler="scheduler" mode="proxy"/> <task:scheduler id="scheduler" pool-size="10"/>
SpringBoot專案
官網給出簡單的例子
具體的任務類
@Component
public class ScheduleTask {
// 每隔5秒執行一次
@Scheduled(cron = "0/5 * * * * ?")
public void printSay() {
System.out.println("每隔5秒執行一次：" + new Date());
}
}
Application：
@SpringBootApplication @EnableScheduling // 在spring boot的入口類Application.java中，允許支援schedule public class Application { public static void main(String[] args) throws Exception { SpringApplication.run(Application.class); } }
結果
@Scheduled原始碼
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@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 "";
}
案例
package com.task;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
public class ScheduledTask {
private Logger logger= LoggerFactory.getLogger(ScheduledTask.class);
// fixedRate = 5000表示每隔5秒，Spring scheduling會呼叫一次該方法，不論該方法的執行時間是多少
@Scheduled(fixedRate = 5000)
public void task() {
logger.info("每隔5秒執行一次");
}
// fixedDelay = 5000表示當方法執行完畢5秒後，Spring scheduling會再次呼叫該方法
@Scheduled(fixedDelay = 5000)
public void taskAfter() {
logger.info("當方法執行完畢5秒後執行");
}
// cron = "*/5 * * * * * *" 通用的定時任務表示式，表示每隔5秒執行一次
@Scheduled(cron = "*/5 * * * * *")
public void taskCron() {
logger.info("每隔5秒執行一次");
}
}
cron 表示式
- cron一共有7位，但是最後一位是年（1970－2099），可以留空，所以我們可以寫6位,按順序依次為
- 秒（0~59）
- 分鐘（0~59）
- 小時（0~23）
- 天（月）（0~31，但是你需要考慮你月的天數）
- 月（0~11）
- 星期（1~7 1=SUN，MON，TUE，WED，THU，FRI，SAT）
- cron的一些特殊符號
- (*)星號：
可以理解為每的意思，每秒，每分，每天，每月，每年… - (?)問號：
問號只能出現在日期和星期這兩個位置，表示這個位置的值不確定，每天3點執行，所以第六位星期的位置，我們是不需要關注的，就是不確定的值。同時：日期和星期是兩個相互排斥的元素，通過問號來表明不指定值。比如，1月10日，比如是星期1，如果在星期的位置是另指定星期二，就前後衝突矛盾了。 - (-)減號：
表達一個範圍，如在小時欄位中使用“10-12”，則表示從10到12點，即10,11,12 - (,)逗號：
表達一個列表值，如在星期欄位中使用“1,2,4”，則表示星期一，星期二，星期四
(/)斜槓：如：x/y，x是開始值，y是步長，比如在第一位（秒） 0/15就是，從0秒開始，每15秒，最後就是0，15，30，45，60 另：*/y，等同於0/y
eg.下面列舉幾個例子供大家來驗證：
0 0 3 * * ? 每天3點執行
0 5 3 * * ? 每天3點5分執行
0 5 3 ? * * 每天3點5分執行，與上面作用相同
0 5/10 3 * * ? 每天3點的 5分，15分，25分，35分，45分，55分這幾個時間點執行
0 10 3 ? * 1 每週星期天，3點10分 執行，注：1表示星期天
0 10 3 ? * 1#3 每個月的第三個星期，星期天 執行，#號只能出現在星期的位置
常用示例:
格式: [秒] [分] [小時] [日] [月] [周] [年]
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分每分觸發
0 0/5 14 * * ? 每天下午的 2點到2點59分(整點開始，每隔5分觸發)
0 0/5 14,18 * * ? 每天下午的 18點到18點59分(整點開始，每隔5分觸發)
0 0-5 14 * * ? 每天下午的 2點到2點05分每分觸發
0 10,44 14 ? 3 WED 3月分每週三下午的 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 每月的第三週的星期五開始觸發
0 0 12 1/5 * ? 每月的第一個中午開始每隔5天觸發一次
0 11 11 11 11 ? 每年的11月11號 11點11分觸發(光棍節)