拆解Tomcat10: (二) 在Idea中调试最新的Tomcat10源码

2021-09-05 21:40:58

1. 下载源代码

可以到Tomcat官网下载源码压缩包，也可以去GitHub仓库Clone。
目前最新的是2021-12-08发布的10.0.14版。

1.1 下载压缩包

前往网址Tomcat官网：Apache Tomcat® - Apache Tomcat 10 Software Downloads

1.2 GitHub下载

仓库地址：apache/tomcat: Apache Tomcat (github.com)

如果想在代码中做一些注释，可以fork到自己的账号。执行如下命令，下载10.0.14版本：

git clone -b 10.0.14 https://github.com/apache/tomcat.git

2. 采用Maven方式构建

Tomcat默认采用的是Ant方式构建，官网中也对用其他方式做了提示：

重要提示：这不是构建 Tomcat 的支持方法；此信息不提供任何保证:-)。构建 Tomcat 的唯一支持方法是使用上述 Ant 构建。但是，一些开发人员喜欢使用 Java IDE 处理 Java 代码。

为了方便调试，我们采用Maven方式在Idea中调试源码。

2.1 创建pom.xml文件

首先在下载的代码根目录创建一个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>org.apache.tomcat</groupId>
  <artifactId>tomcat10</artifactId>
  <version>10.0.14</version>
  <name>tomcat10</name>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.13.2</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.easymock</groupId>
      <artifactId>easymock</artifactId>
      <version>4.3</version>
    </dependency>
    <dependency>
      <groupId>org.apache.ant</groupId>
      <artifactId>ant</artifactId>
      <version>1.10.12</version>
    </dependency>
    <dependency>
      <groupId>wsdl4j</groupId>
      <artifactId>wsdl4j</artifactId>
      <version>1.6.3</version>
    </dependency>
    <dependency>
      <groupId>javax.xml</groupId>
      <artifactId>jaxrpc-api</artifactId>
      <version>1.1</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.jdt</groupId>
      <artifactId>org.eclipse.jdt.core</artifactId>
      <version>3.28.0</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.jdt</groupId>
      <artifactId>ecj</artifactId>
      <version>3.28.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.tomcat</groupId>
      <artifactId>jakartaee-migration</artifactId>
      <version>1.0.0</version>
    </dependency>
    <dependency>
      <groupId>biz.aQute.bnd</groupId>
      <artifactId>biz.aQute.bndlib</artifactId>
      <version>6.1.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>com.unboundid</groupId>
      <artifactId>unboundid-ldapsdk</artifactId>
      <version>6.0.2</version>
      <scope>test</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>

右键点击代码文件夹，选择用Idea打开。或者再Idea中通过File->New->Project from Sources的方式打开代码文件夹：

点击Maven的Reload按钮开始加载依赖：

等待加载完成。

2.2 Build项目

点击Build按钮开始构建项目，会提示：“java: 程序包trailers不存在。”和“找不到符号 ResponseTrailers”，两个错误都出现在test文件夹。缺少的文件都在webapps/examples/WEB-INF/classes文件夹，

拷贝文件夹“webapps/examples/WEB-INF/classes/trailers”到“test”文件夹下。

拷贝文件“webapps/examples/WEB-INF/classes/util/CookieFilter.java”到“test/util”文件夹下。

此时再次Build不再出错。

3. 排查启动问题

找到文件“java/org/apache/catalina/startup/Bootstrap.java”，其中的main方法是Tomcat的启动起点。

Run这个方法，启动Tomcat，默认地址为“http://localhost:8080/“。

3.1 端口被占用

默认会监听8080端口，如图提示被占用，可以去“conf/server.xml”文件中修改：

    <Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />

3.2 提示Jsp相关的如下错误

修改“java/org/apache/catalina/startup/ContextConfig.java”文件，在configureStart方法中添加一行代码，位置如下面所示：

    protected synchronized void configureStart() {
        // 此处省略一部分代码
        webConfig();
        // 添加下面一行代码
        context.addServletContainerInitializer(new JasperInitializer(), null);
        
        if (!context.getIgnoreAnnotations()) {
            applicationAnnotationsConfig();
        }

再次启动，可以看到熟悉的页面了。