当前位置: 开发笔记 > 数据库 > 正文

SpringBoot中使用Quartz管理定时任务的方法

作者：无心伤害2502907297 | 来源：互联网 | 2022-01-12 19:49

这篇文章主要介绍了SpringBoot中使用Quartz管理定时任务的方法，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

定时任务在系统中用到的地方很多，例如每晚凌晨的数据备份，每小时获取第三方平台的 Token 信息等等，之前我们都是在项目中规定这个定时任务什么时候启动，到时间了便会自己启动，那么我们想要停止这个定时任务的时候，就需要去改动代码，还得启停服务器，这是非常不友好的事情

直至遇见 Quartz，利用图形界面可视化管理定时任务，使得我们对定时任务的管理更加方便，快捷

一、Quartz 简介

Quartz是一个开源的作业调度框架，它完全由Java写成，并设计用于J2SE和J2EE应用中。它提供了巨大的灵活性而不牺牲简单性。你能够用它来为执行一个作业而创建简单的或复杂的调度。它有很多特征，如：数据库支持，集群，插件，EJB作业预构建，JavaMail及其它，支持cron-like表达式等等。

二、开发前戏

1、引入 maven 依赖



 org.springframework.boot
 spring-boot-starter-web



 org.springframework.boot
 spring-boot-starter-quartz

这里引入了 web 的依赖，以及 Quartz 的依赖，其余依赖请根据需求自行引入

2、创建数据表

数据模型：

数据模型

SQL语句：

drop table if exists sys_quartz;

/*==============================================================*/
/* Table: sys_quartz           */
/*==============================================================*/
create table sys_quartz
(
 id     bigint(20) not null auto_increment comment '主键id',
 class_name   varchar(32) comment '任务类名',
 cron_expression  varchar(32) comment 'cron表达式',
 param    varchar(32) comment '参数',
 descript    varchar(11) comment '描述',
 quartz_status  varchar(255) comment '启动状态(0--启动1--停止)',
 create_time   datetime comment '创建时间',
 create_user   bigint(20) comment '创建人',
 status    tinyint(1) default 0 comment '状态（0--正常1--停用）',
 del_flag    tinyint(1) default 0 comment '删除状态（0，正常，1已删除）',
 primary key (id)
)
type = InnoDB;

alter table sys_quartz comment '定时任务信息表';

三、开发进行中

1、创建实体类

import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import com.zyxx.common.annotation.Dict;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

import java.io.Serializable;

/**
 * 
 * 定时任务信息表
 * 
 *
 * @author lizhou
 * @since 2020-07-21
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("sys_quartz")
@ApiModel(value="SysQuartz对象", description="定时任务信息表")
public class SysQuartz extends Model {

 @ApiModelProperty(value = "主键id")
 @TableId(value = "id", type = IdType.AUTO)
 private Long id;

 @ApiModelProperty(value = "任务类名")
 @TableField("class_name")
 private String className;

 @ApiModelProperty(value = "cron表达式")
 @TableField("cron_expression")
 private String cronExpression;

 @ApiModelProperty(value = "参数")
 @TableField("param")
 private String param;

 @ApiModelProperty(value = "描述")
 @TableField("descript")
 private String descript;

 @ApiModelProperty(value = "启动状态（0--启动1--停止）")
 @TableField("quartz_status")
 private Integer quartzStatus;

 @ApiModelProperty(value = "状态（0--正常1--停用）")
 @TableField("status")
 private Integer status;

 @ApiModelProperty(value = "删除状态（0--未删除1--已删除）")
 @TableField("del_flag")
 @TableLogic
 private Integer delFlag;

 @ApiModelProperty(value = "创建者")
 @TableField("create_user")
 private Long createUser;

 @ApiModelProperty(value = "创建时间")
 @TableField("create_time")
 private String createTime;

 @Override
 protected Serializable pkVal() {
  return this.id;
 }
}

2、实现定时任务的 CRUD

下面我们就要完成定时任务的新增、修改、删除、启停等基本操作了，由于不是很复杂，这里的代码就不贴出来了，贴几张图吧

列表页：

列表页

新增页：

新增页

四、定时任务

1、定时任务类

我们把定时任务都放在 job 包下面，一个定时任务就是一个文件，写一个测试的类 TestJob.java

import com.zyxx.common.utils.DateUtils;
import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

/**
 * @ClassName TestJob
 * 测试定时任务
 * @Author Lizhou
 * @Date 2020-07-21 10:58:58
 **/
