如何斷點調試Tomcat源碼

Tomcat作為一個老牌的一個Web容器架構，用途十分的廣泛。無論是為了學習其架構的整體設計還是為了碰到問題更好的解決，作為程式員我們都應該對于Tomcat有一定的了解。而了解一個架構最好的辦法就是看官方文檔，但是有時候官方文檔解答不了我們的問題，這時候就需要看源碼了。

無論是使用編譯器Idea還是Eclipse，或者是内嵌Tomcat的SpringBoot，我們都無法斷點調試Tomcat是如何啟動的。

下載下傳源碼

Tomcat源碼是什麼呢？并不是我們下載下傳下來将war包放入webapp檔案夾下面，然後運作

start.sh

Tomcat就啟動起來的jar包。源碼包是一個單獨的包，具體可以看下圖。

源碼下載下傳

配置POM檔案

此時如果你下載下傳下來解壓以後，如果是Tomcat9.0的話你應該會得到一個

apache-tomcat-9.0.20-src

的檔案夾，裡面就是Tomcat的源碼了，此時我們要将其運作起來，我們采用了Maven配置的方式，配置Pom檔案下載下傳Tomcat運作需要的jar包。

建立一個檔案夾，例如我建立的是tomcat9這個檔案夾，然後将源碼解壓下來的檔案夾放入其中，并且在tomcat9檔案夾下履歷

pom.xml

檔案。此時的目錄結構是這樣的。

-- tomcat9
    -- apache-tomcat-9.0.20-src
    -- pom.xml
               

這個

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/maven-v4_0_0.xsd">    
    
    <modelVersion>4.0.0</modelVersion>    
    <groupId>gxf</groupId>    
    <artifactId>apache-tomcat-9</artifactId>    
    <name>apache-tomcat-9-source</name>    
    <version>1.0</version>    
    <packaging>pom</packaging>    
    
    <modules>    
        <module>apache-tomcat-9.0.20-src</module>    
    </modules>    
</project>
           

此時在

apache-tomcat-9.0.20-src

檔案夾下面也建立一個

pom.xml

檔案，此時目錄結構如下

-- tomcat9
    -- apache-tomcat-9.0.20-src
        -- pom.xml
    -- pom.xml
           

此

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>Tomcat9.0</artifactId>    
    <name>Tomcat9.0</name>    
    <version>9.0</version>    
    
    <build>    
        <finalName>Tomcat9.0</finalName>    
        <sourceDirectory>java</sourceDirectory>    
        <testSourceDirectory>test</testSourceDirectory>    
        <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.0.2</version>    
    
                <configuration>    
                    <encoding>UTF-8</encoding>    
                    <source>1.8</source>    
                    <target>1.8</target>    
                </configuration>    
            </plugin>    
        </plugins>    
    </build>

    <dependencies>
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.7.0</version>
        </dependency>
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant-apache-log4j</artifactId>
            <version>1.6.5</version>
        </dependency>
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant-commons-logging</artifactId>
            <version>1.6.5</version>
        </dependency>
        <dependency>
            <groupId>wsdl4j</groupId>
            <artifactId>wsdl4j</artifactId>
            <version>1.6.2</version>
        </dependency>
        <dependency>
            <groupId>javax.xml.rpc</groupId>
            <artifactId>javax.xml.rpc-api</artifactId>
            <version>1.1</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jdt.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.6.1</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>
           

配置啟動參數

配置完

pom.xml

檔案以後就可以配置啟動參數了，此時用編譯器打開此項目。我用的是Idea，在右上角點選配置，然後添加一個

Application

此時需要配置三個參數

• Main class

  : 固定填寫

  org.apache.catalina.startup.Bootstrap

  即可，表示Tomcat的啟動類是哪個

• VM options

  :

  -Dcatalina.home="war包存放路徑"

  ，例如我是在源碼路徑下建立了一個home檔案夾，home檔案裡有

  work、webapps、logs、lib、conf

  檔案夾。這裡面其實就是Tomcat的工作路徑了

• Use classpath of module

  : 設定為建立檔案夾的子產品

配置完成以後，直接啟動就行，此時或許會報錯，因為源碼中有許多我們用不到的測試類，我們可以全給删除了，然後再啟動即可。

恭喜你，看到這你應該成功啟動了Tomcat源碼了，通過Debug去源碼中找尋你想要的東西吧。