Springboot自带定时任务实现动态配置Cron参数方式

目录
  • Springboot自带定时任务实现动态配置Cron参数
    • SpringBoot定时任务的四种实现方式(主要)
  • spring动态配置cron表达式,不需要停服
    • SchedulingConfigurer接口实现动态加载cron表达式

Springboot自带定时任务实现动态配置Cron参数

同学们,我今天分享一下SpringBoot动态配置Cron参数。场景是这样子的:后台管理界面对定时任务进行管理,可动态修改执行时间,然后保存入库,每次任务执行前从库里查询时间,以达到动态修改Cron参数的效果。好,咱们一起来看看是怎么回事。

SpringBoot定时任务的四种实现方式(主要)

  • Timer:这是java自带的java.util.Timer类,这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行,但不能在指定时间运行。一般用的较少。
  • ScheduledExecutorService:也jdk自带的一个类;是基于线程池设计的定时任务类,每个调度任务都会分配到线程池中的一个线程去执行,也就是说,任务是并发执行,互不影响。
  • Spring Task:Spring3.0以后自带的task,可以将它看成一个轻量级的Quartz,而且使用起来比Quartz简单许多。
  • Quartz:这是一个功能比较强大的的调度器,可以让你的程序在指定时间执行,也可以按照某一个频度执行,配置起来稍显复杂。

1.1使用Timer

这是让你按照固定的频率去执行一个任务,不能指定时间。

public class TestTimer {
    public static void main(String[] args) {
        TimerTask timerTask = new TimerTask() {
            @Override
            public void run() {
                System.out.println("task  run:"+ new Date());
            }
        };
        Timer timer = new Timer();
        //安排指定的任务在指定的时间开始进行重复的固定延迟执行。这里是每3秒执行一次
        timer.schedule(timerTask,10,3000);
    }
}

1.2使用ScheduledExecutorService和timer类似

public class TestScheduledExecutorService {
    public static void main(String[] args) {
        ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();
        // 参数:1、任务体 2、首次执行的延时时间
        //      3、任务执行间隔 4、间隔时间单位
        service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService "+new Date()), 0, 3, TimeUnit.SECONDS);
    }
}

1.3使用Spring Task

我们主要讲解它的动态配置使用方法。

在刚开始使用的时候,我们更改一个任务的执行时间,一般是这样的:修改定时任务的执行周期,把服务停下来,改下任务的cron参数,再重启服务就搞搞定了。这种方式很简单,没有可说的,但是有没有一种可能,在不停服务的情况下,就可以动态的修改任务的cron参数呢?那是必须有!

刚刚提到的方法里,我们在主类上面加@EnableScheduling注解,在任务方法前面加上@Scheduled(cron =“0/5 * * * * *”)注解定义执行时间,但是动态配置的步骤就有点不一样:

1. 在定时任务类上增加@EnabledScheduling注解,并实现SchedulingConfigurer接口。

2. 设置一个静态的cron,用于存放任务执行周期参数。

3. 从数据库获取Cron参数,用于模拟实际业务中外部原因修改了任务执行周期。

4. 设置任务触发器,触发任务执行。

import java.util.Date;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
@Component
@EnableScheduling
public class TaskCronChange implements  SchedulingConfigurer{
    public static String cron;
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        //项目部署时,会在这里执行一次,从数据库拿到cron表达式
        cron = timerQueryMapper.getCronTime();
       Runnable task = new Runnable() {
           @Override
           public void run() {
              //任务逻辑代码部分.
              System.out.println("I am going:" + LocalDateTime.now());
           }
       };
       Trigger trigger = new Trigger() {
           @Override
           public Date nextExecutionTime(TriggerContext triggerContext) {
              //任务触发,可修改任务的执行周期.
              //每一次任务触发,都会执行这里的方法一次,重新获取下一次的执行时间
              cron = timerQueryMapper.getCronTime();
              CronTrigger trigger = new CronTrigger(cron);
              Date nextExec = trigger.nextExecutionTime(triggerContext);
              return nextExec;
           }
       };
       taskRegistrar.addTriggerTask(task, trigger);
    }
}

因为是要任务执行一次的时候才会去修改时间的cron表达式,所以改了cron后,要在下下次任务执行时才会生效。

这里核心的主要是使用到了ScheduledTaskRegistrar这个类有一个方法addTriggerTask(Runnable,Trigger) 两个参数,一个Runnable,一个是Trigger,在Runnable中执行业务逻辑代码,在Trigger修改定时任务的执行周期。

1.4整合Quartz

在SpringBoot版本是2.0.0以后的,则在spring-boot-starter中已经包含了quart的依赖,则可以直接使用spring-boot-starter-quartz依赖,如果是低于2.0.0版本的,需要额外添加quartz的依赖。

spring动态配置cron表达式,不需要停服

spring做定时任务调度时有常用的两种方式,分别是基于配置文件的quartz和基于注解的@Scheduler。

quartz需要较多的配置文件,个人感觉比较麻烦,@Scheduler注解只需要简单的配置即可,但是这两种发方法不能动态加载cron表达式,每次更改调度规则都需要重启服务。

