springboot如何配置线程池实现定时任务

一、步骤概览

二、步骤说明

1.封装自定义线程池

封装自定义线程池类是为了在线程执行完毕后，我们检查是否存在异常,如果存在异常，日志打印详细异常信息，这样可以可以帮助我们及时发现和解决问题。

JDK 默认提供的定时调度线程池类是ScheduledThreadPoolExecutor，我们只需要继承它并重写它的 afterExecute 方法，添加异常日志打印的逻辑。

• MyScheduledThreadPoolExecutor

public class MyScheduledThreadPoolExecutor extends ScheduledThreadPoolExecutor {
    private Logger log = LoggerFactory.getLogger(MyScheduledThreadPoolExecutor.class);

    public MyScheduledThreadPoolExecutor(int corePoolSize, ThreadFactory factory) {
        super(corePoolSize, factory);
    }

    @Override
    protected void afterExecute(Runnable r, Throwable t) {
        super.afterExecute(r, t);
        // 打印异常信息
        this.printException(r, t);
    }

    public void printException(Runnable r, Throwable t) {
        // 判断 r 是 Future 实例并且已经完成执行的情况下,获取它的执行结果，并检查是否有异常抛出
        if (t == null && r instanceof Future) {
            try {
                Future future = (Future) r;
                if (future.isDone()) {
                    future.get();
                }
            } catch (CancellationException ce) {
                t = ce;
            } catch (ExecutionException ee) {
                t = ee.getCause();
            } catch (InterruptedException ie) {
                Thread.currentThread().interrupt();
            }
        }
        if (t != null) {
            log.error(t.getMessage(), t);
        }
    }
}

2.定义调度配置

创建 ScheduleConfig 类，用于配置定时调度的执行器。代码概览如图所示：

① 创建定时调度线程池

使用自定义封装的线程池类，创建线程池，指定线程池创建线程名前缀，并将其设置成应用程序的守护线程。

• ScheduleConfig#taskExecutor

@Bean(destroyMethod="shutdown")
public ExecutorService taskExecutor() {
  ThreadFactory factory = new BasicThreadFactory.Builder()
    .namingPattern("schedule-pool-%d")
    .daemon(true)
    .build();

  return new MyScheduledThreadPoolExecutor(10, factory);
}

② 设置任务调度器

实现 SchedulingConfigurer 接口,重写 configureTasks 方法，允许我们对任务调度进行自定义配置，这边我们将我们自定义创建的线程池设置成任务调度器。

• ScheduleConfig#configureTasks

@Configuration
public class ScheduleConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        // 自定义线程池作为调度器
        taskRegistrar.setScheduler(taskExecutor());
    }
}

3.启用调度

在应用启动类上添加注解 `@EnableScheduling`,用于启用定时调度，操作如图所示：

4.注解标记调度策略

在我们需要定时执行的方法上使用相关注解，标记其调度策略。

①.固定时间执行

如果需要在固定的时间点执行任务，可以使用 @Scheduled(cron = "表达式") 注解来指定 cron 表达式，如下所示：

@Component
public class MyTask {
    @Scheduled(cron = "0 0 12 * * ?")
    public void runTask() {
        // 在每天中午 12 点执行任务
    }
}

其中 cron 表达式使用说明如下表格所示

② 间隔执行

如果需要在固定的时间间隔内周期性地执行任务，可以使用 @Scheduled(fixedRate = 时间间隔) 或 @Scheduled(fixedDelay = 时间间隔) 注解来指定时间间隔，如下所示：

@Component
public class MyTask {
    @Scheduled(fixedRate = 5000)
    public void runTask() {
        // 每 5 秒执行一次任务
    }
}

③延迟执行

如果需要在应用启动后延迟一段时间后执行任务，可以使用 @Scheduled(initialDelay = 延迟时间) 注解来指定延迟时间，如下所示：

@Component
public class MyTask {
    @Scheduled(initialDelay = 5000, fixedRate = 5000)
    public void runTask() {
        // 在应用启动后延迟 5 秒执行任务，之后每 5 秒执行一次任务
    }
}

三、代码测试

我们就以间隔执行进行测试，测试方法每3秒执行一次。

1.测试代码

@Slf4j
@Service
public class FixedDelayTask {
    private static int count1 = 1;

    @Scheduled(fixedDelay = 3000)
    public void fixedDelay() {
        log.info(String.format("第%s次执行", count1++));
    }
}

2.测试结果

两次执行相隔3秒钟,并且线程名也是以我们自定义的为前缀。