搭建Tomcat原始碼閱讀環境，無bug運行除錯。答應我，和我一起學習Tomcat，不要放棄！-有解無憂

文章目錄

- 一、前言
- 二、運行Tomcat原始碼
- - 1、下載原始碼
  - 2、Tomcat8.5.9原始碼運行
  - - （1）新建pom.xml
    - （2）替換webapps和加 lib 包
    - （3）運行Bootstrap#main
    - （4）運行并訪問
    - （5）-config指定配置路徑運行
  - 3、Tomcat10.0.6原始碼運行
- 三、搭建原始碼閱讀環境
- 四、總結：如何閱讀原始碼

一、前言

（前言啰嗦了幾句，可直接跳過，看原始碼運行搭建）

Tomcat，一個熟悉而又陌生的運行web的工具，平時新搭建一個web專案，就是照著已有的專案復制改改，遇到問題就百度，調個引數，改個路徑，就能解決，

但是，組態檔中這個引數是什么作用？檔案為什么要放在這個路徑下？一無所知！有時候百度很久也解決不了，一耗就是幾天，效率很低，要是懂原始碼就好了，于是下定決心，一定要徹底搞懂Tomcat原始碼，

找書來看，書寫的很好：先從整體架構開始介紹，Tomcat由連接器和容器組成，server、service、Host，Context，各種容器嵌套直接給整懵了，看了半天書，啥也記不住，打退堂鼓了，半途而廢了，斷斷續續，半年一年，一直在前幾章徘徊，擱淺了多少次，拿起放下，我的自信心都快耗沒了，，，

不能光看書，得比對著原始碼看，下載了原始碼，總算是有點上道了，書中Tomcat版本可能和自己下載的原始碼版本不一樣，描述上會有一些差異，有些類已經洗掉了，有些方法重構了，但是不可否認的是，前人寫的書，起到非常好的引導作用，萬事開頭難，開個好頭就成功了一半，

后來看了一段時間書和原始碼，發現還是不夠，書中的描述比較概括，比對原始碼看方法呼叫堆疊，真的是全靠猜，和理論對上了，就是猜想合理，不行，一定要運行原始碼，debug一下，做學問，哪能靠猜！

二、運行Tomcat原始碼

1、下載原始碼

Tomcat各版本原始碼：https://archive.apache.org/dist/tomcat/

Tomcat安裝包：https://tomcat.apache.org/

為什么又要下載原始碼，又要下載安裝包？

原始碼中webapps是沒有編譯的，需要用安裝包里的替換，并且Tomcat用的是ant+build.xml依賴管理，這種方式比較老，現在都用maven、gradle了，所以可以手動換成maven，但是有些包在maven倉庫中找不到，可以從Tomcat安裝包lib目錄下獲取，

我這里下載的是兩個版本，Tomcat8.5.9和Tomcat最新版本（10.0.6），后面會分別講解兩個版本的原始碼運行搭建程序，

2、Tomcat8.5.9原始碼運行

下載好的apache-tomcat-8.5.9-src，用IDEA打開并引入：File --> Project Structure --> Modules --> + --> import module，

原始碼完整目錄

（1）新建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>Tomcat8.5.9</artifactId>
    <name>Tomcat8.5.9</name>
    <version>8.5.9</version>
 
    <build>
        <finalName>Tomcat8.5.9</finalName>
        <sourceDirectory>java</sourceDirectory>
        <resources>
            <resource>
                <directory>java</directory>
            </resource>
        </resources>
        <testResources>
           <testResource>
                <directory>test</directory>
           </testResource>
        </testResources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
 
    <dependencies>
        <!--test會用到-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.easymock</groupId>
            <artifactId>easymock</artifactId>
            <version>3.4</version>
        </dependency>

        <!--org.apache.catalina.ant用到-->
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.7.0</version>
        </dependency>

        <!--org.apache.naming.factory.webservices.ServiceRefFactory用到-->
        <dependency>
            <groupId>wsdl4j</groupId>
            <artifactId>wsdl4j</artifactId>
            <version>1.6.2</version>
        </dependency>

        <!--org.apache.naming.factory.webservices用到-->
        <dependency>
            <groupId>javax.xml</groupId>
            <artifactId>jaxrpc</artifactId>
            <version>1.1</version>
        </dependency>

        <!--org.apache.jasper.compiler.JDTCompiler用到-->
        <dependency>
            <groupId>org.eclipse.jdt.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.5.1</version>
        </dependency>
    </dependencies>
</project>

（2）替換webapps和加 lib 包

因為原始碼包webapps下示例專案WEB-INF/classes/下的.java沒有編譯，沒有.class檔案，所以可將整個webapps洗掉，并復制安裝包中的webapps到原始碼包，

原始碼包中新建lib目錄，從安裝包中的lib目錄復制jasper.jar到原始碼包的lib目錄，這樣做的目的有兩個：

