springboot + mybatis-plus整合quartz实现定时任务(超详细,附带sql)

springboot + mybatis-plus整合quartz实现定时任务

之前做过一次定时任务,使用的是quartz框架.好久没有使用过了.想起了又写了个demo,这里只做了添加定时任务及删除定时任务.修改和查看没有做!.测试结果是Ok的.话不多说了.直接上代码!!

整体目录结构:

config:放置swagger,quartz,druid配置及任务执行方法

controller:就放置的程序入口

mapper:数据库交互

pojo:放置实体(没有区分.直接使用一个来实现了)

service:service层

utils:工具类

1.导入pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.quartz.demo</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- swagger *********************  Begin -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- swagger *********************  End -->

        <!-- lombok *********************  Begin -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!-- lombok *********************  End -->

        <!-- 数据库连接 *********************  Begin -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.0.9</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.33</version>
        </dependency>

        <!-- 数据库连接 *********************  End -->

        <!-- MyBatis-Plus依赖 *******************************  Begin-->
        <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>2.3.3</version>
        </dependency>

        <!--MyBatis 通用 Mapper-->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.0</version>
        </dependency>

        <!-- 定时器 -->
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz-jobs</artifactId>
            <version>2.2.3</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>5.1.2.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>

        <!--解决mapper.xml文件在编译时不会被编译到target目录下:亲测有效-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <filtering>false</filtering>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
    </build>

</project>

2.properties配置文件

1.application.properties

#���ݿ�������Ϣ
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/quartz?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&failOverReadOnly=false&useSSL=true&serverTimezone=Asia/Shanghai&allowMultiQueries=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.sql-script-encoding=utf-8

#jpa create table
spring.jpa.database=MYSQL
spring.jpa.hibernate.ddl-auto=update

########################### mybatis�ı��� ########################
#mybatis�ı���
mybatis.type-aliases-package=com.quartz.demo.pojo
#��������Ķ˿ں�
server.port=2080
server.connection-timeout=600000

2.quartz.properties

# quartz配置
spring.quartz.properties.org.quartz.scheduler.instanceName=AdminClusteredScheduler
spring.quartz.properties.org.quartz.scheduler.instanceId=AUTO
spring.quartz.properties.org.quartz.scheduler.instanceIdGenerator.class=org.quartz.simpl.SimpleInstanceIdGenerator
spring.quartz.properties.org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX
spring.quartz.properties.org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
spring.quartz.properties.org.quartz.jobStore.isClustered=true
spring.quartz.properties.org.quartz.jobStore.clusterCheckinInterval=10000
spring.quartz.properties.org.quartz.jobStore.useProperties=false
spring.quartz.properties.org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool
spring.quartz.properties.org.quartz.threadPool.threadCount=50
spring.quartz.properties.org.quartz.threadPool.threadPriority=5
spring.quartz.properties.org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread=true
spring.quartz.properties.org.quartz.dataSource.quartzDataSource.driver=com.mysql.jdbc.Driver
spring.quartz.properties.org.quartz.dataSource.quartzDataSource.URL=jdbc:mysql://127.0.0.1:3306/quartz
spring.quartz.properties.org.quartz.dataSource.quartzDataSource.user=root
spring.quartz.properties.org.quartz.dataSource.quartzDataSource.password=root

PS:任务就可以理解成就是任务,比方说:上班,打卡,闹钟 .定时任务就是到点了执行任务的实例.一个任务可以有多个定时任务,这里我就做了3个,同一个任务(打卡:上班打,下班也打)可以有多个定时任务!!!
这里没有做任务相关的增删改查,主要是为了操作定时任务.所以任务就手动创建到数据库表中就可以!!!

controller类

这里是做了一个任务id会实现3个定时任务功能

package com.quartz.demo.controller;

import com.quartz.demo.pojo.AddRequest;
import com.quartz.demo.pojo.ResultBO;
import com.quartz.demo.service.TimedTaskService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

@Api(value = "定时任务", tags = {
   "定时任务"})
@Slf4j
@Validated
@RestController
@RequestMapping("/quartz")
public class VehicleJobController {
   

    @Autowired
    private TimedTaskService timedTaskService;

    @ApiOperation("添加定时任务")
    @PostMapping("/add")
    public ResultBO add(@Validated @RequestBody AddRequest addRequest) throws Exception {
   

        System.out.println("传过来的添加定时任务参数为:{}" + addRequest);
        ResultBO resultBO = timedTaskService.addQuartzJob(addRequest);
        return resultBO;
    }

    @ApiOperation("删除定时任务")
    @GetMapping("/delete/{taskId}")
    public ResultBO delete(@ApiParam(value = "定时任务id", required = true) @PathVariable String taskId) throws Exception {
   

        System.out.println("传过来的删除定时任务id为:{}" + taskId);
        ResultBO resultBO = timedTaskService.deleteQuartzJob(Integer.valueOf(taskId));
        return resultBO;
    }
}

service

1.任务接口

package com.quartz.demo.service;

import com.baomidou.mybatisplus.service.IService;
import com.quartz.demo.pojo.Task;

/**
 * @PackgeName: com.quartz.demo.service
 * @ClassName: TaskService
 * @Author: zjy
 * Date: 2020/6/14 11:00
 * project name: quartz
 * @Version:
 * @Description:
 */
public interface TaskService extends IService<Task> {
   

}

2.定时任务接口

package com.quartz.demo.service;

import com.baomidou.mybatisplus.service.IService;
import com.quartz.demo.pojo.AddRequest;
import com.quartz.demo.pojo.ResultBO;
import com.quartz.demo.pojo.TimedTask;

/**
 * @PackgeName: com.quartz.demo.service
 * @ClassName: impl
 * @Author: zjy
 * Date: 2020/6/6 21:07
 * project name: quartz
 * @Version:
 * @Description:
 */
public interface TimedTaskService extends IService<TimedTask> {
   


    /**
     * 添加定时任务
     * @param addRequest
     */
    ResultBO addQuartzJob(AddRequest addRequest);

    /**
     * 删除定时任务
     * @param taskId
     * @return
     */
    ResultBO deleteQuartzJob(Integer taskId) throws Exception;
}

实现类

1.任务实现

package com.quartz.demo.service.impl;

import com.baomidou.mybatisplus.service.impl.ServiceImpl;
import com.quartz.demo.mapper.TaskMapper;
import com.quartz.demo.pojo.Task;
import com.quartz.demo.service.TaskService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

/**
 * @PackgeName: com.quartz.demo.service.impl
 * @ClassName: TaskServiceImpl
 * @Author: zjy
 * Date: 2020/6/14 11:00
 * project name: quartz
 * @Version:
 * @Description:
 */
@Slf4j
@Service
public class TaskServiceImpl extends ServiceImpl<TaskMapper, Task> implements TaskService {
   

}

2.定时任务实现

package com.quartz.demo.service.impl;

import com.baomidou.mybatisplus.service.impl.ServiceImpl;
import com.quartz.demo.config.RemindJob;
import com.quartz.demo.mapper.TimedTaskMapper;
import com.quartz.demo.pojo.AddRequest;
import com.quartz.demo.pojo.ResultBO;
import com.quartz.demo.pojo.Task;
import com.quartz.demo.pojo.TimedTask;
import com.quartz.demo.service.TaskService;
import com.quartz.demo.service.TimedTaskService;
import com.quartz.demo.utils.DateUtils;
import lombok.extern.slf4j.Slf4j;
import org.quartz.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework