Tomcat作为一个老牌的一个Web容器框架,用途十分的广泛。无论是为了学习其框架的整体设计还是为了碰到问题更好的解决,作为程序员我们都应该对于Tomcat有一定的了解。而了解一个框架最好的办法就是看官方文档,但是有时候官方文档解答不了我们的问题,这时候就需要看源码了。
无论是使用编译器Idea还是Eclipse,或者是内嵌Tomcat的SpringBoot,我们都无法断点调试Tomcat是如何启动的。
Tomcat源码是什么呢?并不是我们下载下来将war包放入webapp文件夹下面,然后运行 start.sh
Tomcat就启动起来的jar包。源码包是一个单独的包,具体可以看下图。 源码下载
此时如果你下载下来解压以后,如果是Tomcat9.0的话你应该会得到一个 apache-tomcat-9.0.20-src
的文件夹,里面就是Tomcat的源码了,此时我们要将其运行起来,我们采用了Maven配置的方式,配置Pom文件下载Tomcat运行需要的jar包。
新建一个文件夹,例如我建立的是tomcat9这个文件夹,然后将源码解压下来的文件夹放入其中,并且在tomcat9文件夹下简历 pom.xml
文件。此时的目录结构是这样的。
-- tomcat9 -- apache-tomcat-9.0.20-src -- pom.xml
这个 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/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>gxf</groupId> <artifactId>apache-tomcat-9</artifactId> <name>apache-tomcat-9-source</name> <version>1.0</version> <packaging>pom</packaging> <modules> <module>apache-tomcat-9.0.20-src</module> </modules> </project>
此时在 apache-tomcat-9.0.20-src
文件夹下面也建立一个 pom.xml
文件,此时目录结构如下
-- tomcat9 -- apache-tomcat-9.0.20-src -- pom.xml -- pom.xml
此 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>Tomcat9.0</artifactId> <name>Tomcat9.0</name> <version>9.0</version> <build> <finalName>Tomcat9.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>2.0.2</version> <configuration> <encoding>UTF-8</encoding> <source>1.8</source> <target>1.8</target> </configuration> </plugin> </plugins> </build> <dependencies> <dependency> <groupId>ant</groupId> <artifactId>ant</artifactId> <version>1.7.0</version> </dependency> <dependency> <groupId>ant</groupId> <artifactId>ant-apache-log4j</artifactId> <version>1.6.5</version> </dependency> <dependency> <groupId>ant</groupId> <artifactId>ant-commons-logging</artifactId> <version>1.6.5</version> </dependency> <dependency> <groupId>wsdl4j</groupId> <artifactId>wsdl4j</artifactId> <version>1.6.2</version> </dependency> <dependency> <groupId>javax.xml.rpc</groupId> <artifactId>javax.xml.rpc-api</artifactId> <version>1.1</version> </dependency> <dependency> <groupId>org.eclipse.jdt.core.compiler</groupId> <artifactId>ecj</artifactId> <version>4.6.1</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> </dependencies> </project>
配置完 pom.xml
文件以后就可以配置启动参数了,此时用编译器打开此项目。我用的是Idea,在右上角点击配置,然后添加一个 Application
此时需要配置三个参数
Main class
: 固定填写 org.apache.catalina.startup.Bootstrap
即可,表示Tomcat的启动类是哪个 VM options
: -Dcatalina.home="war包存放路径"
,例如我是在源码路径下建立了一个home文件夹,home文件里有 work、webapps、logs、lib、conf
文件夹。这里面其实就是Tomcat的工作路径了 Use classpath of module
: 设置为新建文件夹的模块 配置完成以后,直接启动就行,此时或许会报错,因为源码中有许多我们用不到的测试类,我们可以全给删除了,然后再启动即可。
恭喜你,看到这你应该成功启动了Tomcat源码了,通过Debug去源码中找寻你想要的东西吧。
Previous
一次奇怪的StackOverflowError问题查找之旅