Tomcat運行時會默認掃描lib目錄，沒有lib目錄雖然不會報錯，但是控制臺會有警告日志，提示lib目錄不存在，
安裝包lib下jar包很多，沒必要都復制過來，按需復制了jasper.jar，雖然jasper.jar中的代碼和原始碼中的org.apache.jasper完全重了，但是這個jar包里有非常重要的配置資訊，定義了javax.servlet.ServletContainerInitializer的實作類是org.apache.jasper.servlet.JasperInitializer，Tomcat啟動時，Context的生命周期監聽器ContextConfig.configureStart會掃描lib目錄下的jar里面的配置資訊，做一些類初始化操作，這里就是主動實體化JasperInitializer，不然訪問jsp就會報錯，（百度的教程千篇一律，都是在原始碼里寫死加一個JasperInitializer的初始化，不推薦這樣做，一定要找到原因，）

（3）運行Bootstrap#main

org.apache.catalina.startup.Bootstrap#main 是Tomcat一鍵啟停的源頭，運行這個main方法之前需要指定一下配置的位置，Tomcat必須要參考server.xml等配置才可以運行起來，

需要先了解兩個概念：

catalina.home是Tomcat安裝目錄，也是公共目錄，如bin、lib都是所有web共享的，
catalina.base是web專案部署目錄，也是作業目錄，如conf、logs、webapps等，web可私有，

Tomcat讀的一些配置，默認都是在這兩個目錄下，比如conf、webapps、lib等，我這里VM options設定了catalina.home和catalina.base都是原始碼目錄，并指定了Log的配置，

-Dcatalina.home=C:/study/tomcat/apache-tomcat-8.5.9-src
-Dcatalina.base=C:/study/tomcat/apache-tomcat-8.5.9-src
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file=C:/study/tomcat/apache-tomcat-8.5.9-src/conf/logging.properties

Edit Configurations...

（4）運行并訪問

完成以上三步，就可以運行了：

運行起來了，耶

如果test目錄有報錯，可洗掉報錯的位置（最好不要洗掉整個test目錄，可以自己在test目錄里寫測驗類debug），正常運行后，在瀏覽器中訪問http://127.0.0.1:8080/ , 點擊頁面中的超鏈接如Documentation、Configuration等都可以正常訪問，

ROOT首頁

/docs/config

（5）-config指定配置路徑運行

webapps下的web專案是會自動部署的，但是實際生產中，不太可能讓所有的web專案都部署在webapps下，不太可能啟動一個Tomcat，運行所有web，一旦一個web運行例外導致Tomcat掛了，其他web也會受到影響，所以一般通過-config指定配置，一個web運行一個Tomcat，保證行程隔離，

# Program arguments, example1.conf是定制的server.xml配置
-config C:/study/tomcat/conf/example1.conf start

-config start

example1.conf：

<?xml version='1.0' encoding='utf-8'?>
<Server port="8112" shutdown="SHUTDOWN">
  <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
  <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">

    <Executor name="tomcatThreadPool" namePrefix="catalina-exec-" maxThreads="20" minSpareThreads="20" />
	
    <Connector executor="tomcatThreadPool"  port="8012" protocol="org.apache.coyote.http11.Http11NioProtocol"
               connectionTimeout="60000"
		acceptCount= "10000" 
               redirectPort="8443"  URIEncoding="UTF-8"  maxPostSize="-1" maxHttpHeaderSize ="102400"/>
    <Engine name="Catalina" defaultHost="demo1">
	
      <Realm className="org.apache.catalina.realm.LockOutRealm">
        <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
               resourceName="UserDatabase"/>
      </Realm>
      <Host name="demo1" >
        <!-- Context 指定web專案路徑 -->
        <Context path="/" reloadable="true" docBase="C:/study/tomcat/web/example1"  workDir="C:/study/tomcat/web/example1/WEB-INF/work/" >
	  <Resources>
      </Resources>
        </Context>
        <Valve className="org.apache.catalina.valves.AccessLogValve" directory="C:/study/tomcat/logs/"
               prefix="example1." suffix=".txt"
               pattern="%h %l %u %t &quot;%r&quot; %s %b" />

      </Host>
    </Engine>
  </Service>
</Server>

3、Tomcat10.0.6原始碼運行

和apache-tomcat-8.5.9-src的搭建程序差不多，稍有不同的地方是一些依賴需要調整，（Tomcat10.0.6中直接復制整個安裝包的lib到原始碼包中運行不會報錯，所以可整個復制過去）

pom.xml比8.5.9版本多兩個依賴jakartaee-migration和biz.aQute.bndlib：