@Slf4j
public class TestJob implements Job {

 @Override
 public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
  System.out.println("定时任务启动：" + DateUtils.getYmdHms());
 }
}

TestJob 这个类实现了 Job 接口，实现了 execute 方法，这里还可以接收参数

这个文件在 com.zyxx.sbm.job 包下面，那么在页面新增定时任务的时候，就需要填写任务类名为：com.zyxx.sbm.job.TestJob

cron 表达式的知识这里就不一一介绍了

2、页面添加定时任务

添加定时任务

那么我们的任务类名就是：com.zyxx.sbm.job.TestJob
cron 表达式：*/2 * * * * &＃63;，表示两秒钟执行一次
参数：我们没有传入参数

3、后台添加定时任务

package com.zyxx.sbm.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.zyxx.common.shiro.SingletonLoginUtils;
import com.zyxx.common.utils.DateUtils;
import com.zyxx.common.utils.LayTableResult;
import com.zyxx.common.utils.ResponseResult;
import com.zyxx.sbm.entity.SysQuartz;
import com.zyxx.sbm.mapper.SysQuartzMapper;
import com.zyxx.sbm.service.SysQuartzService;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.quartz.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * 
 * 定时任务信息表 服务实现类
 * 
 *
 * @author lizhou
 * @since 2020-07-21
 */
@Slf4j
@Service
public class SysQuartzServiceImpl extends ServiceImpl implements SysQuartzService {

 @Autowired
 private Scheduler scheduler;

	/**
	* 添加定时任务
	*/
 @Override
 public ResponseResult add(SysQuartz sysQuartz) {
  QueryWrapper queryWrapper = new QueryWrapper<>();
  queryWrapper.eq("class_name", sysQuartz.getClassName());
  List sysQuartzList = list(queryWrapper);
  if (null != sysQuartzList && !sysQuartzList.isEmpty()) {
   return ResponseResult.getInstance().error("该任务类名已经存在");
  }
  sysQuartz.setCreateTime(DateUtils.getYmdHms());
  sysQuartz.setCreateUser(SingletonLoginUtils.getUserId());
  save(sysQuartz);
  // 启动
  if (0 == sysQuartz.getQuartzStatus()) {
   this.schedulerAdd(sysQuartz.getClassName().trim(), sysQuartz.getCronExpression().trim(), sysQuartz.getParam());
  }
  return ResponseResult.getInstance().success();
 }

 /**
  * 添加定时任务
  *
  * @param className
  * @param cronExpression
  * @param param
  */
 @Override
 public void schedulerAdd(String className, String cronExpression, String param) {
  try {
   // 启动调度器
   scheduler.start();
   // 构建job信息
   JobDetail jobDetail = JobBuilder.newJob(getClass(className).getClass()).withIdentity(className).usingJobData("param", param).build();
   // 表达式调度构建器(即任务执行的时间)
   CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
   // 按新的cronExpression表达式构建一个新的trigger
   CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(className).withSchedule(scheduleBuilder).build();
   scheduler.scheduleJob(jobDetail, trigger);
  } catch (SchedulerException e) {
   log.error(e.getMessage());
  } catch (RuntimeException e) {
   log.error(e.getMessage());
  } catch (Exception e) {
   log.error(e.getMessage());
  }
 }

 /**
  * 删除定时任务
  *
  * @param className
  */
 @Override
 public void schedulerDelete(String className) {
  try {
   scheduler.pauseTrigger(TriggerKey.triggerKey(className));
   scheduler.unscheduleJob(TriggerKey.triggerKey(className));
   scheduler.deleteJob(JobKey.jobKey(className));
  } catch (Exception e) {
   log.error(e.getMessage(), e);
  }
 }

