Tomcat9源代碼淺析-環(huán)境搭建

1.概要

Apache Tomcat是一個非常受歡迎的開源Web容器，使用Java語言開發(fā)。

成都創(chuàng)新互聯(lián)公司主要從事網(wǎng)站制作、網(wǎng)站設計、網(wǎng)頁設計、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務。立足成都服務尼金平,10余年網(wǎng)站建設經(jīng)驗,價格優(yōu)惠、服務專業(yè),歡迎來電咨詢建站服務:028-86922220

近期公司開始推行開源技術的應用，目前正在將Weblogic替換為Tomcat，我們稱之為W2T。本系列為項目過程中對 Tomcat 9源代碼分析的記錄，過程中主要參考了官方文檔以及網(wǎng)絡上的博客。
本篇為源代碼分析的第一步，源代碼環(huán)境的構建。

2.構建步驟

完整的構建步驟說明為源代碼中的BUILDING.txt文件，本過程大部分內(nèi)容為該文件的翻譯，本文構建平臺為Windows操作系統(tǒng)。

2.1基礎環(huán)境準備

JDK的下載和安裝

• 版本要求：version 8 of Java Development Kit (JDK) release

• 載地址： http://www.oracle.com/technetwork/java/javase/downloads/index.html

• 設置環(huán)境變量：

    JAVA_HOME:計算機中JDK安裝的絕對路徑
    CLASSPATH:.;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar;
    PATH:%JAVA_HOME%\bin
  

  ANT的下載和安裝

• 版本要求：version 1.9.8 or later
• 下載地址： https://ant.apache.org/bindownload.cgi

• 設置環(huán)境變量：

    ANT_HOME:計算機中ANT安裝的絕對路徑
    PATH: %ANT_HOME%\bin
  

  2.2 構建Tomcat

  Tomcat9源代碼下載

  Tomcat9源代碼可通過Git倉庫checkout也可以在官網(wǎng)下載代碼壓縮包。

  • Tomcat GitHub repository URL: https://github.com/apache/tomcat

  • Source packages can be downloaded from: @VERSION_MAJOR_#_@_#_0.cgi"">https://tomcat.apache.org/download-@VERSION_MAJOR@0.cgi

Ant構建

• 首先在項目根目錄創(chuàng)建文件==build.properties==，其內(nèi)容可直接復制==build.properties.default==
• Ant構建時會下載Tomcat所依賴的lib文件，下載路徑由屬性==base.path==指定，默認為${user.home}/tomcat-build-libs
• 進入到項目目錄，運行ant命令開始構建

  cd ${tomcat.source}
  ant
  

  構建成功后，在目錄${tomcat.source}/output/build下就是一個我們平時下載的Tomcat容器，可以使用startup.bat、startup.sh、shutdown.bat、shutdown.sh等命令進行操作。

2.3 編譯運行源代碼

編譯源代碼

本文為使用IntelliJ IDEA編譯運行源代碼，因Tomcat是使用Ant構建的，所以并沒有依據(jù)項目工程結(jié)構添加依賴，導入IDEA中會提示編譯錯誤，需要先將源代碼改造為Maven結(jié)構，通過Maven進行編譯。
當然也可以將項目視為簡單Java項目進行構建，需要為項目添加base.path指定的tomcat-build-libs中jar包依賴，但IDEA在編譯Java項目時不會復制非java文件，例如properties、xml等，如果以此方式運行源代碼，則不能使用IDEA，可以改用eclipse。

在項目根目錄添加pom.xml文件，并在添加為maven項目，之后可以通過可視化操作或者命令進行編譯。

<?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</artifactId>
    <name>Tomcat9</name>
    <version>9</version>
    <properties>
        <base.path>D:/tomcat9/tomcat-build-libs</base.path>
        <ant.home>D:/software/apache-ant-1.9.13</ant.home>
    </properties>
    <build>
        <finalName>Tomcat9</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.3</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>ecj</groupId>
            <artifactId>ecj</artifactId>
            <version>4.12</version>
            <scope>system</scope>
            <systemPath>${base.path}/ecj-4.12/ecj-4.12.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>saaj-api</groupId>
            <artifactId>saaj-api</artifactId>
            <version>1.3.5</version>
            <scope>system</scope>
            <systemPath>${base.path}/saaj-api-1.3.5/saaj-api-1.3.5.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>jaxrpc</groupId>
            <artifactId>jaxrpc</artifactId>
            <version>1.1</version>
            <scope>system</scope>
            <systemPath>${base.path}/jaxrpc-1.1-rc4/geronimo-spec-jaxrpc-1.1-rc4.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>wsdl4j</groupId>
            <artifactId>wsdl4j</artifactId>
            <version>1.6.3</version>
            <scope>system</scope>
            <systemPath>${base.path}/wsdl4j-1.6.3/wsdl4j-1.6.3.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.9.3</version>
            <scope>system</scope>
            <systemPath>${ant.home}/lib/ant.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>org.easymock</groupId>
            <artifactId>easymock</artifactId>
            <version>3.4</version>
        </dependency>
    </dependencies>
</project>

操作完成后，項目結(jié)構如下圖：

此時在Test目錄中仍然存在編譯錯誤，原因是Test對tomcat/webapps/examples 進行了引用，在File->Project Structure中添加依賴

運行源代碼

Tomcat的入口為org.apache.catalina.startup.Bootstrap的main方法，但在運行前需要設定環(huán)境變量==catalina.home==，用于指定Tomcat的根目錄，否則運行時會提示某些配置文件不存在。以我本地為例，設置了構建后的目錄路徑。

-Dcatalina.home=D:\apache-tomcat-9.0.24-src\output\build

至此，Tomcat9的環(huán)境搭建完畢，運行Bootstrap的main方法，啟動Tomcat。

[ 在運行時控制臺出現(xiàn)了中文亂碼的問題，經(jīng)查看為國際化的問題，此處沒有進行深入研究，直接將語言環(huán)境設置為英文，設置了JVM參數(shù)：-Duser.language=en]