springboot工程tomcat源码解析以及虚拟线程升级

1.背景

jdk21有一个很强的特性——虚拟线程，使用虚拟线程一般能提升系统在io密集型的场景的吞吐量。springboot3.2.x能通过简单的配置开启全局的虚拟线程，

但是公司所使用的springboot版本还比较低，为了在低版本中升级虚拟线程，在此基于springboot2.x版本下梳理tomcat的相关链路，以实现线程池的升级。

2.概述

在Tomcat中，请求被封装成一个任务（task）并提交给线程池处理的逻辑简单描述为：

Tomcat通过不同的Connector 和其对应的 ProtocolHandler来 处理进来的请求。对于基于NIO的Connector（如 NioEndpoint ），它会在接收到请求后，将该请求封装成一个任务，并由线程池执行。

对于Tomcat 8及以后的版本，以下是一些关键组件和概念：

• Connector : 负责接收来自客户端的请求，并且可以有不同的实现，例如基于NIO的NioConnector
• ProtocolHandler 和 Endpoint : 这些组件负责处理底层的通信协议和网络I/O，对于NIO，Tomcat使用 NioEndpoint 类，请求在网络层被接收，并封装为SocketChannel，随后被传递给线程池处理。
• Executor: Tomcat允许配置自定义的线程池（Executor），它通过Executor接口实现，当使用NIO等基于非阻塞IO模型时，NioEndpoint 会利用配置的线程池来处理请求。
• Processor: 一旦连接被接受，Tomcat会实例化一个Processor（如Http11Processor），负责解析HTTP请求、处理请求并准备HTTP响应。

在NioEndpoint内部，关键的流程是：

1. NioEndpoint接收到网络请求，并将其包装为一个task
2. 这个task随后被提交到配置的Executor（线程池）执行
3. 线程池中的线程取得task，并交给对应的Processor处理

3. tomcat接收、处理请求的核心代码

说明：代码分析使用的是springboot2.x版本，对应的tomcat版本为 8.5.34；经验证sprigboot1.x 流程大同小异，不做赘述

大体流程为：Acceptor接收网络连接请求，Poller处理对应channel上的io事件，之后将接收的信息封装成task并提交到线程池中。具体的代码分析如下：

通过 org.apache.tomcat.util.net.NioEndpoint.Acceptor 监听服务端的端口，接受客户端的连接请求。每当有新的连接请求到达时，

Acceptor 会接受这个连接请求，并将得到的SocketChannel 代表的连接注册到 Selector 上，然后这些连接将由Poller来进一步处理。

org.apache.tomcat.util.net.NioEndpoint.Acceptor#run

将poller注册到channel上：

org.apache.tomcat.util.net.NioEndpoint#setSocketOptions

通过 org.apache.tomcat.util.net.NioEndpoint.Poller 负责处理所有注册到Selector上的连接的IO事件，比如读事件和写事件。

可以发现pollo对象实际也是一个线程任务（Runnable的实现类），创建时持有 Selector 对象，在其run方法中进行网络监听

org.apache.tomcat.util.net.NioEndpoint.Poller#run

在java的网路编程api中，若有网络事件，则封装为 selectionKey ， Poller#processKey() 进行具体的网络事件处理：
org.apache.tomcat.util.net.NioEndpoint.Poller#processKey

之后将请求封装成task，并提交线程池：
org.apache.tomcat.util.net.AbstractEndpoint#processSocket

4.关键实例的创建

4.1 梦开始的地方

springboot项目有一个 ServletWebServerApplicationContext 对象，其中的 onRefresh() 方法触发了创建webServer的流程
org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext#onRefresh

org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext#createWebServer

从此处开始了 tomcat的实例化、初始化
ServletWebServerFactory 有着不同servlet容器的实现

4.2 TomcatServletWebServerFactory

TomcatServletWebServerFactory 是tomcat对 ServletWebServerFactory 的实现，其具体的 getWebServer() 方法实现为：

配置connector的信息 ：
org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory#customizeConnector

一个tomcat可以配置多各connector，每个connector监听一个端口的信息

上述的getWebServer() 的最后调用 TomcatServletWebServerFactory#getTomcatWebServer() 方法，启动tomcat初始化流程

4.3 初始化connector

此时创建了 ProtocolHandler 对象，其中：

ProtocolHandler 的抽象类 AbstractProtocol 中持有 AbstractEndpoint 对象，而AbstractEndpoint 的实例持有 线程池对象 org.apache.tomcat.util.net.AbstractEndpoint#executor

实际上各 ProtocolHandler 实例是委托 endpoint 封装具体的任务，并提交给线程池处理。

从上述提到的TomcatWebServer#initialize()方法，一路执行到
org.apache.tomcat.util.net.NioEndpoint#startInternal

tomcat中创建内置线程池的关键方法：
org.apache.tomcat.util.net.AbstractEndpoint#createExecutor

5.最佳实践

5.1 springboot2.x tomcat升级虚拟线程

@Configuration 
public class TomcatConfig { 
   
    @Bean 
    public ServletWebServerFactory servletWebServerFactory() { 
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory(); 
        tomcat.addConnectorCustomizers(connector -> { 
            if (connector.getProtocolHandler() instanceof Http11NioProtocol) { 
                Http11NioProtocol protocolHandler = (Http11NioProtocol) connector.getProtocolHandler(); 
                protocolHandler.setExecutor(Executors.newVirtualThreadPerTaskExecutor()); 
            } 
        }); 
        return tomcat; 
    } 
}

验证线程类型： Thread.currentThread()

5.2 springboot1.x tomcat升级虚拟线程

@Configuration 
public class TcAuthTomcatConfig { 
     
    @Bean 
    public EmbeddedServletContainerFactory servletContainerFactory() { 
        TomcatEmbeddedServletContainerFactory servletContainerFactory = new TomcatEmbeddedServletContainerFactory(); 
   
        servletContainerFactory.addConnectorCustomizers(connector -> { 
            if (connector.getProtocolHandler() instanceof Http11NioProtocol) { 
                Http11NioProtocol handler = (Http11NioProtocol) connector.getProtocolHandler(); 
                handler.setExecutor(Executors.newVirtualThreadPerTaskExecutor()); 
            } 
        }); 
        return servletContainerFactory; 
    } 
}

6.其它参数的影响

通过上述方式替换了具体的线程池，但源码中还有很多 connector 相关的参数，且一般都有默认值，这些 connector 参数是否影响虚拟线程呢？以下进行逐一梳理。

6.1 maxThreads

参数： org.apache.tomcat.util.net.AbstractEndpoint#maxThreads

ExecutorService executor = Executors.newVirtualThreadPerTaskExecutor();
boolean flag = executor instanceof java.util.concurrent.ThreadPoolExecutor;

经测试，上述flag值为false，因此不会影响。

6.2 maxConnections

参数： org.apache.tomcat.util.net.AbstractEndpoint#maxConnections

该参数限制了tomcat的最大连接数，在acceptor中起作用，参见：
org.apache.tomcat.util.net.NioEndpoint.Acceptor#run

该参数跟线程池没什么关系