 private static Job getClass(String className) throws Exception {
  Class<&＃63;> class1 = Class.forName(className);
  return (Job) class1.newInstance();
 }
}

需要注入 Scheduler 对象，使用该对象开启或停止定时任务

在启动定时任务之前，我们应先删除该任务类名开启的定时任务，防止该任务类名已经添加过了

// 删除定时任务
schedulerDelete(sysQuartz.getClassName().trim());
// 添加定时任务
schedulerAdd(sysQuartz.getClassName().trim(), sysQuartz.getCronExpression().trim(), sysQuartz.getParam());

添加定时任务，传入任务类名，cron 表达式，参数

停止定时任务，只需要：

scheduler.pauseJob(JobKey.jobKey(sysQuartz.getClassName().trim()));

根据任务类名，停止定时任务即可

五、开发测试

启动项目，在管理界面，开启定时任务，即可在控制台看到打印的信息

打印信息

表示我们的定时任务已经启动成功了

六、优化建议

当我们添加了定时任务并启动后，重新启动项目的时候，定时任务却不会自动启动，这时候，我们就需要在项目启动的时候做一些事情了，也就是系统启动任务

不清楚的同学可以复习一下之前我的博客【SpringBoot】十九、SpringBoot中实现启动任务

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.zyxx.sbm.entity.SysQuartz;
import com.zyxx.sbm.service.SysQuartzService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import java.util.List;

/**
 * @ClassName SystemStartTask
 * 项目启动任务--启动定时任务
 * @Author Lizhou
 * @Date 2020-07-21 12:56:56
 **/
@Component
@Order(100)
public class SystemQuartzStartTask implements CommandLineRunner {

 @Autowired
 private SysQuartzService sysQuartzService;

 @Override
 public void run(String... args) throws Exception {
  // 查询启动的定时任务
  QueryWrapper queryWrapper = new QueryWrapper<>();
  queryWrapper.eq("status", 0);
  queryWrapper.eq("quartz_status", 0);
  List list = sysQuartzService.list(queryWrapper);
  if (null != list && !list.isEmpty()) {
   for (SysQuartz item : list) {
    // 删除定时任务
    sysQuartzService.schedulerDelete(item.getClassName().trim());
    // 添加定时任务
    sysQuartzService.schedulerAdd(item.getClassName().trim(), item.getCronExpression().trim(), item.getParam());
   }
  }
 }
}

从数据库查询出启动的定时任务，并将他们添加到定时任务启动中，这样项目一启动时，就会自动启动我们定义的定时任务了

最后

任务类名的正则表达式

/^[a-zA-Z]+(\.([a-zA-Z])+)+$/

cron 表达式的验证使用正则太麻烦，可以使用 Quartz 自带验证方法

CronExpression.isValidExpression(cron)

SpringBoot 中使用 Quartz 管理定时任务的学习就到这儿了，其实也并不难理解，相比于之前用的定时任务是不是好很多了呢，别忘了最后加上系统启动任务哦

总结

到此这篇关于SpringBoot中使用Quartz管理定时任务的文章就介绍到这了,更多相关SpringBoot管理定时任务内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

推荐阅读

数据库
深入理解PHP中的超全局变量与AJAX技术

本文详细介绍了PHP中的几种超全局变量，包括$GLOBAL、$_SERVER、$_POST、$_GET等，并探讨了AJAX的工作原理及其优缺点。通过具体示例，帮助读者更好地理解和应用这些技术。 ... [详细]

蜡笔小新 2024-11-24 16:35:09
数据库
Maven + Spring + MyBatis + MySQL 环境搭建与实例解析

本文详细介绍如何使用MySQL数据库进行环境搭建，包括创建数据库表并插入示例数据。随后，逐步指导如何配置Maven项目，整合Spring框架与MyBatis，实现高效的数据访问。 ... [详细]

蜡笔小新 2024-11-21 18:39:23
数据库
软件测试行业深度解析：迈向高薪的必经之路

