+ * 定时任务配置，配置线程池，使用不同线程执行任务，提升效率 + *
+ * + * @package: com.xkcoding.task.config + * @description: 定时任务配置，配置线程池，使用不同线程执行任务，提升效率 + * @author: yangkai.shen + * @date: Created in 2018/11/22 19:02 + * @copyright: Copyright (c) 2018 + * @version: V1.0 + * @modified: yangkai.shen + */ +@Configuration +@EnableScheduling +@ComponentScan(basePackages = {"com.xkcoding.task.job"}) +public class TaskConfig implements SchedulingConfigurer { + @Override + public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { + taskRegistrar.setScheduler(taskExecutor()); + } + + /** + * 这里等同于配置文件配置 + * {@code spring.task.scheduling.pool.size=20} - Maximum allowed number of threads. + * {@code spring.task.scheduling.thread-name-prefix=Job-Thread- } - Prefix to use for the names of newly created threads. + * {@link org.springframework.boot.autoconfigure.task.TaskSchedulingProperties} + */ + @Bean + public Executor taskExecutor() { + return new ScheduledThreadPoolExecutor(20, new BasicThreadFactory.Builder().namingPattern("Job-Thread-%d").build()); + } +} +``` + +## TaskJob.java + +```java +/** + *+ * 定时任务 + *
+ * + * @package: com.xkcoding.task.job + * @description: 定时任务 + * @author: yangkai.shen + * @date: Created in 2018/11/22 19:09 + * @copyright: Copyright (c) 2018 + * @version: V1.0 + * @modified: yangkai.shen + */ +@Component +@Slf4j +public class TaskJob { + + /** + * 按照标准时间来算，每隔 10s 执行一次 + */ + @Scheduled(cron = "0/10 * * * * ?") + public void job1() { + log.info("【job1】开始执行：{}", DateUtil.formatDateTime(new Date())); + } + + /** + * 从启动时间开始，间隔 2s 执行 + * 固定间隔时间 + */ + @Scheduled(fixedRate = 2000) + public void job2() { + log.info("【job2】开始执行：{}", DateUtil.formatDateTime(new Date())); + } + + /** + * 从启动时间开始，延迟 5s 后间隔 4s 执行 + * 固定等待时间 + */ + @Scheduled(fixedDelay = 4000, initialDelay = 5000) + public void job3() { + log.info("【job3】开始执行：{}", DateUtil.formatDateTime(new Date())); + } +} +``` + +## application.yml + +```yaml +server: + port: 8080 + servlet: + context-path: /demo +# 下面的配置等同于 TaskConfig +#spring: +# task: +# scheduling: +# pool: +# size: 20 +# thread-name-prefix: Job-Thread- +``` + +## 参考 + +- Spring Boot官方文档：https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-task-execution-scheduling \ No newline at end of file diff --git a/spring-boot-demo-task/pom.xml b/spring-boot-demo-task/pom.xml index ef03feb..9405fc6 100644 --- a/spring-boot-demo-task/pom.xml +++ b/spring-boot-demo-task/pom.xml @@ -25,7 +25,23 @@+ * 启动器 + *
+ * + * @package: com.xkcoding.task + * @description: 启动器 + * @author: yangkai.shen + * @date: Created in 2018/11/22 19:00 + * @copyright: Copyright (c) 2018 + * @version: V1.0 + * @modified: yangkai.shen + */ @SpringBootApplication public class SpringBootDemoTaskApplication { diff --git a/spring-boot-demo-task/src/main/java/com/xkcoding/task/config/TaskConfig.java b/spring-boot-demo-task/src/main/java/com/xkcoding/task/config/TaskConfig.java new file mode 100644 index 0000000..43ec481 --- /dev/null +++ b/spring-boot-demo-task/src/main/java/com/xkcoding/task/config/TaskConfig.java @@ -0,0 +1,46 @@ +package com.xkcoding.task.config; + +import org.apache.commons.lang3.concurrent.BasicThreadFactory; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; +import org.springframework.scheduling.annotation.EnableScheduling; +import org.springframework.scheduling.annotation.SchedulingConfigurer; +import org.springframework.scheduling.config.ScheduledTaskRegistrar; + +import java.util.concurrent.Executor; +import java.util.concurrent.ScheduledThreadPoolExecutor; + +/** + *+ * 定时任务配置，配置线程池，使用不同线程执行任务，提升效率 + *
+ * + * @package: com.xkcoding.task.config + * @description: 定时任务配置，配置线程池，使用不同线程执行任务，提升效率 + * @author: yangkai.shen + * @date: Created in 2018/11/22 19:02 + * @copyright: Copyright (c) 2018 + * @version: V1.0 + * @modified: yangkai.shen + */ +@Configuration +@EnableScheduling +@ComponentScan(basePackages = {"com.xkcoding.task.job"}) +public class TaskConfig implements SchedulingConfigurer { + @Override + public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { + taskRegistrar.setScheduler(taskExecutor()); + } + + /** + * 这里等同于配置文件配置 + * {@code spring.task.scheduling.pool.size=20} - Maximum allowed number of threads. + * {@code spring.task.scheduling.thread-name-prefix=Job-Thread- } - Prefix to use for the names of newly created threads. + * {@link org.springframework.boot.autoconfigure.task.TaskSchedulingProperties} + */ + @Bean + public Executor taskExecutor() { + return new ScheduledThreadPoolExecutor(20, new BasicThreadFactory.Builder().namingPattern("Job-Thread-%d").build()); + } +} diff --git a/spring-boot-demo-task/src/main/java/com/xkcoding/task/job/TaskJob.java b/spring-boot-demo-task/src/main/java/com/xkcoding/task/job/TaskJob.java new file mode 100644 index 0000000..dfbc912 --- /dev/null +++ b/spring-boot-demo-task/src/main/java/com/xkcoding/task/job/TaskJob.java @@ -0,0 +1,52 @@ +package com.xkcoding.task.job; + +import cn.hutool.core.date.DateUtil; +import lombok.extern.slf4j.Slf4j; +import org.springframework.scheduling.annotation.Scheduled; +import org.springframework.stereotype.Component; + +import java.util.Date; + +/** + *+ * 定时任务 + *
+ * + * @package: com.xkcoding.task.job + * @description: 定时任务 + * @author: yangkai.shen + * @date: Created in 2018/11/22 19:09 + * @copyright: Copyright (c) 2018 + * @version: V1.0 + * @modified: yangkai.shen + */ +@Component +@Slf4j +public class TaskJob { + + /** + * 按照标准时间来算，每隔 10s 执行一次 + */ + @Scheduled(cron = "0/10 * * * * ?") + public void job1() { + log.info("【job1】开始执行：{}", DateUtil.formatDateTime(new Date())); + } + + /** + * 从启动时间开始，间隔 2s 执行 + * 固定间隔时间 + */ + @Scheduled(fixedRate = 2000) + public void job2() { + log.info("【job2】开始执行：{}", DateUtil.formatDateTime(new Date())); + } + + /** + * 从启动时间开始，延迟 5s 后间隔 4s 执行 + * 固定等待时间 + */ + @Scheduled(fixedDelay = 4000, initialDelay = 5000) + public void job3() { + log.info("【job3】开始执行：{}", DateUtil.formatDateTime(new Date())); + } +} \ No newline at end of file diff --git a/spring-boot-demo-task/src/main/resources/application.properties b/spring-boot-demo-task/src/main/resources/application.properties deleted file mode 100644 index e69de29..0000000 diff --git a/spring-boot-demo-task/src/main/resources/application.yml b/spring-boot-demo-task/src/main/resources/application.yml new file mode 100644 index 0000000..5105cc3 --- /dev/null +++ b/spring-boot-demo-task/src/main/resources/application.yml @@ -0,0 +1,11 @@ +server: + port: 8080 + servlet: + context-path: /demo +# 下面的配置等同于 TaskConfig +#spring: +# task: +# scheduling: +# pool: +# size: 20 +# thread-name-prefix: Job-Thread- \ No newline at end of file