Spring使用@Scheduled注解实现定时任务

得意时要看淡,失意时要看开。不论得意失意,切莫大意;不论成功失败,切莫止步。志得意满时,需要的是淡然,给自己留一条退路;失意落魄时,需要的是泰然,给自己觅一条出路Spring使用@Scheduled注解实现定时任务,希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com,来源:原文

SpringBoot项目中,通过在方法上添加注解
@Scheduled来实现定时任务

启动类

启动类里面使用@EnableScheduling注解开启功能,自动扫描

@SpringBootApplication
@EnableScheduling //开启定时任务
public class MainApplication {

    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }
}

配置

要在任务的类上写@Component
要在任务方法上写@Scheduled

定义

先看下@Scheduled注解的定义,很清楚的看到,实现定时任务有多种选择,如cron, fixedDelay … 等等

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;

@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 "";
}

详细说明

fixedDelay

以上一个调用任务的完成时间为基准,以一个固定延迟时间调用一次执行

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

上面的例子:
在上一个任务完成之后,5s后再次执行。

fixedRate

以上一个任务开始时间为基准,以固定速率执行

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

上面的例子:
从上一任务开始执行后5s再次调用。

cron

如果上面的设置不能满足需求,可以使用cron的方式。
这里的cron类似于Linux中的cron job,但是还是有些区别的:

Linux上配置cron job

java例子如下:每天凌晨1点去执行任务

@Scheduled(cron = "0 0 1 * * ?")
public void doSomething() { 
    // something that should execute periodically
}

一个cron表达式有至少6个(也可能7个)有空格分隔的时间元素。
按顺序依次为:

顺序 字段 取值范围 可出现的特殊字符
1 Seconds 0-59的整数 , – * /
2 Minutes 0-59的整数 , – * /
3 Hours 0-23的整数 , – * /
4 DayofMonth 1-31的整数 , – * / ? L W C
5 Month 1-12的整数或JAN-DEC , – * /
6 DayofWeek 1-7的整数或SUN-SAT两个范围。1表示星期天,2表示星期一, 依次类推 , – * / ? L C #
7 Year(可选) 留空, 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触发 

特殊字符

  1. * 字符代表所有可能的值
    因此,* 在子表达式(月)里表示每个月的含义,* 在子表达式(天(星期))表示星期的每一天。
  2. / 字符用来指定数值的增量
    例如:
    在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟
    在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样
  3. ? 字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
    当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为?
  4. L 字符仅被用于天(月)和天(星期)两个子表达式,它是单词last的缩写,但是它在两个子表达式里的含义是不同的。
    在天(月)子表达式中,L 表示一个月的最后一天
    在天(星期)自表达式中,L 表示一个星期的最后一天,也就是SAT
    如果在L 前有具体的内容,它就具有其他的含义了:
    例如:“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五
    注意:在使用L参数时,不要指定列表或范围,因为这会导致问题。

扩展

异步执行Spring Task

为了提高异步task的执行效率,我们也可以异步执行task。
步骤为:

  1. 在SpringBoot启动类上添加@EnableAsync注解,开启异步执行功能
  2. 在Task上添加@Async注解

如果想把task放在自定义的线程池里,可以使用直接指定线程池名,如@Async("threadPoolTaskExecutor")

关于异常处理,难免在这个异步执行过程中有异常发生,对于这个问题,spring提供的解决方案如下,实现 AsyncUncaughtExceptionHandler接口。

public class MyAsyncUncaughtExceptionHandler implements
AsyncUncaughtExceptionHandler {
 
@Override
public void handleUncaughtException(Throwable ex,
Method method, Object... params) {
 
// handle exception
}
}

写好我们的异常处理后,我们需要配置一下,告诉spring,这个异常处理就是我们在运行异步任务时候,抛出错误时的异常终结者

@Configuration
@EnableAsync
public class AsyncConfig implements AsyncConfigurer {
 
@Bean
public AsyncTask asyncBean() {
return new AsyncTask();
}
 
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(5);
executor.setMaxPoolSize(20);
executor.setQueueCapacity(11);
executor.setThreadNamePrefix("MyExecutor-");
executor.initialize();
return executor;
}
 
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return new MyAsyncUncaughtExceptionHandler();
}
}

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/155734.html

(0)
飞熊的头像飞熊bm

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!