Tomcat 第一篇：原始碼匯入 IDEA 編輯器
阿新 • • 發佈：2020-09-15
## 1 引言
做 Java 的同學應該都見過上面這隻名字叫 Tomcat 的貓，畢竟這隻貓在過去和現在都是全球最流行的 Web 容器之一。
很有意思的一件事兒是從我接觸這隻貓開始，從來不知道它的中文名字是啥，好像沒有在任何地方看到過。
然後某人第一次見跟我說這是湯姆貓麼？？？
我就沒想通，這倆玩意長這麼大差距是如何能被認成是同一只貓的。
不過話說回來，這東西我也接觸了有很多年了，從來都只是拿來用，忽然有想法深入瞭解下 Tomcat 的執行機制了。
那麼最好的方式就是看原始碼，如果說看原始碼不知道從哪看齊，還可以看官方的指引文件。
## 2 下載原始碼
Tomcat 的原始碼下載要比上週下載那個 OpenJDK 的原始碼好下載多了，官網直接給出了打好的原始碼包，同時在 GitHub 上也能找到對應的倉庫。
這裡我選擇的是當前最新的 8.5.x 的版本。
官網下載地址：https://tomcat.apache.org/download-80.cgi
GitHub 地址：https://github.com/apache/tomcat
如果從 GitHub 下載還可以使用命令：
```shell
git clone [email protected]:apache/tomcat.git
```
原始碼下載完成後直接解壓，接下來我們把這個專案匯入我們的編輯工具 IDEA 中。
## 3 匯入 IDEA
我在網上看了下，大致有兩種方案匯入。
由於本身 Tomcat 專案是使用 Ant 作為包管理工具的，而 Ant 我沒有接觸過，也不大熟悉，這個方案我直接放棄掉了。
接下來還有一個方案是使用 Maven 的方式進行匯入，這個我熟悉，天天用。
因為是 Maven 工程，那麼一定需要一個 `pom.xml` 檔案，首先在專案的根目錄下建立這個檔案，並且 copy 以下內容：
```xml
4.0.0
org.apache
tomcat
apache-tomcat-8.5.57
8.5.57
Tomcat-8.5.57
java
test
java
test
org.apache.maven.plugins 3.5.1
UTF-8
1.8
1.8
junit
junit
4.12
test
org.easymock 3.4
test
org.apache.ant
ant
1.10.0
wsdl4j
wsdl4j
1.6.2
javax.xml
jaxrpc
1.1
org.eclipse.jdt.core.compiler 4.6.1
org.glassfish
javax.xml.rpc
3.0.1-b03
```
然後在 IDEA 中點選 `File -> New -> Project from Existing Sources...` 選擇我們剛才解壓後的資料夾。
選擇 Maven 專案，點選 Finish 直接完成。
## 4 啟動 Tomcat
接下來的事兒就好辦多了，首先選擇當前的 jdk 版本，我這裡使用的是 OracleJDK 1.8.0_221 ，最好是使用 1.8 的版本，因為我嘗試過最新的 OpenJDK14 直接通不過編譯（說好的向下相容呢）。
Tomcat 的啟動類是 `org.apache.catalina.startup.Bootstrap` ，直接執行這個類裡面的 `main` 方法就可以啟動了。
當然，如果就這麼單純的執行這個類還是會啟動報錯的，還需要下面幾步操作。
1. 首先需要刪除一個測試類 `test/util/TestCookieFilter.java`。
2. 然後還需要配置啟動引數：
```shell
-Dcatalina.home=D:/Development/Projects/Tomcat-Learning/apache-tomcat-8.5.57-src
-Dcatalina.baseD:/Development/Projects/Tomcat-Learning/apache-tomcat-8.5.57-src
-Djava.endorsed.dirs=D:/Development/Projects/Tomcat-Learning/apache-tomcat-8.5.57-src/endorsed
-Djava.io.tmpdir=D:/Development/Projects/Tomcat-Learning/apache-tomcat-8.5.57-src/temp
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file=D:/Development/Projects/Tomcat-Learning/apache-tomcat-8.5.57-src/conf/logging.properties
-Duser.language=en
-Duser.region=US
```
最後這兩個引數是指定了語言環境，如果不配置的話在控制檯的日誌列印會直接亂碼，雖然不影響使用，但是影響到我們觀察日誌了，最好還是做一下配置。
3. 新增 jsp 初始化程式
在 `org.apache.catalina.startup.ContextConfig.java` 中新增下面這句話：
```java
context.addServletContainerInitializer(new JasperInitializer(), null);
```
如果不新增的話，啟動是能正常啟動，但是 Tomcat 的歡迎頁就看不到了，會直接報 jsp 解析器空指標：
```java
org.apache.jasper.JasperException: java.lang.NullPointerException
```
到這裡，已經可以執行上面的 `org.apache.catalina.startup.Bootstrap` 裡面的 `main` 進行啟動了，啟動完成後在瀏覽器上輸入 `http://localhost:8080/` 就可以看到那個經典的 Tomcat 的歡迎頁了：
4. 部署程式
如果想在這個 Tomcat 中部署程式的話，需要把程式放在 `D:\Development\Projects\Tomcat-Learning\apache-tomcat-8.5.57-src\webapps\ROOT` ，這個是我自己本地的路徑，你們的路徑自己做拼接。
然後再在 `D:\Development\Projects\Tomcat-Learning\apache-tomcat-8.5.57-src\conf` 這個路徑中的 `server.xml` 配置工程，就和在 Tomcat 中配置 `server.xml` 是一模一樣的，比如：
在 Host 中增加節點
```xml