返回

用SpringBoot构建一个可观测、易用的线程池

后端

好文共享：用SpringBoot构建一个可观测、易用的线程池


在开发SpringBoot应用服务时，难免会使用到异步任务和线程池。SpringBoot的线程池是可以自定义的，所以我们经常会在项目中看到类似于下面这样的代码：

@Bean
public ExecutorService taskExecutor() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setCorePoolSize(5);
    executor.setMaxPoolSize(10);
    executor.setQueueCapacity(25);
    return executor;
}

使用起来很方便，但是这样做有几个缺点：

  1. 线程池的配置分散在不同的类中，不易管理和维护。
  2. 线程池的监控和管理不够方便，无法及时发现和解决问题。

为了解决这些问题，我们可以使用SpringBoot提供的Actuator模块来构建一个可观测、易用的线程池。

一、配置线程池

首先，我们需要在application.yml文件中配置线程池：

spring:
  task:
    execution:
      pool:
        core-size: 5
        max-size: 10
        queue-capacity: 25

这将会创建一个具有5个核心线程、10个最大线程和25个队列容量的线程池。

二、添加Actuator依赖

然后，我们需要在项目中添加Actuator的依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

三、配置Actuator端点

接下来，我们需要在application.yml文件中配置Actuator端点：

management:
  endpoints:
    web:
      exposure:
        include: threaddump, info, health, metrics, beans, env, httptrace

这将会暴露一些Actuator端点，包括线程转储端点（threaddump）、信息端点（info）、健康端点（health）、指标端点（metrics）、Bean端点（beans）、环境端点（env）和HTTP跟踪端点（httptrace）。

四、访问Actuator端点

现在，我们可以使用浏览器或HTTP客户端访问这些Actuator端点。例如，我们可以使用以下URL访问线程转储端点：

http://localhost:8080/actuator/threaddump

这将会显示当前线程池的状态，包括线程ID、线程名称、线程状态、堆栈跟踪等信息。

五、使用Micrometer监控线程池

除了使用Actuator端点监控线程池之外，我们还可以使用Micrometer来监控线程池。Micrometer是一个开源的应用程序性能监控（APM）框架，它可以轻松地将应用程序的指标暴露给监控系统。

要使用Micrometer监控线程池，我们需要在项目中添加Micrometer的依赖：

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-core</artifactId>
</dependency>

然后，我们需要在Spring Boot应用中注册Micrometer：

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public MeterRegistry meterRegistry() {
        return new SimpleMeterRegistry();
    }
}

接下来，我们需要在SpringBoot应用中添加一个ThreadPoolTaskExecutor的Bean，并使用Micrometer对其进行监控：

@Bean
public ExecutorService taskExecutor() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setCorePoolSize(5);
    executor.setMaxPoolSize(10);
    executor.setQueueCapacity(25);

    executor.setMetricRegistry(meterRegistry());

    return executor;
}

现在，我们就可以使用Micrometer来监控线程池的指标了。例如，我们可以使用以下命令来查看线程池的活动线程数：

curl http://localhost:8080/actuator/metrics/thread.active | jq '.measurements[] | select(.tags.pool == "taskExecutor") | .value'

这将会输出线程池的活动线程数。

总结

使用SpringBoot和Actuator可以轻松地构建一个可观测、易用的线程池。我们可以使用Actuator端点来监控线程池的状态，也可以使用Micrometer来监控线程池的指标。这样，我们就可以及时发现和解决线程池的问题，确保应用程序的稳定运行。