SpringBoot整合Quartz實現定時任務詳解

2022-08-08 14:01:56

Quartz簡介

Quartz 是一個開源的作業排程框架，它完全由 Java 寫成，並設計用於 J2SE 和 J2EE 應用中。它提供了巨大的靈活性而不犧牲簡單性。你能夠用它來為執行一個作業而建立簡單的或複雜的排程。它有很多特徵，如：資料庫支援，叢集，外掛，EJB 作業預構建，JavaMail 及其它，支援 cron-like 表示式等等。

核心概念

主要有三個核心概念：排程器、任務和觸發器。三者關係簡單來說就是，排程器負責排程各個任務，到了某個時刻或者過了一定時間，觸發器觸動了，特定任務便啟動執行。

Scheduler

Scheduler（排程器），基於trigger（觸發器）的設定執行job（任務），代表一個Quartz的獨立執行容器，Trigger和JobDetail要註冊到Scheduler中才會生效，也就是讓排程器知道有哪些觸發器和任務，才能進行按規則進行排程任務。

JobDetail

Quartz 中需要執行的任務詳情，包括了任務的唯一標識和具體要執行的任務，可以通過 JobDataMap 往任務中傳遞資料

Job

Job（任務），封裝成JobDetail設定屬性。

其中有兩個重要註解

@DisallowConcurrentExecution ：禁止並行的執行同一個job定義的多個範例

@PersistJobDataAfterExecution：持久化JobDetail中的JobDataMap（對trigger中的DataMap無效）

Trigger

Trigger（觸發器），描述觸發Job執行的時間觸發規則。有SimpleTrigger和CronTrigger兩個子類代表兩種方式，一種是每隔多少分鐘小時執行，則用SimpleTrigger；另一種是日曆相關的重複時間間隔，如每天凌晨，每週星期一執行的話，通過Cron表示式便可定義出複雜的排程方案。

SpringBoot整合Quartz

準備資料庫表

不同版本的quartz使用的資料庫表不同，具體如下，選擇對應版本即可

https://github.com/quartz-scheduler/quartz/tree/quartz-2.1.x

建立之後，表關係如圖所示

Maven相關依賴

        <!--spring連線驅動時，如com.mysql.cj.jdbc.Driver使用-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--quartz依賴-->
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz-jobs</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>

組態檔

application.yml

spring:
    datasource:
      username: xxx
      password: xxxxxx
      url: jdbc:mysql://localhost:3306/qrtz_db?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
      driver-class-name: com.mysql.cj.jdbc.Driver

spring-quartz.properties

#===================================================================
#設定JobStore
#===================================================================

#JobDataMaps是否都為String型別，預設為false
org.quartz.jobStore.useProperties = false

#表字首
org.quartz.jobStore.tablePrefix = qrtz_

#是否加入叢集
org.quartz.jobStore.isClustered = true

#排程範例失敗的檢查時間間隔 ms
org.quartz.jobStore.clusterCheckinInterval = 5000

org.quartz.jobStore.txIsolationLevelReadCommitted = true

#資料儲存方式為資料持久化
org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX

#資料庫代理類，一般org.quartz.impl.jdbcjobstore.StdJDBCDelegate可以滿足大部分資料庫
org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate

#===================================================================
#設定Scheduler 排程器屬性設定
#===================================================================

#排程標識名叢集中每一個範例都必須使用相同的名稱
org.quartz.scheduler.instanceName = ClusterQuartz

#ID設定為自動獲取每一個必須不同
org.quartz.scheduler.instanceId = AUTO

#===================================================================
#設定ThreadPool
#===================================================================

#執行緒池的實現類(一般使用SimpleThreadPool即可滿足幾乎所有的使用者)
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool

#指定執行緒數，一般設定為1-100之間的整數，根據系統資源設定
org.quartz.threadPool.threadCount = 5

#設定執行緒的優先順序(可以是Thread.MIN_PRIORITY(即1)和Thread.MAX_PRIORITY(10)之間的任何int)
org.quartz.threadPool.threadPriority = 5

quartz設定類

@Configuration
public class SchedulerConfig {
    @Autowired
    private DataSource dataSource;
    @Bean
    public Scheduler scheduler() throws IOException {
        return schedulerFactoryBean().getScheduler();
    }
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean() throws IOException {
        SchedulerFactoryBean factory = new SchedulerFactoryBean();
        factory.setSchedulerName("cluster_scheduler");
        factory.setDataSource(dataSource);
        factory.setApplicationContextSchedulerContextKey("application");
        factory.setQuartzProperties(quartzProperties());
        factory.setTaskExecutor(schedulerThreadPool());
        factory.setStartupDelay(10);
        return factory;
    }
    @Bean
    public Properties quartzProperties() throws IOException {
        PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean();
        propertiesFactoryBean.setLocation(new ClassPathResource("/spring-quartz.properties"));
        propertiesFactoryBean.afterPropertiesSet();
        return propertiesFactoryBean.getObject();
    }
    @Bean
    public Executor schedulerThreadPool(){
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(8);
        executor.setMaxPoolSize(8);
        executor.setQueueCapacity(8);
        return executor;
    }
}

建立任務類

@PersistJobDataAfterExecution
@DisallowConcurrentExecution
public class QuartzJob extends QuartzJobBean {
    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        try {
            Thread.sleep(2000);
            System.out.println(context.getScheduler().getSchedulerInstanceId());
            System.out.println("taskName="+context.getJobDetail().getKey().getName());
            System.out.println("執行時間="+new Date());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

建立監聽類

@Component
public class StartApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
    @Autowired
    private Scheduler scheduler;
    @Override
    public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
        TriggerKey triggerKey = TriggerKey.triggerKey("trigger1","group1");
        try {
            Trigger trigger = scheduler.getTrigger(triggerKey);
            if (trigger == null){
                trigger = TriggerBuilder.newTrigger()
                        .withIdentity(triggerKey)
                        .withSchedule(CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
                        .startNow()
                        .build();
                JobDetail jobDetail = JobBuilder.newJob(QuartzJob.class)
                        .withIdentity("job1","group1")
                        .build();
                scheduler.scheduleJob(jobDetail,trigger);
                scheduler.start();
            }
        } catch (SchedulerException e) {
            e.printStackTrace();
        }
    }
}