Tomcat 源码分析（一）

tomcat 简介

Tomcat 是 Apache 软件基金会（Apache Software Foundation）的 Jakarta 项目中的一个核心项目，由 Apache、Sun 和其他一些公司及个人共同开发而成。因为Tomcat 技术先进、性能稳定，而且免费，因而深受Java 爱好者的喜爱并得到了部分软件开发商的认可，成为目前比较流行的Web 应用服务器。
它是一个小型的轻量级应用服务器，在中小型系统和并发访问用户不是很多的场合下被普遍使用，是开发和调试 JSP 程序的首选。
目前 tomcat 已经更新到 9.0。
本系列文章采用 tomcat 9.0 的源码进行分析学习。

下载源码

在官方下载地址的最下方Source Code Distributions 栏目处下载zip包，如图：

目录结构

项目解压后，文件结构大致如下：

bin文件夹

bin文件夹下面放的是可执行性文件，其中:bat/exe文件是Windows下可执行的脚本文件。sh文件时Linux/Unix下可执行的脚本文件。

1. catalina.bat：负责 CATALINA Server 的启动、关闭等。
2. catalina-tasks.xml：配置文件，主要是引入各种jar包。
3. ciphers.bat 使用指定算法生成加密过的tomcat用户密码
4. configtest.bat：检测语法是否正确的脚本文件。
5. digest.bat 使用指定算法生成加密过的tomcat用户密码（注释与 ciphers.bat 相同）
6. makebase.bat 用于在独立的文件夹中创建运行tomcat所需要的目录结构
7. service.bat：启动tomcat服务。和注册tomcat服务那块有关系。service.bat：启动tomcat服务。和注册tomcat服务那块有关系。
8. setclasspath.bat：设置classpath的脚本，在catalin.bat脚本中调用，可以设置java_home,jre_home等。
9. shutdown.bat：主要是检查catalina.bat执行所需环境，并调用catalina.bat批处理文件关闭tomcat服务。
10. startup.bat：主要是检查catalina.bat执行所需环境，并调用catalina.bat 批处理文件启动tomcat服务。
11. tool-wrapper.bat：工具包装脚本。
12. version.bat：一般是用来判断系统版本获取系统版本信息等。

config 文件夹

存放tomcat服务器的配置文件。

1. catalina.policy：当Tomcat在安全模式下运行，此文件为默认的安全策略配置。
2. catalina.properties：catalina环境变量配置。
3. context.xml：用于定义所有Web应用均需要加载的Context配置，如果Web应用指定了自己的context.xml，那么该文件的配置会被覆盖。
4. jaspic-providers.xml : 集成第三方 JASPIC 身份验证。
5. logging.properties：日志配置文件，可修改日志级别和日志路径等。
6. server.xml：核心配置文件，用于配置链接器、监听端口、处理请求的虚拟主机等，可以说，tomcat根据该配置文件创建服务器实例。
7. tomcat-users.xml：tomcat配置用户的文件，用于定义tomcat默认用户及角色映射信息，tomcat的manage模块使用该文件中定义的用户进行安全认证。
8. web.xml：tomcat中所有应用默认的部署描述文件，主要定义了基础Servlet和MIME映射，如果应用中不包含web.xml，tomcat将使用此文件初始化部署描述，反之，tomcat会将默认部署描述与自定义配置进行合并。

webapps文件夹

默认的web应用部署目录。

源码调试准备工作

1. 解压下载下来的源码包；
2. 在解压目录中添加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>com.smlf.tomcatsourcestudy</groupId>
    <artifactId>Tomcat9.0</artifactId>
    <name>Tomcat9</name>
    <version>9.0</version>

    <build>
        <finalName>Tomcat9</finalName>
        <sourceDirectory>java</sourceDirectory>
        <resources>
            <resource>
                <directory>java</directory>
            </resource>
        </resources>
        <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>org.apache.ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.9.5</version>
        </dependency>
        <dependency>
            <groupId>org.apache.ant</groupId>
            <artifactId>ant-apache-log4j</artifactId>
            <version>1.9.5</version>
        </dependency>
        <dependency>
            <groupId>org.apache.ant</groupId>
            <artifactId>ant-commons-logging</artifactId>
            <version>1.9.5</version>
        </dependency>
        <dependency>
            <groupId>javax.xml.rpc</groupId>
            <artifactId>javax.xml.rpc-api</artifactId>
            <version>1.1</version>
        </dependency>
        <dependency>
            <groupId>wsdl4j</groupId>
            <artifactId>wsdl4j</artifactId>
            <version>1.6.2</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jdt.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.6.1</version>
        </dependency>
    </dependencies>
</project>

这里面都是编译tomcat源码需要用到的依赖包。

3. 在eclipse中以maven项目的形式导入

导入后

4. 删除webapps下预置的应用，新建文件夹demo，并在里面创建index.html

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
I'm the demo
</body>
</html>

5. 注释掉JDTCompiler.java 中报错的部分代码，这是用于判断jvm版本的如果当前版本不到jdk9 可以注释掉

6. 运行 org.apache.catalina.startup.Bootstrap 类，并访问 localhost:8080/demo,可以看到刚刚创建的html