Support config a seperate datasource for quartz

Author: ruanwenjun

dolphinscheduler-master/src/main/resources/application.yaml

@@ -67,6 +67,13 @@ mybatis-plus:
       id-type: auto
     banner: false
 
+scheduler-plugin:
+  quartz:
+    # By default, will not use a separate datasource for quartz
+    # If you want to use a separate datasource, set it to true and configure the datasource below
+    # If set true, and you do not configure hikari below, it will use the same configuration as spring.datasource.hikari
+    using-separate-datasource: false
+    # hikari:
 
 registry:
   type: zookeeper

dolphinscheduler-scheduler-plugin/dolphinscheduler-scheduler-quartz/README.md

@@ -0,0 +1,46 @@
+# Introduction
+
+This module is the quartz-scheduler plugin module, this plugin will use quartz as the scheduler.
+
+# How to use
+
+By default, you don't need to do any configuration, the quartz-scheduler use the same datasource with master.
+
+```yaml
+scheduler-plugin:
+  quartz:
+    # By default, will not use a separate datasource for quartz
+    # If you want to use a separate datasource, set it to true and configure the datasource below
+    # If set true and you do not configure hikari below, it will use the same configuration as spring.datasource.hikari
+    using-separate-datasource: false
+    # hikari:
+```
+
+## Use a separate datasource for quartz-scheduler
+
+If your have a lot of workflow to be scheduled, it is better to set a separate datasource for quartz-scheduler,
+otherwise the performance of quartz thread may be affected. After set `using-separate-datasource` to true, the
+quartz-scheduler will use a new datasource, and the datasource configuration is same with the master datasource
+configuration.
+
+```yaml
+scheduler-plugin:
+  quartz:
+    using-separate-datasource: true
+```
+
+If you want to use a separate datasource for quartz-scheduler, and set the configuration, you need to configure the
+hikari configuration like below:
+
+```yaml
+scheduler-plugin:
+  quartz:
+    using-separate-datasource: true
+    hikari:
+      jdbc-url: jdbc:mysql://localhost:3306/dolphinscheduler
+      username: root
+      password: root
+      minimum-idle: 8
+      maximum-pool-size: 8
+```
+

dolphinscheduler-scheduler-plugin/dolphinscheduler-scheduler-quartz/src/main/java/org/apache/dolphinscheduler/scheduler/quartz/QuartzSchedulerAutoConfiguration.java

@@ -26,6 +26,8 @@
 import org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration;
 import org.springframework.context.annotation.Bean;
 
+// Right now we only have one implementation of SchedulerApi: QuartzScheduler
+// If we have more implementations in the future, we can use @ConditionalOnProperty to distinguish them, rather than using @ConditionalOnClass
 @AutoConfiguration(after = {QuartzAutoConfiguration.class})
 @ConditionalOnClass(value = Scheduler.class)
 public class QuartzSchedulerAutoConfiguration {

dolphinscheduler-scheduler-plugin/dolphinscheduler-scheduler-quartz/src/main/java/org/apache/dolphinscheduler/scheduler/quartz/QuartzSchedulerDataSourceAutoConfiguration.java

@@ -0,0 +1,84 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.scheduler.quartz;
+
+import java.util.Optional;
+
+import javax.sql.DataSource;
+
+import lombok.Data;
+import lombok.extern.slf4j.Slf4j;
+
+import org.quartz.Scheduler;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration;
+import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.core.annotation.Order;
+import org.springframework.jdbc.datasource.DataSourceTransactionManager;
+
+import com.zaxxer.hikari.HikariConfig;
+import com.zaxxer.hikari.HikariDataSource;
+
+@Slf4j
+@AutoConfiguration(after = {DataSourceAutoConfiguration.class}, before = QuartzSchedulerAutoConfiguration.class)
+@ConditionalOnClass(value = Scheduler.class)
+@ConditionalOnProperty(prefix = "scheduler-plugin.quartz", name = "using-separate-datasource", havingValue = "true")
+@EnableConfigurationProperties(QuartzSchedulerDataSourceAutoConfiguration.QuartzDataSourceConfig.class)
+public class QuartzSchedulerDataSourceAutoConfiguration {
+
+    /**
+     * Initialize After {@link QuartzAutoConfiguration.JdbcStoreTypeConfiguration#dataSourceCustomizer}
+     */
+    @Bean
+    @Order(1)
+    public SchedulerFactoryBeanCustomizer schedulerFactoryBeanCustomizer(QuartzDataSourceConfig quartzDataSourceConfig,
+                                                                         DataSource defaultDataSource) {
+        return schedulerFactoryBean -> {
+            if (!quartzDataSourceConfig.isUsingSeparateDatasource()) {
+                return;
+            }
+            final HikariConfig quartzHikariConfig = Optional.ofNullable(quartzDataSourceConfig.getHikari())
+                    .orElse(generateQuartzHikariConfigFromDataSource((HikariDataSource) defaultDataSource));
+            final HikariDataSource quartzDataSource = new HikariDataSource(quartzHikariConfig);
+            schedulerFactoryBean.setDataSource(quartzDataSource);
+            schedulerFactoryBean.setTransactionManager(new DataSourceTransactionManager(quartzDataSource));
+        };
+    }
+
+    @Data
+    @ConfigurationProperties(prefix = "scheduler-plugin.quartz")
+    public static class QuartzDataSourceConfig {
+
+        private boolean usingSeparateDatasource = false;
+        private HikariConfig hikari;
+    }
+
+    private HikariConfig generateQuartzHikariConfigFromDataSource(HikariDataSource hikariDataSource) {
+        HikariConfig defaultQuartzHikariConfig = new HikariConfig();
+        hikariDataSource.copyStateTo(defaultQuartzHikariConfig);
+        defaultQuartzHikariConfig.setPoolName("QuartzHikariCP");
+        return defaultQuartzHikariConfig;
+    }
+
+}

dolphinscheduler-scheduler-plugin/dolphinscheduler-scheduler-quartz/src/main/resources/META-INF/spring.factories

@@ -16,4 +16,5 @@
 #
 
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+  org.apache.dolphinscheduler.scheduler.quartz.QuartzSchedulerDataSourceAutoConfiguration,\
   org.apache.dolphinscheduler.scheduler.quartz.QuartzSchedulerAutoConfiguration

dolphinscheduler-standalone-server/src/main/resources/application.yaml

@@ -32,6 +32,9 @@ spring:
       url: jdbc:h2:mem:dolphinscheduler;MODE=MySQL;DB_CLOSE_DELAY=-1;DATABASE_TO_LOWER=true
       username: sa
       password: ""
+      hikari:
+        connection-test-query: select 1
+        pool-name: DolphinSchedulerDataSource
   quartz:
     job-store-type: jdbc
     jdbc:
@@ -67,6 +70,11 @@ spring:
       matching-strategy: ANT_PATH_MATCHER
   cloud.discovery.client.composite-indicator.enabled: false
 
+scheduler-plugin:
+  quartz:
+    using-separate-datasource: false
+    # hikari:
+
 mybatis-plus:
   mapper-locations: classpath:org/apache/dolphinscheduler/dao/mapper/*Mapper.xml
   type-aliases-package: org.apache.dolphinscheduler.dao.entity