Tomcat源碼分析一：編譯Tomcat源碼

Tomcat源碼分析一：編譯Tomcat源碼

1 內容介紹

在以前的《Servlet與Tomcat運行示例》一文中，給你們帶來如何在Tomcat中部署Servlet應用的相關步驟，本文將就上文爲基礎，開始Tomcat源碼分析之旅，我將詳細的分析Tomcat的啓動過程及運行原理。本文將是最基礎的一節課，也就是本地編譯好Tomcat源碼，爲後面的分析作基礎！

2 編譯Tomcat源碼

2.1 下載Tomcat源碼

咱們去Tomcat官網下載最新的Tomcat源碼包，目前最新的版本爲9.0.26，咱們下載其source源碼包tar.gz版本，以下圖：

2.2 解壓源碼包apache-tomcat-9.0.26-src.tar.gz

解壓源碼包apache-tomcat-9.0.26-src.tar.gz以後獲得的內容爲：

2.3 解壓後的文件夾中添加pom.xml

由於要使用Maven的方式導入Tomcat項目，故須要添加相應的maven依賴，此處添加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>com.github.sources</groupId>
    <artifactId>source-tomcat</artifactId>
    <version>9.0.26</version>
    <name>source-tomcat</name>
    <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.5.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.10.1</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</groupId>
            <artifactId>org.eclipse.jdt.core</artifactId>
            <version>3.18.0</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jdt.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.6.1</version>
        </dependency>
    </dependencies>

    <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>3.6.1</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>
複製代碼

2.4 IDEA導入tomcat源碼工程

使用IDEA開發工具，以Maven的方式導入tomcat工程，導入以後工程結構以下：

2.5 啓動Tomcat工程

運行org.apache.catalina.startup包下的Bootstrap類的main方法

此時，咱們發現了一些錯誤，下面咱們來解決這些錯誤。

3 異常問題解決

3.1 trailers.ResponseTrailers不存在

咱們能夠去webapps/examples/WEB_INF/classes/trailers 目錄下找到該類，咱們將這個類複製一份到test下：

拷貝完成以後的狀況以下：

3.2 CookieFilter不存在

一樣，咱們去將homewebappsexamplesWEB-INFclassesutilCookieFilter.java 文件拷貝到 testutil 目錄下:

3.3 FileNotFoundException: /Library/ApacheTomcat/source/test/source-tomcat/conf/server.xml (No such file or directory)

在解決上述3.1和3.2的問題以後，又出現了下圖所示的問題：

• 解決方案：
  在啓動的配置中，添加VM options的參數，添加項目路徑，本機爲/Library/ApacheTomcat/source/test/apache-tomcat-9.0.26-src，故而添加參數內容爲：
  -Dcatalina.home=/Library/ApacheTomcat/source/test/apache-tomcat-9.0.26-src， 以下圖所示：

3.4 java.lang.ClassNotFoundException: listeners.ContextListener

在解決上述3.3問題以後，再次啓動Bootstrap類的main方法，程序出現如下錯誤信息：

• 解決方案： 刪除 webapps 下的 examples 文件夾！程序再次運行不報此錯誤！

3.5 Servlet.service() for servlet [jsp] in context with path [] threw exception [org.apache.jasper.JasperException: Unable to compile class for JSP] with root cause

在解決上述問題以後，啓動Bootstrap類的main方法，程序正常啓動，此時咱們在瀏覽器訪問127.0.0.1:8080， 程序出現如下錯誤信息：

• 解決方案：編輯 org.apache.catalina.startup.ContextConfig 文件的 configureStart() 方法，添加初始化 JSP 解析器的代碼：

context.addServletContainerInitializer(new JasperInitializer(), null);複製代碼

添加以後，再次啓動main方法，瀏覽器輸入127.0.0.1:8080獲得的結果爲Tomcat的界面：

3.6 日誌亂碼

啓動的日誌中含有不少的亂碼，雖然對程序總體並不影響，可是在以後查看日誌時，仍是影響比較大的，先看下日誌亂碼的狀況：

• 解決方案：
  修改vm options 內容，將環境設置爲美國-英文，設置內容以下：

-Duser.language=en -Duser.region=US -Dfile.encoding=UTF-8複製代碼

再次運行main方法，程序日誌正常顯示：

至此，咱們已經將Tomcat的源碼導入到IDEA的工具中，也解決了一些問題，以後，咱們將利用這份源碼來分析Tomcat的啓動及運行原理。

Blog:

• 簡書： https://www.jianshu.com/u/91378a397ffe
• csdn： https://blog.csdn.net/ZhiyouWu
• 開源中國： https://my.oschina.net/u/3204088
• 掘金： https://juejin.im/user/5b5979efe51d451949094265
• 博客園： https://www.cnblogs.com/zhiyouwu/
• 微信公衆號： 源碼灣
• 微信： WZY1782357529 (歡迎溝通交流)