SpringBoot - 简单定时任务

逃离我推掉我的手 2023-10-12 23:21 108阅读 0赞

## 定义配置文件（application.yml） ##

server:
      port: 8080
      servlet:
        context-path: /
    # 下面的配置等同于 config/TaskConfig
    #spring:
    #  task:
    #    scheduling:
    #      pool:
    #        size: 20
    #      thread-name-prefix: Job-Thread-

## 定义定时任务 ##

package com.lfsun.springboottask.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;
    
    /**
     * <p>
     * 定时任务
     * </p>
     */
    @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()));
        }
    }

## 定时任务的配置 ##

package com.lfsun.springboottask.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;
    
    /**
     * <p>
     * 定时任务配置，配置线程池，使用不同线程执行任务，提升效率
     * </p>
     */
    @Configuration
    @EnableScheduling
    @ComponentScan(basePackages = {
        "com.lfsun.springboottask.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());
        }
    }

## 完整代码案例地址 ##

[Spring Boot 集成 简单定时任务][Spring Boot _]

[Spring Boot _]: https://gitee.com/lfsun666/springboot-study-2023