springboot 基于@Scheduled注解实现定时任务

最新推荐文章于 2022-05-19 09:44:06 发布

beidaol

最新推荐文章于 2022-05-19 09:44:06 发布

阅读量1.1k

点赞数 1

分类专栏： springboot 定时器文章标签：定时器 Scheduled

原文链接：https://www.cnblogs.com/mmzs/p/10161936.html

版权

springboot 同时被 2 个专栏收录

3 篇文章 0 订阅

订阅专栏

定时器

1 篇文章 0 订阅

订阅专栏

前言

定时任务通常有三种完成方法

java自带的API java.util.Timer类 java.util.TimerTask类

在 JDK 中，内置了两个类，可以实现定时任务的功能：

java.util.Timer ：可以通过创建 java.util.TimerTask 调度任务，在同一个线程中串行执行，相互影响。也就是说，对于同一个 Timer 里的多个 TimerTask 任务，如果一个 TimerTask 任务在执行中，其它 TimerTask 即使到达执行的时间，也只能排队等待。因为 Timer 是串行的，同时存在坑坑，所以后来 JDK 又推出了 ScheduledExecutorService ，Timer 也基本不再使用。
java.util.concurrent.ScheduledExecutorService ：在 JDK 1.5 新增，基于线程池设计的定时任务类，每个调度任务都会被分配到线程池中并发执行，互不影响。这样，ScheduledExecutorService 就解决了 Timer 串行的问题。

在日常开发中，我们很少直接使用 Timer 或 ScheduledExecutorService 来实现定时任务的需求。主要有几点原因：

它们仅支持按照指定频率，不直接支持指定时间的定时调度，需要我们结合 Calendar 自行计算，才能实现复杂时间的调度。例如说，每天、每周五、2019-11-11 等等。
它们是进程级别，而我们为了实现定时任务的高可用，需要部署多个进程。此时需要等多考虑，多个进程下，同一个任务在相同时刻，不能重复执行。
项目可能存在定时任务较多，需要统一的管理，此时不得不进行二次封装。

所以，一般情况下，我们会选择专业的调度任务中间件。

2、Quartz框架开源功能强大使用起来稍显复杂

3.Spring 3.0以后自带了task 调度工具，比Quartz更加的简单方便

使用SpringBoot创建定时任务非常简单，目前主要有以下三种创建方式：
一、基于注解(@Scheduled)
二、基于接口（SchedulingConfigurer）前者相信大家都很熟悉，但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务，这时候基于接口的定时任务就派上用场了。
三、基于注解设定多线程定时任务

一、静态：基于注解

1、创建定时器

使用SpringBoot基于注解来创建定时任务非常简单，只需几行代码便可完成。代码如下：

@Component
@Configuration      //1.主要用于标记配置类，兼备Component的效果。
@EnableScheduling   // 2.开启定时任务
public class SaticScheduleTask {
    //3.添加定时任务
    @Scheduled(cron = "0/5 * * * * ?")
    //或直接指定时间间隔，例如：5秒
    //@Scheduled(fixedRate=5000)
    private void configureTasks() {
        System.err.println("执行静态定时任务时间: " + LocalDateTime.now());
    }
}

或

@Controller
public class TestSchudle {


    @Scheduled(cron = "0/5 * * * * ?")
    //或直接指定时间间隔，例如：5秒
    //@Scheduled(fixedRate=5000)
    private void configureTasks() {
        System.err.println("在controller里进行定时操作 " + LocalDateTime.now());
    }

}

关于Cron表达式介绍

cronExpression定义时间规则，Cron表达式由6或7个空格分隔的时间字段组成：秒分钟小时日期月份星期年（可选）

字段　　允许值　　允许的特殊字符 
秒     　 0-59 　　　　, - * / 
分     　 0-59　　　　 , - * / 
小时      0-23 　　　　, - * / 
日期      1-31 　　　　, - * ? / L W C 
月份      1-12 　　　　, - * / 
星期      1-7 　　　　  , - * ? / L C # 
年     1970-2099 　　, - * /

关于Cron表达式的介绍来源：

http://blog.csdn.net/supingemail/article/details/22274279

表达式网站生成:

表达式网站地址

注意：

Spring允许的表达式是所有可能的cron表达式的子集，例如它不包含year字段，并且不能使用所有特殊字符。如：

//每个月的最后一天的23点59分

@Scheduled(cron = "0 59 23 L * ?")

这个表达式错误，因为有特殊字符L（W也是不能用的），代码运行提示

Encountered invalid @Scheduled method 'deleteBatchByDate': For input string: "L"

二、动态：基于接口

