Tomcat 核心流程源码分析

一、源码构建

1.1 下载源码

在这里插入图片描述

1.2 源码导入IDE之前准备工作

  1. 解压 tar.gz 压缩包,得到目录 apache-tomcat-8.5.50-src
  2. 在 apache-tomcat-8.5.59-src 源码目录下创建 source 文件夹
  3. confwebapps 目录移动到刚刚创建的 source 文件夹中
  4. 在 apache-tomcat-8.5.59-src 源码目录下创建 pom.xml 文件,文件内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
             http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>apache-tomcat-8.5.50-src</artifactId>
    <name>Tomcat8.5</name>
    <version>8.5</version>
    <build>
        <!--指定源⽬录-->
        <finalName>Tomcat8.5</finalName>
        <sourceDirectory>java</sourceDirectory>
        <resources>
            <resource>
                <directory>java</directory>
            </resource>
        </resources>
        <plugins>
            <!--引⼊编译插件-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <source>11</source>
                    <target>11</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <!--tomcat 依赖的基础包-->
    <dependencies>
        <dependency>
            <groupId>org.easymock</groupId>
            <artifactId>easymock</artifactId>
            <version>3.4</version>
        </dependency>
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.7.0</version>
        </dependency>
        <dependency>
            <groupId>wsdl4j</groupId>
            <artifactId>wsdl4j</artifactId>
            <version>1.6.2</version>
        </dependency>
        <dependency>
            <groupId>javax.xml</groupId>
            <artifactId>jaxrpc</artifactId>
            <version>1.1</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jdt.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.5.1</version>
        </dependency>
        <dependency>
            <groupId>javax.xml.soap</groupId>
            <artifactId>javax.xml.soap-api</artifactId>
            <version>1.4.0</version>
        </dependency>
    </dependencies>
</project>

1.3 导入源码工程到IDEA并进行配置

1.3.1 找到 BootStrap 类 启动 main 方法启动

  这时候控制台乱码参考文章修改两处即可:https://blog.csdn.net/qq_43188744/article/details/107949741

(1)org.apache.tomcat.util.res.StringManager # getString(java.lang.String, java.lang.Object…)

public String getString(final String key, final Object... args) {
	String value = getString(key);
	if (value == null) {
	    value = key;
	}
	
	try {
	    value = new String(value.getBytes(StandardCharsets.ISO_8859_1), StandardCharsets.UTF_8);
	} catch (Exception e) {
	    e.printStackTrace();
	}
	
	MessageFormat mf = new MessageFormat(value);
	mf.setLocale(locale);
	return mf.format(args, new StringBuffer(), null).toString();
}

(2)org.apache.jasper.compiler.Localizer # getMessage(java.lang.String)

public static String getMessage(String errCode) {
    String errMsg = errCode;
    try {
        if (bundle != null) {
            errMsg = bundle.getString(errCode);
        }
    } catch (MissingResourceException e) {
    }

    try {
        errMsg = new String(errMsg.getBytes(StandardCharsets.ISO_8859_1), StandardCharsets.UTF_8);
    } catch (Exception e) {
        e.printStackTrace();
    }

    return errMsg;
}

1.3.2 点击最上方启动类 Bootstrap 选择Edit Configurations

在这里插入图片描述
在这里插入图片描述
点击 VM 添加参数

-Dcatalina.home=F:\ideaWorkerSpace\lagou\tomcat\apache-tomcat-8.5.50-src/source
-Dcatalina.base=F:\ideaWorkerSpace\lagou\tomcat\apache-tomcat-8.5.50-src/source
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file=F:\ideaWorkerSpace\lagou\tomcat\apache-tomcat-8.5.50-src/source/conf/logging.properties

1.3.3 这时候启动tomcat 成功

浏览器输入 localhost:8080 报错:

原因是::Jsp引擎Jasper没有被初始化,从而无法编译JSP
解决:org.apache.catalina.startup.ContextConfig # configureStart 中添加一行
在这里插入图片描述
重启Tomcat,正常访问即可。至此,Tomcat源码构建完毕。

二、核心流程源码剖析

  Tomcat 中的各容器组件都会涉及创建、销毁等,因此设计了生命周期接口 Lifecycle 进行统⼀规范,各容器组件实现该接口。

Lifecycle 生命周期接口主要方法示意
在这里插入图片描述
Lifecycle生命周期接口继承体系示意(仅展示部分重要接口及实现类)

