Springboot定时任务的使用

😂 这篇文章最后更新于1185天前,您需要注意相关的内容是否还可用。
目录导航
  • Springboot定时任务的使用
    • 开启定时任务
    • 开启异步任务
    • 基于接口
  • Springboot定时任务的使用

    Spring提供了@Scheduled注解用于定时任务。也就是说一般需求可以无需第三方定时任务。

    开启定时任务

    启动类加@EnableScheduling开启定时任务

    @SpringBootApplication
    @EnableScheduling //开启定时任务
    public class MainApplication {
        public static void main(String[] args) {
            SpringApplication.run(MainApplication.class, args);
        }
    }

    执行方法

    @Component
    public class Jobs {
    
        //表示方法执行完成后5秒
        @Scheduled(fixedDelay = 5000)
        public void fixedDelayJob() throws InterruptedException {
            System.out.println("fixedDelay 每隔5秒" + new Date());
        }
    
        //表示每隔3秒
        @Scheduled(fixedRate = 3000)
        public void fixedRateJob() {
    
            System.out.println("fixedRate 每隔3秒" + new Date());
        }
    
        //表示每天8时30分0秒执行
        @Scheduled(cron = "0 0,30 0,8 ? * ? ")
        public void cronJob() {
            System.out.println(new Date() + " ...>>cron");
        }
    }

    第三种使用cron表达式可上网搜在线cron表达式,选择时间会自动生成,cron说明

    * 第一位,表示秒,取值0-59
    * 第二位,表示分,取值0-59
    * 第三位,表示小时,取值0-23
    * 第四位,日期天/日,取值1-31
    * 第五位,日期月份,取值1-12
    * 第六位,星期,取值1-7,星期一,星期二...,注:不是第1周,第二周的意思
              另外:1表示星期天,2表示星期一。
    * 第7为,年份,可以留空,取值1970-2099
    
    (*)星号:可以理解为每的意思,每秒,每分,每天,每月,每年...
    (?)问号:问号只能出现在日期和星期这两个位置。
    (-)减号:表达一个范围,如在小时字段中使用“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

    举例

    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  每个月的第三个星期,星期天 执行,#号只能出现在星期的位置

    开启异步任务

    在类上加@EnableAsync注解

    @SpringBootApplication
    @EnableScheduling //开启定时任务
    @EnableAsync //开启异步
    public class MainApplication {
        public static void main(String[] args) {
            SpringApplication.run(MainApplication.class, args);
        }
    }

    异步执行,很简单在方法上加@Async注解即可

        @Async
        @Scheduled(cron = "0 0,30 0,8 ? * ? ")
        public void cronJob() {
            System.out.println(new Date() + " ...>>cron");
        }

    基于接口

    以上基于注解可能不灵活,有时将cron表达式存储在数据库就无法执行了,可以使用接口实现。

    依赖

        <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>

    执行本地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 * * * * ?');

    具体代码:

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

    参考:https://www.cnblogs.com/qdhxhz/p/9058418.html

    https://www.mmzsblog.cn/articles/2019/08/08/1565247960802.html