本文深入探讨了软件测试行业的发展现状及未来趋势，旨在帮助有志于在该领域取得高薪的技术人员明确职业方向和发展路径。 ... [详细]

蜡笔小新 2024-11-21 17:32:44
数据库
解决PHP及Web开发中的UTF-8乱码问题

本文详细探讨了在Web开发中常见的UTF-8编码问题及其解决方案，包括HTML页面、PHP脚本、MySQL数据库以及JavaScript和Flash应用中的乱码问题。 ... [详细]

蜡笔小新 2024-11-20 10:58:03
数据库
探讨密码安全的重要性

近期，多家知名网站如CSDN、人人网、多玩、开心网等的数据库相继被泄露，其中大量用户的账户密码因明文存储而暴露无遗。本文将探讨黑客获取密码的常见手段，网站如何安全存储用户信息，以及用户应如何保护自己的密码。 ... [详细]

蜡笔小新 2024-11-18 21:49:53
sql
2023年1月28日网络安全热点

涵盖最新的网络安全动态，包括OpenSSH和WordPress的安全更新、VirtualBox提权漏洞、以及谷歌推出的新证书验证机制等内容。 ... [详细]

蜡笔小新 2024-11-24 10:29:06
数据库
必须为元素类型 mapper 声明属性 namespace解决

在使用mybatis进行mapper.xml测试的时候发生必须为元素类型“mapper”声明属性“namespace”的错误项目目录结构UserMapper和UserMappe ... [详细]

蜡笔小新 2024-11-23 20:06:58
数据库
PHP版本选择指南：适应不同场景的最佳实践

本文详细探讨了如何根据不同的应用场景选择合适的PHP版本，包括多版本切换技巧、稳定性分析及针对WordPress等特定平台的版本建议。 ... [详细]

蜡笔小新 2024-11-23 17:00:59
mysql
PHP中Smarty模板引擎自定义函数详解

本文详细介绍了如何在PHP的Smarty模板引擎中自定义函数，并通过具体示例演示了这些函数的使用方法和应用场景。适合PHP后端开发者学习。 ... [详细]

蜡笔小新 2024-11-23 15:39:25
数据库
MVC模式下的电子取证技术初探

本文探讨了在MVC（模型-视图-控制器）架构下进行电子取证的技术方法，通过实际案例分析，提供了详细的取证步骤和技术要点。 ... [详细]

蜡笔小新 2024-11-23 12:13:06
数据库
特别活动 | 新配送业务启动，多重福利等你来拿！

美团安全响应中心推出全新配送业务测试活动，带来双重福利，邀您共同参与！ ... [详细]

蜡笔小新 2024-11-22 22:39:37
数据库
最适合初学者的编程语言

本文探讨了适合编程新手的最佳语言选择，包括Python、JavaScript等易于上手且功能强大的语言，以及如何通过有效的学习方法提高编程技能。 ... [详细]

蜡笔小新 2024-11-22 16:17:04
数据库
搭建个人博客：WordPress安装详解

计划建立个人博客来分享生活与工作的见解和经验，选择WordPress是因为它专为博客设计，功能强大且易于使用。 ... [详细]

蜡笔小新 2024-11-22 11:13:36
数据库
流处理中的计数挑战与解决方案

本文探讨了在流处理中进行计数的各种技术和挑战，并基于作者在2016年圣何塞举行的Hadoop World大会上的演讲进行了深入分析。文章不仅介绍了传统批处理和Lambda架构的局限性，还详细探讨了流处理架构的优势及其在现代大数据应用中的重要作用。 ... [详细]

蜡笔小新 2024-11-20 13:50:01
数据库
解决Spring Cloud Eureka自定义端口时连接错误的问题

在尝试通过自定义端口部署Spring Cloud Eureka时遇到了连接失败的问题。本文详细描述了问题的现象，并提供了有效的解决方案，以帮助遇到类似情况的开发者。 ... [详细]

蜡笔小新 2024-11-20 13:05:47

无心伤害2502907297

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章