在这里插入图片描述
核心流程源码剖析,源码追踪部分我们关注两个流程:Tomcat启动流程Tomcat请求处理流程

2.1 Tomcat启动流程

在这里插入图片描述

2.1.1 init() 初始化阶段

(1)Bootstrap的main方法:

在这里插入图片描述
(2)Bootstrap的main方法调用 init方法:

在这里插入图片描述
(3)Bootstrap的main方法中调用load方法:

在这里插入图片描述
  从图片可以看出,Bootstrap中的load方法调用Catalina的load方法。

(4)Catalina中的load方法

在这里插入图片描述
  Catalina的load方法首先先初始化Server实例,调用digester的parse(inputSource)方法解析server.xml配置文件,得到Server对象。解析结果如下:

root内容:
在这里插入图片描述
server内容:
在这里插入图片描述
services内容:
在这里插入图片描述
engine内容:

在这里插入图片描述
StandardHost内容:

在这里插入图片描述
得到的内容与解析的server.xml配置文件内容是一致的,server.xml配置文件内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<Server port="8005" shutdown="SHUTDOWN">
	<Listener className="org.apache.catalina.startup.VersionLoggerListener" />
	<!-- Security listener. Documentation at /docs/config/listeners.html
	<Listener className="org.apache.catalina.security.SecurityListener" />
	-->
	<!--APR library loader. Documentation at /docs/apr.html -->
	<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
	<!-- Prevent memory leaks due to use of particular java/javax APIs-->
	<Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
	<Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
	<Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />

  	<GlobalNamingResources>
	    <Resource name="UserDatabase" auth="Container"
	              type="org.apache.catalina.UserDatabase"
	              description="User database that can be updated and saved"
	              factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
	              pathname="conf/tomcat-users.xml" />
  	</GlobalNamingResources>

  	<Service name="Catalina">
  
    	<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
    	<Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />

    	<Engine name="Catalina" defaultHost="localhost">
      		<Realm className="org.apache.catalina.realm.LockOutRealm">
        		<Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/>
      		</Realm>

      	<Host name="localhost"  appBase="webapps" unpackWARs="true" autoDeploy="true">
        	<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log" suffix=".txt" pattern="%h %l %u %t &quot;%r&quot; %s %b" />
      	</Host>
    	</Engine>
    	
  	</Service>
  	
</Server>

  解析实例化Server对象后,在调用Server对象init方法进行初始化,这里使用 Lifecycle 接口定义生命周期相关的接口,由实现类 LifecycleBase 实现生命周期相关的业务,而在实现类 LifecycleBase 中的方法都是定义了模板方法,具体的实现由子类来完成。

LifecycleBase中init()方法

在这里插入图片描述
  所以上述Server的init方法,实际执行的是StandardServer的initInternal()方法

(5)StandardServer的initInternal()方法

在这里插入图片描述
  StandardServer的initInternal()方法中又调用了Serviceinit()方法,通过上述对Lifecycle和LifecycleBase生命周期相关方法的介绍后,我们应该知道Serviceinit()方法最终实现是其实现类StandardServiceinitInternal()方法

(6)StandardService的initInternal()方法

在这里插入图片描述
StandardService的initInternal()方法主要有以下步骤:
  ①、调用engine的init方法进行初始化
  ②、调用executor的init方法进行初始化
  ③、调用connector的init方法进行初始化

①、调用engine的init方法进行初始化,即调用StandardEngineinitInternal()方法,该方法又调用了父类ContainerBaseinitInternal()方法。

StandardEngine

在这里插入图片描述
ContainerBase

在这里插入图片描述
③、调用connector的init方法进行初始化,实际调用的还是Connector的initInternal()方法

在这里插入图片描述
(7)protocolHandler.init(),实际调用的是AbstractProtocolinit()方法

AbstractProtocol

在这里插入图片描述
AbstractEndpoint

在这里插入图片描述
  bind方法的是由子类NioEndpoint提供实现

NioEndpoint

在这里插入图片描述

2.1.2 start() 启动阶段

(1)Bootstrap的start()方法
在这里插入图片描述
  从图中可以看出,Bootstrap的start()方法调用Catalina的start()方法。

(2)Catalina的start()方法

在这里插入图片描述
  Server的start方法,实际调用的父类LifecycleBase的start()方法,该方法中提供模板方法startInternal(),具体实现由子类完成。

LifecycleBase

在这里插入图片描述
(3)StandardServer中的startInternal()方法