本文介绍一种不需要重启服务的动态加载cron表达式的方法。

SchedulingConfigurer接口实现动态加载cron表达式

代码示例如下:

@Component
@EnableScheduling
public class Test implements SchedulingConfigurer {

    @Override
    public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
        //创建一个线程池调度器,默认是单线程执行
        ScheduledExecutorService executorService = Executors.newScheduledThreadPool(100);
        scheduledTaskRegistrar.setScheduler(executorService);

        //增加任务
        scheduledTaskRegistrar.addTriggerTask(new Task("test1"),new Trig("cronExpess1"));
        scheduledTaskRegistrar.addTriggerTask(new Task("test2"),new Trig("cronExpess2"));
        scheduledTaskRegistrar.addTriggerTask(new Task("test3"),new Trig("cronExpess2"));
    }
}

/**
 * 业务类
 */
class Task implements Runnable{
    String task;
    public Task(String task){
        this.task = task;
    }

    //具体业务
    @Override
    public void run() {
        System.out.println(task+":"+LocalDateTime.now()+","+Thread.currentThread().getName());
    }
}

/**
 * 调度类
 */
class Trig implements Trigger{
    private String cronExpress;
    public Trig(String cronExpress){
        this.cronExpress = cronExpress;
    }

    @Override
    public Date nextExecutionTime(TriggerContext triggerContext) {
        String cron = null;
        try {
            //每次调度时加载cron表达式
            cron = new Config().getCrons().get(cronExpress);
        } catch (IOException e) {
            e.printStackTrace();
        }
        CronTrigger cronTrigger = new CronTrigger(cron);
        return cronTrigger.nextExecutionTime(triggerContext);
    }
}

/**
 * 加载cron表达式
 */
class Config{
    private static Map<String,String> cronMap;
    private static long preModifyTime;
    private String cronFile = "config/application.properties";

    public Map<String,String> getCrons() throws IOException {
        File file = new File(cronFile);
        long nowModifyTime = file.lastModified();
        if (cronMap != null && nowModifyTime == preModifyTime){
            return cronMap;
        }else {
            cronMap = new HashMap<>();
            BufferedReader br = new BufferedReader(new FileReader(file));
            String line = null;
            while ((line = br.readLine()) != null){
                String[] s = line.split("=");
                cronMap.put(s[0].trim(),s[1].trim());
            }
            preModifyTime = nowModifyTime;
            return cronMap;
        }
    }
}

配置文件:

cronExpess1 = 0/5 * * * * *
cronExpess2 = 0/10 * * * * *

运行结果(为了查看方便,只运行一个任务):

以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。

(0)

