Tomcat源码系列一：Idea导入源码

下载源码

源码下载可以通过Tomcat官网或github下载，这里我选的是最新的8.5.81版本，其他版本也可以。（如果其他版本，下面maven依赖会有版本差异）

官网：Tomcat#8.5.81

Github地址：github.com/apache/tomc…

下载之后，直接解压到工作目录（git clone的话切换到8.5.x分支）

导入Idea

本次我们使用的是maven方式导入。在Idea -> File ->Open打开解压的目录，此时打开的还不是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</groupId>
  <artifactId>tomcat</artifactId>
  <name>apache-tomcat-8.5.81</name>
  <version>8.5.81</version>

  <build>
    <finalName>Tomcat-8.5.81</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.5.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>4.3</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>com.unboundid</groupId>
      <artifactId>unboundid-ldapsdk</artifactId>
      <version>6.0.2</version>
      <scope>test</scope>
    </dependency>

    <dependency>
      <groupId>org.apache.ant</groupId>
      <artifactId>ant</artifactId>
      <version>1.10.0</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.6.1</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.glassfish/javax.xml.rpc -->
    <dependency>
      <groupId>org.glassfish</groupId>
      <artifactId>javax.xml.rpc</artifactId>
      <version>3.0.1-b03</version>
    </dependency>
  </dependencies>
</project>

新增成功后，右键pom.xml点击Add as maven project将工程转化为maven工程。

启动Tomcat

找到Tomcat的启动类org.apache.catalina.startup.Bootstrap,直接运行main函数就能启动Tomcat。 当然此时运行会报错，需要设置3个地方：

1.编译时，单测类TestCookieFilter.java会报找不到CookieFilter.java类的错误：将webapps/examples/WEB-INF/classes/util/CookieFilter.java拷贝到test/util文件夹下

2.配置启动参数，Idea -> Run -> Edit Configurations... -> Add VM Options：

-Dcatalina.home=/Users/LouisGo/Documents/Workspace/Code/OpenSource/java/tomcat
-Dcatalina.base=/Users/LouisGo/Documents/Workspace/Code/OpenSource/java/tomcat
-Djava.endorsed.dirs=/Users/LouisGo/Documents/Workspace/Code/OpenSource/java/tomcat/endorsed
-Djava.io.tmpdir=/Users/LouisGo/Documents/Workspace/Code/OpenSource/java/tomcat/temp
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file=/Users/LouisGo/Documents/Workspace/Code/OpenSource/java/tomcat/conf/logging.properties
-Dfile.encoding=UTF-8
-Duser.language=en
-Duser.region=US

最后这两个参数是指定了语言环境，如果不配置打印的日志会乱码。

3.Jsp空指针异常：修改java/org/apache/catalina/startup/ContextConfig.java文件，在configureStart方法中添加一行代码，如下面所示：

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

再次运行Bootstrap.main()函数，此时可以正常启动成功。

日志中有启动的端口号，默认是8080（保证8080不被占用），也可以在conf->server.xml修改端口号。