开源框架学习--Tomcat(1)--IDEA编译运行Tomcat10源码

读源码，学代码。今天开始了解Tomcat源码，首先需要尝试把Tomcat源码部署到IDEA，并进行mvn编译以及启动Tomcat。步骤如下：

 

编译Tomcat10源码：

1.去Tomcat官网下载最新的源码包(version:10.0.4):https://tomcat.apache.org/download-10.cgi

2.本地解压后，通过IDEA,File->open打开解压目录:

3.Tomcat源码并非maven项目结构，但可以通过pom指定java代码目录（无需按照src/main结构来），项目目录下创建pom.xml文件，并网上搜索到tomcat版本9的pom依赖，几次编译报错解决后，版本10.0.4的pom依赖如下（特别说明，红色标记的jakartaee-migration模块(未发布到maven repository)需要git clone到本地，再mvn install来部署解决tomcat源码的编译问题）

// git clone jakartaee项目
git clone git@github.com:apache/tomcat-jakartaee-migration.git

// clone后，本地mvn clean install，可能会报错如下两条:
1.[ERROR] Failed to execute goal org.apache.maven.plugins:maven-antrun-plugin:3.0.0:run (create-test-jars) on project jakartaee-migration: An Ant BuildException has occured: /Users/david/Documents/learning/tomcat-jakartaee-migration/target/test-classes does not exist.

2.[ERROR] around Ant part ...<signjar storepass="apache" alias="rsa" jar="target/test-classes/hellocgi-signed-rsa.jar" keystore="src/test/resources/keystore.p12" />... @ 13:144 in /Users/david/Documents/learning/tomcat-jakartaee-migration/target/antrun/build-main.xml

解决办法：
1. target下创建test-classes后，mvn install再编译
2. vi pom.xml，删除其中<parallel>...</parallel>标签以及其中的部分。

<?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>10.0-SNAPSHOT</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.25.0</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jdt.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.6.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.tomcat</groupId>
            <artifactId>jakartaee-migration</artifactId>
            <version>0.2.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>biz.aQute.bnd</groupId>
            <artifactId>biz.aQute.bndlib</artifactId>
            <version>5.2.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>Tomcat10.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>

4. 对创建的pom.xml文件右键，选择"+ Add as maven project", 如下图通过IDEA左下角的菜单栏点击Maven，右侧即可看到tomcat源码项目被添加为maven项目。

 

点击clean和compile,IDEA maven编译即可成功:

 

IDEA启动Tomcat：

1.需要让IDEA点击run来启动tomcat的启动类，选定Tomcat启动类后，即可尝试run运行：

2.可能会遇到测试类的报错如下，可以尝试运行忽略测试类，或者直接删除maven compile时产生的test文件夹：

3.再尝试运行，可能会报错找不到server.xml等配置类，可以去project structure,设置配置文件所在的目录为resource folder(当然conf和webapps不移动到home目录下正常可以找到):

4.再次启动，启动日志如下，有一些报错，网上查询需要配置jvm启动参数：

-Dcatalina.home=/Users/david/Downloads/apache-tomcat-10.0.4-src
-Dcatalina.base=/Users/david/Downloads/apache-tomcat-10.0.4-src
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file=/Users/david/Downloads/apache-tomcat-10.0.4-src/conf/logging.properties

5.配置好指定的catalina.home和catalina.base以及日志相关jvm参数后，启动Tomcat，正常启动，但localhost:8080页面如下: 

6.原因:启动Tomcat BootStrap时未加载JSP编译器JasperInitializer.在org.apache.catalina.startup.ContextConfig#configureStart:

webConfig(); // 这句下面添加如下初始化语句
context.addServletContainerInitializer(new JasperInitializer(), null);

启动Tomcat，查看http://localhost:8080

总结:让Tomcat在本地启动，这样方便debug调试。让我们深入研究Tomcat启动原理，作为Http服务器接受请求原理，以及如何对Request请求转换，并匹配对应Servlet显示jsp页面的。