将tomcat源码以maven方式运行

￡神魔★判官ぃ 2022-12-21 15:50 144阅读 0赞

# 前言 #

最近在分析tomcat的启动流程，虽然我们可以在idea中查看到tomcat的源代码，但是我们不能在上面做一些代码注释，这就会 非常的不方便，所以我们还是能在本地 运行一份源码，这样非常有利于我们分析源码

# 一、下载tomcat源码，选择tomcat-8.5.55版本 #

进入[tomcat官网][tomcat]，点击左侧菜单栏Download对应的版本，下载源码

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21lc2VyODg_size_16_color_FFFFFF_t_70][]

# 二、idea中创建项目 #

## 1.在idea中创建一个空白项目，名称为tomcat\_study ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21lc2VyODg_size_16_color_FFFFFF_t_70 1][]

## 2.打开项目源目录，将tomcat的源码解压到其中 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70][]

## 3.创建文件夹 ##

在tomcat的源码文件夹下面创建home目录，把源码中的conf目录和webapps目录剪切到其中（其他新建的目录如logs等），另外新建maven的pom.xml文件。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 2][]

## 4、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>Tomcat8.5.55</artifactId>
        <name>Tomcat8.5.55</name>
        <version>8.5.55</version>
     
        <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>3.4</version>
            </dependency>
     
            <dependency>
                <groupId>org.apache.ant</groupId>
                <artifactId>ant</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.5.1</version>
            </dependency>
        </dependencies>
     
        <build>
            <finalName>Tomcat8.5.55</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>3.1</version>
                    <configuration>
                        <encoding>UTF-8</encoding>
                        <source>1.8</source>
                        <target>1.8</target>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </project>

## 5、tomcat启动配置  ##

### 5.1 构建项目 ###

完成上面的操作以后，我们在idea中重新打开项目，直接选中我们增加的pom.xml文件，将所以的包下载完成以后，构建项目结构。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 3][]

### 5.2 设置Run/Debug configurations ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 4][]

其中

Main class:
    org.apache.catalina.startup.Bootstrap
     
    VM options 按照自己的路径进行修改:
    -Dcatalina.home=G:/projects/tomcat_study/apache-tomcat-8.5.55-src/home 
    -Dcatalina.base=G:/projects/tomcat_study/apache-tomcat-8.5.55-src/home 
    -Djava.endorsed.dirs=G:/projects/tomcat_study/apache-tomcat-8.5.55-src/home/endorsed 
    -Djava.io.tmpdir=G:/projects/tomcat_study/apache-tomcat-8.5.55-src/home/temp 
    -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager 
    -Djava.util.logging.config.file=G:/projects/tomcat_study/apache-tomcat-8.5.55-src/home/conf/logging.properties

### 5.3 设置ContextConfig类 ###

然后打开ContextConfig（org.apache.catalina.startup 下面） 类，加上一行代码：**context.addServletContainerInitializer(new JasperInitializer(),null);**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 5][]

### 5.4 启动tomcat ###

即可debug查看tomcat的初始化和启动过程以及其他源码执行，入口类就是Bootstrap类的main方法。

--------------------

# 总结 #

通过上面过程，我们就可以 将tomcat源码通过maven方式在本地运行起来，小编已经成功运行起来，并且对tomcat中 调用servlet初始化的流程进行了注释，下面是小编的tomcat源码地址，

[https://github.com/good-jack/tomcat\_source/tree/master][https_github.com_good-jack_tomcat_source_tree_master]

后续对于tomcat源码的学习，都是在这个项目中进行记录

[tomcat]: https://tomcat.apache.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21lc2VyODg_size_16_color_FFFFFF_t_70]: /images/20221120/41e2051c1e0e40e0a128f96a7f5be83e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21lc2VyODg_size_16_color_FFFFFF_t_70 1]: /images/20221120/f28c4caff04044ea875b31637f4e8fdd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70]: /images/20221120/3b717e10d96843ffb8dd5134c9450948.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/2020111622425635.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201116224320684.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201116224753180.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201116224858391.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/2020111622523456.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNDU0Mzc=,size_16,color_FFFFFF,t_70
[https_github.com_good-jack_tomcat_source_tree_master]: https://github.com/good-jack/tomcat_source/tree/master