Java Spring分別實現定時任務方法
java實現定時任務
Jdk自帶的庫中,有兩種方式可以實現定時任務,一種是Timer
,另一種是ScheduledThreadPoolExecutor
。
Timer+TimerTask
創建一個Timer
就創建瞭一個線程,可以用來調度TimerTask
任務
Timer
有四個構造方法,可以指定Timer
線程的名字以及是否設置為為守護線程。默認名字Timer-編號
,默認不是守護線程。
主要有三個比較重要的方法:
cancel()
:終止任務調度,取消當前調度的所有任務,正在運行的任務不受影響
purge()
:從任務隊列中移除所有已經取消的任務
schedule
:開始調度任務,提供瞭幾個重載方法:
schedule(TimerTask task, long delay)
延時執行,表示delay
毫秒後執行一次task
任務
schedule(TimerTask task, Date time)`指定時間執行,到`time`時間的時候執行一次`task
schedule(TimerTask task, long delay, long period)`延時周期執行,經過`delay`毫秒後每`period`毫秒執行一次`task
schedule(TimerTask task, Date firstTime, long period)`指定時間後周期執行,到達指定時間`firstTime`後每`period`毫秒執行一次`task
示例
public class TimerTest { public static void main(String[] args) { Timer timer = new Timer("aa"); Task task = new Task(); timer.schedule(task,new Date(),1000); } } class Task extends TimerTask{ @Override public void run() { System.out.println(new Date()); } }
輸出:
Thu Jul 07 14:50:02 CST 2022
Thu Jul 07 14:50:03 CST 2022
Thu Jul 07 14:50:04 CST 2022
Thu Jul 07 14:50:05 CST 2022
…………
弊端
Timer是單線程的,並且不會拋出異常,一旦定時任務拋出異常,將會導致整個線程停止,即定時任務停止。
ScheduledThreadPoolExecutor
因為Timer
的缺陷,所以不建議使用Timer
,建議使用ScheduledThreadPoolExecutor
。
ScheduledThreadPoolExecutor
是Timer
的替代者,於JDK1.5引入,繼承瞭ThreadPoolExecutor
,是基於線程池設計的定時任務類。
主要的調度方法:
schedule
隻執行一次調度,(任務,延遲時間,延遲時間單位)
scheduleAtFixedRate
按固定的頻率調度,如果執行時間過長,下次調度會延遲,(任務,第一次執行的延遲時間,周期,時間單位)
scheduleWithFixedDelay
延遲調度,一次任務執行完後加上延遲時間執行下一次任務,(任務,第一次執行的延遲時間,間隔時間,時間單位)
示例
public class TimerTest { public static void main(String[] args) throws Exception{ ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(10); scheduledExecutorService.scheduleAtFixedRate( () -> System.out.println(new Date()), 1,3, TimeUnit.SECONDS); } }
Spring定時任務
Spring定時任務主要靠@Scheduled
註解實現,corn,fixedDelay,fixedDelayString,fixedRate,fixedRateString
五個參數必須指定其一,傳兩個或三個都會拋出異常
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Repeatable(Schedules.class) public @interface Scheduled { String CRON_DISABLED = ScheduledTaskRegistrar.CRON_DISABLED; // cron表達式 String cron() default ""; // 時區 String zone() default ""; // 從上一次調用結束到下一次調用之間的固定時間 long fixedDelay() default -1; // 和fixedDelay意思相同,隻是使用字符傳格式,支持占位符。例如:fixedDelayString = "${time.fixedDelay}" String fixedDelayString() default ""; // 兩次調用之間固定的毫秒數(不需要等待上次任務完成) long fixedRate() default -1; // 同上,支持占位符 String fixedRateString() default ""; // 第一次執行任務前延遲的毫秒數 long initialDelay() default -1; // 同上,支持占位符 String initialDelayString() default ""; }
示例
@Component @EnableScheduling public class ScheduledTask { @Scheduled(fixedDelay = 1000) public void task(){ System.out.println("aaa"); } }
原理
項目啟動ScheduledAnnotationBeanPostProcessor
的postProcessAfterInitialization()
方法掃描帶有@Scheduled
註解的方法:
@Override public Object postProcessAfterInitialization(Object bean, String beanName) { if (bean instanceof AopInfrastructureBean || bean instanceof TaskScheduler || bean instanceof ScheduledExecutorService) { // Ignore AOP infrastructure such as scoped proxies. return bean; } Class<?> targetClass = AopProxyUtils.ultimateTargetClass(bean); if (!this.nonAnnotatedClasses.contains(targetClass) && AnnotationUtils.isCandidateClass(targetClass, Arrays.asList(Scheduled.class, Schedules.class))) { Map<Method, Set<Scheduled>> annotatedMethods = MethodIntrospector.selectMethods(targetClass, (MethodIntrospector.MetadataLookup<Set<Scheduled>>) method -> { Set<Scheduled> scheduledMethods = AnnotatedElementUtils.getMergedRepeatableAnnotations( method, Scheduled.class, Schedules.class); return (!scheduledMethods.isEmpty() ? scheduledMethods : null); }); if (annotatedMethods.isEmpty()) { this.nonAnnotatedClasses.add(targetClass); if (logger.isTraceEnabled()) { logger.trace("No @Scheduled annotations found on bean class: " + targetClass); } } else { // Non-empty set of methods annotatedMethods.forEach((method, scheduledMethods) -> // 調用processScheduled方法將定時任務的方法存放到任務隊列中 scheduledMethods.forEach(scheduled -> processScheduled(scheduled, method, bean))); if (logger.isTraceEnabled()) { logger.trace(annotatedMethods.size() + " @Scheduled methods processed on bean '" + beanName + "': " + annotatedMethods); } } } return bean; }
protected void processScheduled(Scheduled scheduled, Method method, Object bean) { try { // 創建任務線程 Runnable runnable = createRunnable(bean, method); // 解析到定時任務方式的標記,解析到正確的參數後會設置為TRUE,如果在解析到瞭其他的參數就會拋出異常 boolean processedSchedule = false; String errorMessage = "Exactly one of the 'cron', 'fixedDelay(String)', or 'fixedRate(String)' attributes is required"; Set<ScheduledTask> tasks = new LinkedHashSet<>(4); // Determine initial delay 解析第一次的延遲(解析initialDelay參數) long initialDelay = scheduled.initialDelay(); String initialDelayString = scheduled.initialDelayString(); if (StringUtils.hasText(initialDelayString)) { // initialDelay不能小於0 Assert.isTrue(initialDelay < 0, "Specify 'initialDelay' or 'initialDelayString', not both"); if (this.embeddedValueResolver != null) { initialDelayString = this.embeddedValueResolver.resolveStringValue(initialDelayString); } if (StringUtils.hasLength(initialDelayString)) { try { initialDelay = parseDelayAsLong(initialDelayString); } catch (RuntimeException ex) { throw new IllegalArgumentException( "Invalid initialDelayString value \"" + initialDelayString + "\" - cannot parse into long"); } } } // Check cron expression 解析cron表達式 String cron = scheduled.cron(); if (StringUtils.hasText(cron)) { // 解析時區 String zone = scheduled.zone(); if (this.embeddedValueResolver != null) { cron = this.embeddedValueResolver.resolveStringValue(cron); zone = this.embeddedValueResolver.resolveStringValue(zone); } if (StringUtils.hasLength(cron)) { Assert.isTrue(initialDelay == -1, "'initialDelay' not supported for cron triggers"); processedSchedule = true; if (!Scheduled.CRON_DISABLED.equals(cron)) { TimeZone timeZone; if (StringUtils.hasText(zone)) { timeZone = StringUtils.parseTimeZoneString(zone); } else { timeZone = TimeZone.getDefault(); } tasks.add(this.registrar.scheduleCronTask(new CronTask(runnable, new CronTrigger(cron, timeZone)))); } } } // 第一次延遲參數小於0,默認為0 // At this point we don't need to differentiate between initial delay set or not anymore if (initialDelay < 0) { initialDelay = 0; } // Check fixed delay 解析fixedDelay參數 long fixedDelay = scheduled.fixedDelay(); if (fixedDelay >= 0) { Assert.isTrue(!processedSchedule, errorMessage); processedSchedule = true; tasks.add(this.registrar.scheduleFixedDelayTask(new FixedDelayTask(runnable, fixedDelay, initialDelay))); } String fixedDelayString = scheduled.fixedDelayString(); if (StringUtils.hasText(fixedDelayString)) { if (this.embeddedValueResolver != null) { fixedDelayString = this.embeddedValueResolver.resolveStringValue(fixedDelayString); } if (StringUtils.hasLength(fixedDelayString)) { Assert.isTrue(!processedSchedule, errorMessage); processedSchedule = true; try { fixedDelay = parseDelayAsLong(fixedDelayString); } catch (RuntimeException ex) { throw new IllegalArgumentException( "Invalid fixedDelayString value \"" + fixedDelayString + "\" - cannot parse into long"); } tasks.add(this.registrar.scheduleFixedDelayTask(new FixedDelayTask(runnable, fixedDelay, initialDelay))); } } // Check fixed rate 解析fixedRate參數 long fixedRate = scheduled.fixedRate(); if (fixedRate >= 0) { Assert.isTrue(!processedSchedule, errorMessage); processedSchedule = true; tasks.add(this.registrar.scheduleFixedRateTask(new FixedRateTask(runnable, fixedRate, initialDelay))); } String fixedRateString = scheduled.fixedRateString(); if (StringUtils.hasText(fixedRateString)) { if (this.embeddedValueResolver != null) { fixedRateString = this.embeddedValueResolver.resolveStringValue(fixedRateString); } if (StringUtils.hasLength(fixedRateString)) { Assert.isTrue(!processedSchedule, errorMessage); processedSchedule = true; try { fixedRate = parseDelayAsLong(fixedRateString); } catch (RuntimeException ex) { throw new IllegalArgumentException( "Invalid fixedRateString value \"" + fixedRateString + "\" - cannot parse into long"); } tasks.add(this.registrar.scheduleFixedRateTask(new FixedRateTask(runnable, fixedRate, initialDelay))); } } // Check whether we had any attribute set // 如果五個參數一個也沒解析到,拋出異常 Assert.isTrue(processedSchedule, errorMessage); // Finally register the scheduled tasks // 並發控制將任務隊列存入註冊任務列表 synchronized (this.scheduledTasks) { Set<ScheduledTask> regTasks = this.scheduledTasks.computeIfAbsent(bean, key -> new LinkedHashSet<>(4)); regTasks.addAll(tasks); } } catch (IllegalArgumentException ex) { throw new IllegalStateException( "Encountered invalid @Scheduled method '" + method.getName() + "': " + ex.getMessage()); } }
將任務解析並添加到任務隊列後,交由ScheduledTaskRegistrar
類的scheduleTasks
方法添加(註冊)定時任務到環境中
protected void scheduleTasks() { if (this.taskScheduler == null) { //獲取ScheduledExecutorService對象,實際上都是使用ScheduledThreadPoolExecutor執行定時任務調度 this.localExecutor = Executors.newSingleThreadScheduledExecutor(); this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor); } if (this.triggerTasks != null) { for (TriggerTask task : this.triggerTasks) { addScheduledTask(scheduleTriggerTask(task)); } } if (this.cronTasks != null) { for (CronTask task : this.cronTasks) { addScheduledTask(scheduleCronTask(task)); } } if (this.fixedRateTasks != null) { for (IntervalTask task : this.fixedRateTasks) { addScheduledTask(scheduleFixedRateTask(task)); } } if (this.fixedDelayTasks != null) { for (IntervalTask task : this.fixedDelayTasks) { addScheduledTask(scheduleFixedDelayTask(task)); } } } private void addScheduledTask(@Nullable ScheduledTask task) { if (task != null) { this.scheduledTasks.add(task); } }
到此這篇關於Java Spring分別實現定時任務方法的文章就介紹到這瞭,更多相關Java 定時任務內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- 關於@Scheduled參數及cron表達式解釋
- Spring Boot 2.x基礎教程之使用@Scheduled實現定時任務的方法
- springboot通過註解、接口創建定時任務詳解
- Java中定時任務的6種實現方式
- 淺析java中常用的定時任務框架-單體