Tomcat源码分析 -- 准备工作

一、本篇目录

• tomcat简介
• tomcat目录结构
• tomcat源码调试

二、tomcat简介

两句话简单介绍下：

Tomcat是Apache 软件基金会（Apache Software Foundation）的Jakarta 项目中的一个核心项目，由Apache、Sun 和其他一些公司及个人共同开发而成。

它是一个小型的轻量级应用服务器，在中小型系统和并发访问用户不是很多的场合下被普遍使用，是开发和调试JSP 程序的首选。

三、tomcat目录结构

tomcat的下载安装有很多教程，不再赘述。

现在的tomcat已经到9了，当tomcat下载安装完成后，其目录大致如下：

除了上面的文件夹，还有四个文件：

先介绍后4个文件：

1. LICENSE：就是许可证，里面记录了tomcat的一些条款等等。
2. NOTICE：里面记录了tomcat的新的通知，公告。
3. RELEASE-NOTES：里面记录的是发行版本的说明，一些捆绑的API，新特性等等。
4. RUNNING.txt：记录了tomcat的运行环境以及怎样配置参数，变量，启动等等。

再介绍文件夹（并不全）：

3.1、bin文件夹

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

1. bootstrap.jar：这个jar包是引导程序jar包，是tomcat的入口。
2. catalina.bat：一个重要脚本，这个脚本完成了很多基本操作，如启动、关闭等，catalina.bat都参与其中，Windows中运行。
3. catalina.sh：文件作用同catalina.bat，在Linux/Unix系统下运行。
4. catalina-tasks.xml：配置文件，主要是引入各种jar包。
5. configtest.bat：检测语法是否正确的脚本文件。
6. configtest.sh：同上。
7. 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. tcnative-1.dll：加速器组件，可以提高性能。
12. tomcat-native.tar.gz：里面放的是tomcat本地的library。
13. tool-wrapper.bat：工具包装脚本。
14. version.bat：一般是用来判断系统版本获取系统版本信息等。

3.1、conf文件夹

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

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

server.xml文件重点关注一下：

里面详细配置可以参考这篇文章：
server.xml配置详解

3.3、lib文件夹

tomcat依赖库目录，包含tomcat服务器运行环境依赖jar包。

3.4、logs文件夹

默认的日志存放文件夹。

3.5、webapps文件夹

默认的web应用部署目录。

3.6、work文件夹

web应用jsp代码生成和编译临时目录。清空work目录，然后重启tomcat,可以达到清除缓存的作用。sp文件在被翻译后，保存在当前这个目录下，session对象被序列化之后保存的位置。

四、tomcat源码调试

前面对tomcat做了一些简单的认识，下面将tomcat源码调试环境搭建起来。

可以参考官网的搭建方法，这里是按照网上的maven管理的方式搭建。

大概步骤是：

1.下载tomcat 9的源码，一般是下载页面最底部的tar包或zip包源码；

2.然后解压在文件夹下新建pom.xml，内容大致如下：

    4.0.0
    me.w1992wishes.tomcatwork
    Tomcat9.0
    Tomcat9
    9.0

    
        Tomcat9
        java
        
            
                java
            
        
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                2.3
                
                    UTF-8
                    1.8
                    1.8
                
            
        
    

    
        
            org.apache.ant
            ant
            1.9.5
        
        
            org.apache.ant
            ant-apache-log4j
            1.9.5
        
        
            org.apache.ant
            ant-commons-logging
            1.9.5
        
        
            javax.xml.rpc
            javax.xml.rpc-api
            1.1
        
        
            wsdl4j
            wsdl4j
            1.6.2
        
        
            org.eclipse.jdt.core.compiler
            ecj
            4.4
        
    

3.接着导入idea，设置启动项：

Main Class:org.apache.catalina.startup.Bootstrap;
VM options：填写解压的tomcat路径；

4.因为webapps下的应用有些配置加载出错，可以先将webapps里面的文件全部删除，自己新建一个demo文件夹，然后在里面新建一个index.html，并不影响源码阅读。

5.JDTCompiler.java类中可能会有报错，有部分代码使用CompilerOptions.VERSION_1_9来判断java虚拟机版本，里面涉及1.9版本的jvm，如果识别不了，可以删掉。

6.最后编译，运行，访问localhost:8080/demo。

详过程可以参考这篇博文：

【Tomcat9源码分析】源码下载、编译与调试