<?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>Tomcat10.0.6</artifactId>
    <name>Tomcat10.0.6</name>
    <version>10.0.6</version>
 
    <build>
        <finalName>Tomcat10.0.6</finalName>
        <sourceDirectory>java</sourceDirectory>
        <resources>
            <resource>
                <directory>java</directory>
            </resource>
        </resources>
        <testResources>
           <testResource>
                <directory>test</directory>
           </testResource>
        </testResources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
 
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <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>

        <!-- https://mvnrepository.com/artifact/org.apache.tomcat/jakartaee-migration -->
        <!-- 10.0.6 新加 -->
        <dependency>
            <groupId>org.apache.tomcat</groupId>
            <artifactId>jakartaee-migration</artifactId>
            <version>1.0.0</version>
        </dependency>

        <!-- 10.0.6 新加 -->
        <dependency>
            <groupId>biz.aQute.bnd</groupId>
            <artifactId>biz.aQute.bndlib</artifactId>
            <version>5.3.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>

依賴中去掉了ecj，因為這個依賴maven倉庫中最新版本也滿足不了Tomcat10.0.6，需要從Tomcat10.0.6的安裝包lib中復制ecj-4.18.jar到原始碼包的lib下，同時需要手動指定依賴：

ecj-4.18

依賴調整好以后，其他操作都和apache-tomcat-8.5.9-src一樣，但是運行10.0.6后控制臺輸出有一些亂碼，也不是中文亂碼，嘗試除錯編碼，沒有解決，（有解決亂碼的同學可以告知一下）

Tomcat10也運行起來了，但是有亂碼，，

三、搭建原始碼閱讀環境

閱讀學習Tomcat原始碼，需要三件事：

看書入門，這里推薦兩本關于Tomcat的書《Tomcat內核設計剖析》汪建和《Tomcat架構決議》劉光瑞，
搭建Tomcat原始碼運行環境，并debug，
閱讀Tomcat最新原始碼，多版本比對原始碼，Tomcat在Github中開源，可git clone 最新代碼到本地，閱讀最新原始碼有一個好處就是可以看到每次修改的提交記錄，

如下是本人搭建的原始碼閱讀環境，可git clone一起學習：

https://gitee.com/stefanpy/tomcat-source-code-learning

四、總結：如何閱讀原始碼

搭建原始碼閱讀環境必不可少，一定要做到手里有書，眼里有原始碼，心里有debug，

書，具有引導和總結作用，Tomcat原始碼那么多，那么復雜，不知道從哪里開始讀，可以先跟著書的目錄，按章學習，從整體到細節，從外到內，從簡到繁，快速建立起一個Tomcat基礎架構網路：

Tomcat是一個HTTP服務器和Servlet容器，有兩個核心組件：連接器和容器，聯結器實作HTTP功能，容器實作裝載Servlet的功能，
一個Server可以包含多個Service，一個Service包含多個Conector和一個Engine，一個Engine包含多個Host，一個Host包含多個Context，一個Context包含多個Wrapper，這些容器名稱和層次關系是不是有些暈？一個Context就是一個熟悉的web服務，Wrapper可以理解為對Servlet的包裝，

Tomcat整體架構-來自網路

請求的回應從連接器–>容器–>連接器，連接器負責對外交流，接收請求做一些封裝，然后交由容器處理，容器處理完后再回傳給連接器做回應，

連接器和容器-來自網路

連接器、容器，從哪個開始學習呢？連接器涉及網路編程，HTTP協議等；容器里有類加載、各種設計模式，職責鏈、觀察者（事件監聽）模式用的最多，容易理解吸收，如果對網路編程（NIO、net、HTTP）不是很熟悉的，可以先從容器學起，如果對RPC框架Netty等熟悉的，那連接器就簡單了，
帶著任務和問題研究Tomcat原始碼，把整個Tomcat原始碼學習的艱巨工程劃分為多個小任務，帶著疑問去研究學習，比如可以先從日常熟悉的server.xml配置開始，搞懂里面的配置，為什么這么配置，這個路徑為什么這樣；帶著問題就是Tomcat如何做熱加載？如何部署加載一個web專案？如何處理一個請求？Tomcat生命周期是怎么實作的，如何做到一鍵啟停？Tomcat為什么要自定義類加載器，如何打破雙親委派？等等，帶著任務和問題，及時正向反饋，才能堅持把Tomcat這塊硬骨頭啃下來，

學習Tomcat原始碼也有一段時間了，中間半途而廢多次，摸摸索索總結出一套適合自己的學習方式，真的，萬事開頭難，好的開頭，成功一半，好的方法，事半功倍，后面會把我學習Tomcat原始碼的心得、程序持續分享出來，希望對你有用，

轉載請註明出處，本文鏈接：https://www.uj5u.com/ruanti/286424.html

標籤：其他

上一篇：MATLAB GUI圖形界面設計一個學生管理系統

下一篇：C語言入門基礎必備知識串講-詳細版（新人解惑）