add jobs tool for run scheduler jobs in app

Author: PouyaPouryaie

README.md

@@ -2,6 +2,15 @@
 
 This project, implement instance of basic feature, <br> you maybe want use for App base on Spring-boot <br>
 
+### Note for upgrade to 2.4.X 
+1) for active profile config: <br>
+for before 2.4.x you can activate profile in pom file and add <b>@spring.profiles.active@</b> in application.properties <br>
+and then properties apply in project base on profile that active. <br>
+for 2.4.x or above
+    - if you want to use same as old solution you must add ```spring.config.use-legacy-processing=true``` in application.properties
+    - if you want to migrate in new approach please check https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-Config-Data-Migration-Guide
+
+
 ## Features: 
 - spring-web
 - spring-jpa
@@ -30,6 +39,8 @@ This project, implement instance of basic feature, <br> you maybe want use for A
     - use CriteriaQuery and CriteriaBuilder for search base on Entity
 - jasypt
     - use for encrypt password and added to config file, then decrypted pass in runtime
+- Jobs
+    - use Spring TaskScheduler for run jobs 
 
 ## Run guide
 ### Run for develop and debug: <br>
@@ -109,3 +120,11 @@ hikari.dataSource.password="ENC({output})"
 ~~~
 --jasypt.encryptor.password={secret-key}
 ~~~
+
+### Jobs Run Tool
+1 - define class implement Runnable in order to execute job base on schedule 
+2 - define bean (AlertServiceJob) in BeanConfig class for your jobs
+3 - define trigger time in properties ```(ex: app.jobs.alertServiceJob=0 */1 * ? * *)``` file
+4 - @EnableScheduling on SpringApp
+
+notice: that name of bean in BeanConfig must be equal with name of key in properties file.

src/main/java/ir/bigz/springbootreal/configuration/AppProperties.java

@@ -0,0 +1,16 @@
+package ir.bigz.springbootreal.configuration;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@Component
+@ConfigurationProperties("app")
+@Data
+public class AppProperties {
+
+    private Map<String, String> jobs = new HashMap<>();
+}

src/main/java/ir/bigz/springbootreal/configuration/BeanConfig.java

@@ -0,0 +1,26 @@
+package ir.bigz.springbootreal.configuration;
+
+import ir.bigz.springbootreal.service.AlertServiceJob;
+import ir.bigz.springbootreal.service.UserService;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.TaskScheduler;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
+
+@Configuration
+public class BeanConfig {
+
+    @Bean("taskScheduler")
+    public TaskScheduler taskScheduler(){
+        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
+        scheduler.setPoolSize(10);
+        scheduler.setThreadNamePrefix("scheduled-task-");
+        scheduler.setDaemon(true);
+        return scheduler;
+    }
+
+    @Bean("alertServiceJob")
+    public AlertServiceJob alertServiceJob(UserService userService){
+        return new AlertServiceJob(userService);
+    }
+}

src/main/java/ir/bigz/springbootreal/configuration/HikariDataSourceInit.java

@@ -16,12 +16,12 @@
 /**
  * {@link HikariDataSourceInit} use for build connection-pool base on HikariCp with customize properties,
  * and then added to {@link DataSourceConfiguration} class as datasource for use in app.
- * also if you want use for production uncomment line 32 and comment line 33 and 34
- * and if you want test with testContainer uncomment line 33 and 34 and comment line 32
+ * also if you want use for production uncomment line 41 and comment line 42 and 43
+ * and if you want test with testContainer uncomment line 42 and 43 and comment line 41
  *
  * DataBase password encryption with JASYPT:
  * first of all use jasypt to encrypted db-password and added into application.properties file,
- * then uncomment line 34 (encryptorPassword)
+ * then uncomment line 37 (encryptorPassword)
  * at the end add --jasypt.encryptor.password={secret-key} in program environment
  */
 
@@ -38,9 +38,9 @@ public class HikariDataSourceInit{
 
     @Bean(name = "HikariDataSourceInit")
     public DataSource dataSource(){
-       HikariConfig hikariConfig = new HikariConfig(hikariProperties()); // use for production
-        // HikariConfig hikariConfig = new HikariConfig();
-        // hikariConfig.setDataSource(InitDataSource());
+//       HikariConfig hikariConfig = new HikariConfig(hikariProperties()); // use for production
+         HikariConfig hikariConfig = new HikariConfig();
+         hikariConfig.setDataSource(InitDataSource());
         int cpuCores = Runtime.getRuntime().availableProcessors();
         hikariConfig.setMaximumPoolSize(cpuCores * 4);
         hikariConfig.setConnectionTimeout(Long.parseLong(env.getProperty("hikari.connectionTimeout")));

src/main/java/ir/bigz/springbootreal/configuration/JobsConfig.java

@@ -0,0 +1,30 @@
+package ir.bigz.springbootreal.configuration;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.TaskScheduler;
+import org.springframework.scheduling.annotation.EnableScheduling;
+import org.springframework.scheduling.support.CronTrigger;
+
+@Slf4j
+@Configuration
+@EnableScheduling
+public class JobsConfig {
+
+    public JobsConfig(ApplicationContext applicationContext,
+                      @Qualifier("taskScheduler") TaskScheduler taskScheduler,
+                      AppProperties appProperties) {
+        for (var e: appProperties.getJobs().entrySet()){
+            var bean = (Runnable) applicationContext.getBean(e.getKey());
+            if(bean == null){
+                log.error("Job {} is not registered", e.getKey());
+            }
+            else {
+                log.info("Job {} is registered as cron {}", e.getKey(), e.getValue());
+                taskScheduler.schedule(bean::run, new CronTrigger(e.getValue()));
+            }
+        }
+    }
+}

src/main/java/ir/bigz/springbootreal/service/AlertServiceJob.java

@@ -0,0 +1,22 @@
+package ir.bigz.springbootreal.service;
+
+import ir.bigz.springbootreal.viewmodel.UserModel;
+import org.springframework.beans.factory.annotation.Autowired;
+
+import java.util.List;
+
+public class AlertServiceJob implements Runnable {
+
+    private final UserService userService;
+
+    @Autowired
+    public AlertServiceJob(UserService userService) {
+        this.userService = userService;
+    }
+
+    @Override
+    public void run() {
+        List<UserModel> all = userService.getAll();
+        System.out.println("count of data is " + all.size());
+    }
+}

src/main/resources/application-dev.properties

@@ -35,3 +35,7 @@ [email protected]@
 springdoc.swagger-ui.path=/swagger-ui.html
 springdoc.api-docs.path=/api-docs
 springdoc.use-fqn=true
+
+
+################### Application Jobs Schedule ##########################
+app.jobs.alertServiceJob=0 */1 * ? * *

src/main/resources/application-docker.properties

@@ -39,4 +39,7 @@ [email protected]@
 application-version=@project.version@
 springdoc.swagger-ui.path=/swagger-ui.html
 springdoc.api-docs.path=/api-docs
-springdoc.use-fqn=true
+springdoc.use-fqn=true
+
+################### Application Jobs Schedule ##########################
+app.jobs.alertServiceJob=0 */1 * ? * *

src/main/resources/application.properties

@@ -1 +1,2 @@
+spring.config.use-legacy-processing=true
 spring.profiles.active[email protected]@