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不存在
同樣，我們去將home\webapps\examples\WEB-INF\classes\util\CookieFilter.java 檔案拷貝到 test\util 目錄下:
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的啟動及執行原理。