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,内容大致如下:

<?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>me.w1992wishes.tomcatwork</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.4</version>
        </dependency>
    </dependencies>
</project>

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源码分析】源码下载、编译与调试

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,546评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,224评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,911评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,737评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,753评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,598评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,338评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,249评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,696评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,731评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,348评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2 355

推荐阅读更多精彩内容