基于接口（SchedulingConfigurer）

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.0.4.RELEASE</version>
    </parent>

    <dependencies>
        <dependency><!--添加Web依赖 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency><!--添加MySql依赖 -->
             <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency><!--添加Mybatis依赖 配置mybatis的一些初始化的东西-->
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency><!-- 添加mybatis依赖 -->
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

2、添加数据库记录：

开启本地数据库mysql，随便打开查询窗口，然后执行脚本内容，如下：

DROP DATABASE IF EXISTS `socks`;
CREATE DATABASE `socks`;
USE `SOCKS`;
DROP TABLE IF EXISTS `cron`;
CREATE TABLE `cron`  (
  `cron_id` varchar(30) NOT NULL PRIMARY KEY,
  `cron` varchar(30) NOT NULL  
);
INSERT INTO `cron` VALUES ('1', '0/5 * * * * ?');

然后在项目中的application.yml 添加数据源：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/socks
    username: root
    password: 123456

3、创建定时器

数据库准备好数据之后，我们编写定时任务，注意这里添加的是TriggerTask，目的是循环读取我们在数据库设置好的执行周期，以及执行相关定时任务的内容。
具体代码如下：

@Component
@Configuration      //1.主要用于标记配置类，兼备Component的效果。
@EnableScheduling   // 2.开启定时任务
public class DynamicScheduleTask implements SchedulingConfigurer {

    @Mapper
    public interface CronMapper {
        @Select("select cron from cron limit 1")
        public String getCron();
    }

    @Autowired      //注入mapper
    @SuppressWarnings("all")
    CronMapper cronMapper;

    /**
     * 执行定时任务.
     */
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {

        taskRegistrar.addTriggerTask(
                //1.添加任务内容(Runnable)
                () -> System.out.println("执行动态定时任务: " + LocalDateTime.now().toLocalTime()),
                //2.设置执行周期(Trigger)
                triggerContext -> {
                    //2.1 从数据库获取执行周期
                    String cron = cronMapper.getCron();
                    //2.2 合法性校验.
                    if (StringUtils.isEmpty(cron)) {
                        // Omitted Code ..
                    }
                    //2.3 返回执行周期(Date)
                    return new CronTrigger(cron).nextExecutionTime(triggerContext);
                }
        );
    }

}

三、多线程定时任务

基于注解设定多线程定时任务

1、创建多线程定时任务

//@Component注解用于对那些比较中立的类进行注释；
//相对与在持久层、业务层和控制层分别采用 @Repository、@Service 和 @Controller 对分层中的类进行注释
@Component
@EnableScheduling   // 1.开启定时任务
@EnableAsync        // 2.开启多线程
public class MultithreadScheduleTask {

        @Async
        @Scheduled(fixedDelay = 1000)  //间隔1秒
        public void first() throws InterruptedException {
            System.out.println("第一个定时任务开始 : " + LocalDateTime.now().toLocalTime() + "\r\n线程 : " + Thread.currentThread().getName());
            System.out.println();
            Thread.sleep(1000 * 10);
        }

        @Async
        @Scheduled(fixedDelay = 2000)
        public void second() {
            System.out.println("第二个定时任务开始 : " + LocalDateTime.now().toLocalTime() + "\r\n线程 : " + Thread.currentThread().getName());
            System.out.println();
        }
    }

实例

参考：https://blog.csdn.net/debugbugbg/article/details/81091715

SpringTask 默认是单线程的上面的两个定时任务使用的都是同一个线程；在实际开发中，不希望所有的任务都运行在一个线程中，想要改成多线程，给SpringTask提供一个多线程的TaskScheduler，Spring已经有默认实现

结果：

代码地址：https://github.com/mmzsblog/springboot-schedule

转载：https://www.cnblogs.com/mmzs/p/10161936.html

其他参考：

https://blog.csdn.net/jack_bob/article/details/78786740

https://blog.csdn.net/fastlearn/article/details/83306796

https://mp.weixin.qq.com/s/jqN4noo5NazckPCehWFgpA

beidaol

关注

1
点赞
踩
10

收藏

觉得还不错? 一键收藏
1
评论
springboot 基于@Scheduled注解实现定时任务

前言使用SpringBoot创建定时任务非常简单，目前主要有以下三种创建方式：一、基于注解(@Scheduled)二、基于接口（SchedulingConfigurer）前者相信大家都很熟悉，但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务，这时候基于接口的定时任务就派上用场了。三、基于注解设定多线程定时任务一、静态：基于注解1、创建定时器使用SpringBoot基于注解来创建定时任务非常简单，只需几行代码便可完成。代码如下：@Compo...
复制链接

扫一扫