# quartz-boot

**Repository Path**: xbd521/quartz-boot

## Basic Information

- **Project Name**: quartz-boot
- **Description**: quartz分布式定时任务Spring Boot版。基于quartz的二次集成，支持集群、支持其它项目开发功能，可脱离xml配置方式，xml配置方式实现动态控制很困难，通过本次集成，可以达到动态控制定时任务启动、暂停、重启、删除、添加、修改等操作，极大地方便了开发过程。欢迎大牛们提出宝贵意见！
- **Primary Language**: Java
- **License**: Artistic-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 301
- **Forks**: 110
- **Created**: 2018-09-05
- **Last Updated**: 2025-05-19

## Categories & Tags

**Categories**: task-schedule

**Tags**: quartz

## README

# quartz

全新2.0版本 [点我直达](https://gitee.com/xbd521/quartz-boot/tree/2.0.x/)

非Spingboot的其它框架，请移步基础框架版[quartz](https://gitee.com/xbd521/quartz)

#### 项目简介

1. 基于quartz的二次集成
2. 支持集群
3. 支持其它web项目进行功能开发
4. 动态控制定时任务启动、暂停、重启、删除、添加、修改
5. 支持多数据库
6. 支持自实现Scheduler、Job、Trigger监听，系统自动注册
7. 支持自主选择Trigger类型，已支持CronTrigger、SimpleTrigger
8. 支持一个Job对应多个Trigger，且可设置不同的Trigger类型
9. 支持Job中Autowired Spring bean
10. 支持JobData自动赋值给Job的成员变量（名称相同）
11. 支持Job、Trigger同时携带JobData

<i>注意：6以后的特性仅2.0.x及以上版本支持</i>

#### 使用教程

1.0.x

1. 引入依赖
2. 修改jdbc.properties数据源配置
3. 继承AbstractQuartzTask，实现自己的定时任务
4. 功能开发
5. 任务展示
6. 调用接口控制任务

2.0.x

1. 引入依赖
2. 选择使用系统数据源、自主数据源
3. 新建Job，且继承自DefaultQuartzJobBean
4. Job中注入Service，实现自己的逻辑
5. 配置到Scheduler中

#### 配置示例
```yaml
sys:
  quartz:
    thread-pool:
      thread-name-prefix: XbdThreadPoolTaskExecutor-
      thread-priority: 5
      daemon: false
      thread-group-name: XbdThreadPoolTaskExecutorGroup
      core-pool-size: 20
      max-pool-size: 50
      keep-alive-seconds: 60
      queue-capacity: 100
      allow-core-thread-timeout: false
      waitfor-tasks-tocomplete-onshutdown: false
      await-termination-seconds: 60 * 15
    scheduler:
      config-location: classpath:quartz.properties
      scheduler-name: demo-scheduler
      application-context-scheduler-contextkey: applicationContext
      overwrite-existing-jobs: true
      auto-startup: true
      startup-delay: 10
```

```java
package com.xbd.quartz.config;

import com.xbd.quartz.AutowiredSpringBeanJobFactory;
import com.xbd.quartz.QuartzListenerRegister;
import com.xbd.quartz.handler.DefaultQuartzTaskHandler;
import org.quartz.Scheduler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.transaction.PlatformTransactionManager;

@Configuration
public class QuartzConfig {

    @Autowired
    private DataSource dataSource;

    @Autowired
    private PlatformTransactionManager transactionManager;

    @Bean
    public QuartzProperties quartzProperties() {
        return new QuartzProperties();
    }

    @Bean
    public ThreadPoolTaskExecutor threadPoolTaskExecutor() {
        ThreadPoolTaskExecutor threadPoolTaskExecutor = new ThreadPoolTaskExecutor();
        threadPoolTaskExecutor.setCorePoolSize(quartzProperties.getThreadPool().getCorePoolSize());
        threadPoolTaskExecutor.setMaxPoolSize(quartzProperties.getThreadPool().getMaxPoolSize());
        threadPoolTaskExecutor.setQueueCapacity(quartzProperties.getThreadPool().getQueueCapacity());

        return threadPoolTaskExecutor;
    }

    @Bean
    public AutowiredSpringBeanJobFactory autowiredSpringBeanJobFactory() {
        AutowiredSpringBeanJobFactory autowiredSpringBeanJobFactory = new AutowiredSpringBeanJobFactory();
        return autowiredSpringBeanJobFactory;
    }

    @Bean
    public SchedulerFactoryBean schedulerFactoryBean() {
        SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();
        schedulerFactoryBean.setConfigLocation(quartzProperties().getScheduler().getConfigLocation());
        // 此处设置数据源之后，会覆盖quartz.properties中的myDS数据源
//        schedulerFactoryBean.setDataSource(dataSource);
        schedulerFactoryBean.setJobFactory(autowiredSpringBeanJobFactory());
        schedulerFactoryBean.setSchedulerName(quartzProperties().getScheduler().getSchedulerName());
        schedulerFactoryBean.setTaskExecutor(threadPoolTaskExecutor());
        schedulerFactoryBean.setTransactionManager(transactionManager);
        schedulerFactoryBean.setApplicationContextSchedulerContextKey(quartzProperties().getScheduler().getApplicationContextSchedulerContextKey());
        schedulerFactoryBean.setOverwriteExistingJobs(quartzProperties().getScheduler().isOverwriteExistingJobs());
        schedulerFactoryBean.setAutoStartup(quartzProperties().getScheduler().isAutoStartup());
        schedulerFactoryBean.setStartupDelay(quartzProperties().getScheduler().getStartupDelay());

        return schedulerFactoryBean;
    }

    @Bean
    public Scheduler scheduler() {
        return schedulerFactoryBean().getObject();
    }

    @Bean
    public QuartzListenerRegister quartzListenerRegister() {
        QuartzListenerRegister quartzListenerRegister = new QuartzListenerRegister();
        quartzListenerRegister.setScheduler(scheduler());
        return quartzListenerRegister;
    }

    @Bean
    public DefaultQuartzTaskHandler defaultQuartzTaskHandler() {
        DefaultQuartzTaskHandler defaultQuartzTaskHandler = new DefaultQuartzTaskHandler();
        defaultQuartzTaskHandler.setScheduler(scheduler());
        return defaultQuartzTaskHandler;
    }
}
```

#### 使用说明

1. QuartzTaskHandler 任务处理接口，其中有添加、修改、删除、暂停、重启等功能
2. AbstractSchedulerListener Scheduler监听，可自行实现自己需要的Scheduler监听
3. AbstractJobListener Job监听，可自行实现自己需要的Job监听
4. AbstractTriggerListener Trigger监听，可自行实现自己需要的Trigger监听

#### 版权说明
quartz使用 [Apache License 2.0](https://gitee.com/xbd521/quartz-boot/blob/master/LICENSE "Apache License 2.0") 协议