Tomcat9源代码浅析-环境搭建

1.概要

Apache Tomcat是一个非常受欢迎的开源Web容器，使用Java语言开发。

近期公司开始推行开源技术的应用，目前正在将Weblogic替换为Tomcat，我们称之为W2T。本系列为项目过程中对Tomcat 9源代码分析的记录，过程中主要参考了官方文档以及网络上的博客。
本篇为源代码分析的第一步，源代码环境的构建。

2.构建步骤

完整的构建步骤说明为源代码中的BUILDING.txt文件，本过程大部分内容为该文件的翻译，本文构建平台为Windows操作系统。

2.1基础环境准备

JDK的下载和安装

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

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

• 设置环境变量：

  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
• 设置环境变量：

  ANT_HOME:计算机中ANT安装的绝对路径
  PATH: %ANT_HOME%\bin
  

2.2 构建Tomcat

Tomcat9源代码下载

Tomcat9源代码可通过Git仓库checkout也可以在官网下载代码压缩包。

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

• Source packages can be downloaded from: https://tomcat.apache.org/download-@VERSION_MAJOR@0.cgi

Ant构建

• 首先在项目根目录创建文件build.properties，其内容可直接复制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构建的，所以并没有依据项目工程结构添加依赖，导入IDEA中会提示编译错误，需要先将源代码改造为Maven结构，通过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>

操作完成后，项目结构如下图：

此时在Test目录中仍然存在编译错误，原因是Test对tomcat/webapps/examples 进行了引用，在File->Project Structure中添加依赖

运行源代码

Tomcat的入口为org.apache.catalina.startup.Bootstrap的main方法，但在运行前需要设定环境变量catalina.home，用于指定Tomcat的根目录，否则运行时会提示某些配置文件不存在。以我本地为例，设置了构建后的目录路径。

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

至此，Tomcat9的环境搭建完毕，运行Bootstrap的main方法，启动Tomcat。

[ 在运行时控制台出现了中文乱码的问题，经查看为国际化的问题，此处没有进行深入研究，直接将语言环境设置为英文，设置了JVM参数：-Duser.language=en]