Tomcat源码IDEA配置运行

刚学习Java一年，有时候学习有点迷茫，不知道该从广度下手，还是深度下手，思前想后还是兼顾一下，查了不少资料，发现Tomcat的源码比较简单同时又有着优秀的设计模式，于是便想着看看他的源码。但这并非一件易事，于是记录一下流程希望对大伙有所帮助。

1.运行环境

jdk版本：1.8_301
tomcat版本 : 8.5.58
idea : 2021.2.3
系统：windows 10

2.下载源码

2.1github

https://github.com/apache/tomcat

2.2选择版本

建议是Tomcat8或9，主要是Tomcat10需要jdk8以上的环境，而Tomcat8、9在jdk8就能跑。我选的是Tomcat8.5.58，如果选了不同的版本，下面的Maven文件要酌情修正。

可以选择下载zip包解压的方式或是git（命令如下）。

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

2.3源码目录

解压好就会得到这样一个目录，我们可以看见build.xml这样一个文件，这是因为Tomcat的依赖管理用到的是Ant技术进行管理的，而这个技术已经被淘汰好久了，所以我使用了Maven进行替代的依赖管理。

3.源码构建

3.1创建pom.xml

现在的idea一检测到pom.xml文件就会自动配置Maven，所以在我这是不需要额外配置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>Tomcat8.0</artifactId>
    <name>Tomcat8.0</name>
    <version>8.0</version>

    <build>
        <finalName>Tomcat8.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.1</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>org.easymock</groupId>
            <artifactId>easymock</artifactId>
            <version>3.4</version>
        </dependency>
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.6.5</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.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.5.1</version>
        </dependency>
    </dependencies>
</project>

重点：一个完整的pom.xml文件是运行的关键，所以大家一定要仔细检查版本是否合适（因为不同的Tomcat对上述的版本可能不同，需要尝试）。

3.2 Idea打开

先点刷新让依赖导入，再clean，compile没报错就算完成了。

3.3配置启动类

org.apache.catalina.startup.Bootstrap

VM配置

-Duser.language=en
-Duser.region=US
-Dfile.encoding=UTF-8

3.4 修改代码

因为我是以源码的学习为主，所以我并没有保持Tomcat的所有功能，（其实主要还是因为有些类自己会报错还不好调），所以我就移除了一些不影响功能的类。
1）test
​
2）webapps/examples

4. 一些遇到的bug

4.1 不用非得去创建输出文件夹

很多教程中会然创建一个home文件夹，然后把conf和webapps移动进去，然后在配置启动类时，通过修改VM配置，输出到该目录，但是我这边执行的时候会发生MBean类找不到的问题，于是我索性不创建输出文件夹，于是就没这个问题了。

4.2 500乱码错误

这个一般是pom.xml文件出了问题，网上说的增加Jasp初始化一点用都没有。

4.3 docs文件

这个文件是需要Ant解析的，因为我们是从Maven做的，所以从页面是没法正常打开的，报404错误，不会影响我们源码的阅读。