相关推荐

  • SpringBoot实现动态控制定时任务支持多参数功能

    由于工作上的原因,需要进行定时任务的动态增删改查,网上大部分资料都是整合quertz框架实现的.本人查阅了一些资料,发现springBoot本身就支持实现定时任务的动态控制.并进行改进,现支持任意多参数定时任务配置 实现结果如下图所示: 后台测试显示如下: github 简单demo地址如下: springboot-dynamic-task 1.定时任务的配置类:SchedulingConfig import org.springframework.context.annotation.Bean

  • SpringBoot中并发定时任务的实现、动态定时任务的实现(看这一篇就够了)推荐

    一.在JAVA开发领域,目前可以通过以下几种方式进行定时任务 1.单机部署模式 Timer:jdk中自带的一个定时调度类,可以简单的实现按某一频度进行任务执行.提供的功能比较单一,无法实现复杂的调度任务. ScheduledExecutorService:也是jdk自带的一个基于线程池设计的定时任务类.其每个调度任务都会分配到线程池中的一个线程执行,所以其任务是并发执行的,互不影响. Spring Task:Spring提供的一个任务调度工具,支持注解和配置文件形式,支持Cron表达式,使用简单

  • springboot整合Quartz实现动态配置定时任务的方法

    前言 在我们日常的开发中,很多时候,定时任务都不是写死的,而是写到数据库中,从而实现定时任务的动态配置,下面就通过一个简单的示例,来实现这个功能. 一.新建一个springboot工程,并添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency

  • SpringBoot实现动态定时任务

    项目情况: 在当前项目中需要一个定时任务来清除过期的校验码,如果使用数据库存储过程的话不方便维护.因此采用SpringBoot自带的方式来设置定时任务. 技术说明: SpringBoot自带的方式有两种可以实现: 一种是使用@Scheduled注解的方式,只需要在启动类或者它所在的类上添加@EnableScheduling注解允许执行定时任务,并且设置Schecduled注解的参数,诸如: 1.cron是设置定时执行的表达式,如 0 0/5 * * * ?每隔五分钟执行一次 2.zone表示执行

  • Springboot自带定时任务实现动态配置Cron参数方式

    目录 Springboot自带定时任务实现动态配置Cron参数 SpringBoot定时任务的四种实现方式(主要) spring动态配置cron表达式,不需要停服 SchedulingConfigurer接口实现动态加载cron表达式 Springboot自带定时任务实现动态配置Cron参数 同学们,我今天分享一下SpringBoot动态配置Cron参数.场景是这样子的:后台管理界面对定时任务进行管理,可动态修改执行时间,然后保存入库,每次任务执行前从库里查询时间,以达到动态修改Cron参数的效

  • Quartz实现JAVA定时任务的动态配置的方法

    先说点无关本文的问题,这段时间特别的不爽,可能有些同学也遇到过.其实也可以说是小事一桩,但感觉也是不容忽视的.我刚毕业时的公司,每个人每次提交代码都有着严格的规范,像table和space的缩进都有严格的要求,可以说你不遵守开发规范就相当于线上bug问题,还是比较严重的.现在发现外面的公司真的是没那么重视这个不重要却又特别重要的问题啊,啊啊啊啊啊啊!!! 什么是动态配置定时任务? 回归正题,说下这次主题,动态配置.没接触过定时任务的同学可以先看下此篇:JAVA定时任务实现的几种方式 定时任务实现

  • Spring Schedule Task动态改写Cron配置方式

    目录 Spring Schedule Task动态改写Cron配置 Scheduling Tasks的常规使用 动态改写Cron @Scheduled定时任务动态修改cron参数 先来看下Spring常规定时任务的配置 下面来看看可以在不停服务的情况下动态修改任务周期的实现 Spring Schedule Task动态改写Cron配置 使用Spring @Scheduled标签可以很简单地定义Scheduled Task,但是有时我们需要在程序里动态地改写Cron的配置. 什么时候呢? 额,比如

  • 浅谈springboot项目中定时任务如何优雅退出

    在一个springboot项目中需要跑定时任务处理批数据时,突然有个Kill命令或者一个Ctrl+C的命令,此时我们需要当批数据处理完毕后才允许定时任务关闭,也就是当定时任务结束时才允许Kill命令生效. 启动类 启动类上我们获取到相应的上下文,捕捉相应命令.在这里插入代码片 @SpringBootApplication /**指定mapper对应包的路径*/ @MapperScan("com.youlanw.kz.dao") /**开启计划任务*/ @EnableScheduling

  • SpringBoot开发实战系列之动态定时任务

    目录 前言 代码编写 效果演示 启动 修改 停止 后记 前言 定时器是我们项目中经常会用到的,SpringBoot使用@Scheduled注解可以快速启用一个简单的定时器(详情请看我们之前的博客<SpringBoot系列--定时器>),然而这种方式的定时器缺乏灵活性,如果需要对定时器进行调整,需要重启项目才生效,本文记录SpringBoot如何灵活配置动态定时任务 代码编写 首先先建表,重要字段:唯一表id.Runnable任务类.Cron表达式,其他的都是一些额外补充字段 DROP TABL

  • 使用spring-task定时任务动态配置修改执行时间

    目录 spring-task定时任务动态配置修改执行时间 spring schedule 动态配置执行时间 spring-task定时任务动态配置修改执行时间 因项目需要,几个定时任务需要人为动态设置执行时间,于是乎吧,就查阅相关资料,是可以动态设置的,废话不多说,直接上代码,一目了然. package com.seckill.quartz; import org.springframework.scheduling.Trigger; import org.springframework.sch

  • Django+Celery实现动态配置定时任务的方法示例

    哈喽,今天给大家分享一篇Django+Celery实现动态配置定时任务,因为最近也是无意间看到一位大佬关于这块的文章,然后自己觉得不错,也想学习写一下,然后最终实现功能是在前端页面统一管理计划任务,大家可以在admin管理页面设置,也可以在自己写的前端页面删除添加编辑,实时生效,还可以监控这些监控任务是否运行成功失败. 补充:如果大家对celery不熟悉的话,建议先学习celery 一.安装 1.在Linux系统上安装模块 celery (3.1.26.post2) celery-with-re

  • 详解SpringBoot配置文件启动时动态配置参数方法

    序言 当我们要同时启用多个项目而又要使用不同端口或者变换配置属性时,我们可以在配置文件中设置${变量名}的变量来获取启动时传入的参数,从而实现了动态配置参数,使启用项目更加灵活 例子 server: port: ${PORT:50101} #服务端口 spring: application: name: xc‐govern‐center #指定服务名 eureka: client: registerWithEureka: true #服务注册,是否将自己注册到Eureka服务中 fetchReg

  • SpringBoot使用Nacos动态配置数据源的方法

    SpringBoot/SpringCloud项目部署运行后,如果使用硬编码方式定义数据源,那么如果需要更换数据库,就只能通过更改源码并重启的方式来达成目的 而SpringCloud生态中有配置中心这一组件,我们可以将数据源连接属性编写在配置中心中,需要修改连接属性就可以从配置中心中修改并发布,这样就可以热修改数据源位置无需重启服务 那么下面实战说明如何将使用Nacos配置/注册中心配置数据源(请注意看我写的注释来避坑) 首先说明版本 SpringBoot 2.2.0.RELEASE Druid

随机推荐