在这里插入图片描述
  该方法调用Service的start方法,实际调用的是StandardServicestartInternal()方法

(4)StandardServicestartInternal()方法

在这里插入图片描述
  该方法中分别启动其中的engine和connector

(5)Engine的start(),实际执行的是StandardEnginestartInternal()方法

在这里插入图片描述
  该方法实际调用的是父类ContainerBasestartInternal()方法

在这里插入图片描述
StandardEnginestartInternal()方法调用父类ContainerBasestartInternal()方法,该方法有两个重要步骤:

  • 第一步:查询StandardEngine底下的所有子容器
  • 第二步:启动子容器

(6)Connector的start(),实际执行的是ConnectorstartInternal()方法

Connector
在这里插入图片描述
protocolHandler.start()实际调用的是AbstractProtocolstart方法

(7)AbstractProtocol的start方法

在这里插入图片描述
(8)AbstractEndpoint的start方法
在这里插入图片描述
  具体实现由子类NioEndpoint提供

NioEndpoint
在这里插入图片描述
  NioEndpoint的startInternal()中调用startAcceptorThreads()方法,该方法具体实现在父类AbstractEndpoint

AbstractEndpoint
在这里插入图片描述
  startAcceptorThreads()方法中首先创建Acceptor对象,该对象是一个线程类。接着调用Thread的start()方法启动线程。创建Acceptor流程如下:

NioEndpoint
在这里插入图片描述
在这里插入图片描述

2.2 Tomcat请求处理流程

2.2.1 Mapper组件体系结构

(1)结构图
在这里插入图片描述
  Tomcat使用Mapper(映射的意思,这里不是集合)组件完成url和Host、Context、Wrapper等容器的映射

(2)源代码结构

1)Mapper中有4个重要的内部类,分别是MapElement、MappedHost、MappedContext、MappedWrapper

在这里插入图片描述
2)MappedHost、MappedContext、MappedWrapper的基类MapElement

在这里插入图片描述

3)Mapper类中有MappedHost数组,表示有多个Host

在这里插入图片描述
4)MappedHost中有一个ContextList,ContextList中存放MappedContext数组

在这里插入图片描述
在这里插入图片描述

5)MappedContext中存放ContextVersion数组,每一个ContextVersion中存放MappedWrapper数组,每一个MappedWrapper里面放的是Wrapper对象,也就是Servlet。

在这里插入图片描述

2.2.2 Mapper组件何时初始化的吗?

  在 StandardService 的 startInternal() 方法中调用 mapperListener.start() 中完成 mapper 对象初始化

(1)StandardService中的startInternal()方法

在这里插入图片描述
(2)MapperListener 中 startInternal() 方法,首先查询 Engine 底下的所有Host,在调用 registerHost(host) 进行注册host。

在这里插入图片描述
(3)MapperListener 的 registerHost 方法

在这里插入图片描述
此时Mapper的信息:

在这里插入图片描述
在这里插入图片描述

2.2.3 请求处理流程分析

在这里插入图片描述
(1)connector监听接收请求
(2)调用engine,engine匹配到host
(3)调用host,host匹配到context
(4)调用context,context匹配到wrapper(servlet)
(5)匹配到wrapper(servlet),执行servlet请求

2.2.4 请求处理流程示意图

在这里插入图片描述
(1)入口:NioEndpoint 中 Poller线程的 run() 方法

在这里插入图片描述
(2)Poller的processKey方法:

在这里插入图片描述

(3)启动服务器,从浏览器发起访问请求

在这里插入图片描述
  从(1)(2)步的分析我们知道,一个请求过来后,最终是调用processSocket方法处理具体请求的,所以该请求会进入到AdstractEndpoint的processSocket方法。

(4)AdstractEndpoint的processSocket方法:

在这里插入图片描述
  该方法先得到一个SocketProcessorBase实体,该实体其实是一个线程任务,通过线程池执行该任务。

在这里插入图片描述
  doRun()是一个抽象方法,由子类SocketProcessor完成具体实现

(5)NioEndpoint内部类SocketProcessor中的doRun()方法处理请求

在这里插入图片描述
getHandler()结果:

在这里插入图片描述
(6)ConnectionHandler的process方法:

在这里插入图片描述
(7)AbstractProcessorLight的process方法:

在这里插入图片描述
(8)Http11Processor的service方法:

在这里插入图片描述
(9)CoyoteAdapter的service方法:

在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值