如何斷點除錯Tomcat原始碼

不學無數的程式設計師發表於2019-06-04
斷點除錯Tomcat原始碼

如何斷點除錯Tomcat原始碼

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

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

下載原始碼

Tomcat原始碼是什麼呢？並不是我們下載下來將war包放入webapp資料夾下面，然後執行start.shTomcat就啟動起來的jar包。原始碼包是一個單獨的包，具體可以看下圖。原始碼下載

如何斷點除錯Tomcat原始碼

配置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

如何斷點除錯Tomcat原始碼

此時需要配置三個引數

如何斷點除錯Tomcat原始碼

  • 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去原始碼中找尋你想要的東西吧。

相關文章