2. 科技
    3. Tomcat IDEA源码调试环境搭建

    Tomcat IDEA源码调试环境搭建

    科技2022-07-29  123

    Tomcat IDEA源码调试环境搭建

    前言

    前段时间把tomcat的源码下载到本地，计划看看tomcat源码，了解一下其基本原理。但是，由于种种原因半途而废了。最近突然想搭建一下源码调试环境，发现网上许多文章都无法成功运行，最终参考多篇文章，使项目可以运行，做一下笔记进行记录。

    1. 采坑记录

    以tomcat8.5.x为例，笔者是从github上获取的tomcat源码，但是tomcat的源码是通过ant构建的，idea直接打开后，把java目录标记为Sources Root，test目录标记为Test Sources Root后，有部分代码报错，删除或注释报错代码即可。

    1.1 目录结构

    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>org.apache.tomcat</groupId> <artifactId>tomcat</artifactId> <version>1.0.0-SNAPSHOT</version> <name>tomcat</name> <dependencies> <dependency> <groupId>org.apache.ant</groupId> <artifactId>ant</artifactId> <version>1.10.7</version> </dependency> <dependency> <groupId>javax.xml</groupId> <artifactId>jaxrpc</artifactId> <version>1.1</version> </dependency> <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.6</version> </dependency> <dependency> <groupId>org.eclipse.jdt.core.compiler</groupId> <artifactId>ecj</artifactId> <version>4.5.1</version> </dependency> <dependency> <groupId>wsdl4j</groupId> <artifactId>wsdl4j</artifactId> <version>1.6.2</version> </dependency> </dependencies> <build> <finalName>tomcat</finalName> <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> <resources> <resource> <directory>java</directory> </resource> </resources> <sourceDirectory>java</sourceDirectory> <testResources> <testResource> <directory>test</directory> </testResource> </testResources> <testSourceDirectory>test</testSourceDirectory> </build> </project>

    附件：pom.xml

    1.3 启动项目

    我们运行org.apache.catalina.startup.Bootstrap的main方法，发现项目直接报错了，如下： 网上很多说是需要设置Tomcat的home目录，即jvm参数-Dcatalina.home参数。笔者参考网上的做法，建立一个catalina-home目录，把bin, conf, webapps, work目录拷贝到catalina-home中，并设置jvm参数-Dcatalina.home="/Users/liuyang/project/java/source/tomcat/catalina-home"，这里请根据自己的实际路径进行设置，如下： 设置完会发现依然报错，辣鸡教程，抄的千篇一律。 我们进行分析一下，bin, conf, webapps, work目录拷贝自项目根目录，为啥不能直接设置为项目根目录。我们把这个jvm参数去除。然后在Bootstrap打印catalina.home参数配置值： 可以看出，默认catalina.home是当前工程目录，但是项目依然报错。

    2. 正确打开方式

    2.1 Maven+Ant方式

    2.1.1 准备Ant环境

    ant环境需要安装ant环境，ant安装有多种方式，通过brew安装（Mac系统且安装好brew）可以执行如下命令：

    brew install ant

    到ant官方下载最新的zip包进行安装，与maven、jdk等环境安装类似，解压zip包，导出环境变量即可，mac环境下.bash_profile可以添加如下内容：

    #ant environment setting export ANT_HOME=/usr/local/ant export PATH=${PATH}:${ANT_HOME}/bin

    2.1.2 准备Maven环境

    maven环境依赖jdk，jdk和maven的安装请自行搜索。

    2.1.3 下载源码

    源码可以通过tomcat官网或者github下载，下载方式方式如下：

    https://mirror.bit.edu.cn/apache/tomcat/tomcat-8/v8.5.58/src/apache-tomcat-8.5.58-src.zipgit clone https://github.com/apache/tomcat.git

    到tomcat官网自行下载时需要注意，我们要下载的源码包而不是编译好的Tomcat，可按照下图标记进行下载：

    2.1.4 导入IDEA

    笔者的IDAE版本为2020.1.4 Ultimate，我们将下载后的zip包进行解压，并1.2步骤的pom.xml放到解压包的根目录下，然后用IDEA打开，如下： 然后点击pom.xml右键选择“Add as Maven Project”导入为Maven工程。IDEA进行编译后，我们发现有报错的类util.TestCookieFilter，我们将此测试类删除即可。

    2.1.5 Ant构建Tomcat

    2.1.5.1 ant插件安装并导入为ant工程

    ant构建Tomcat需要启动IDEA的ant插件，没有启用或安装的话，请自行安装并启用ant插件，启动ant插件后效果如下： 我们按照图示，将build.xml进行“Add as Build File”操作后，效果如下：

    2.1.5.2 ant命令build下载依赖

    我们在项目根目录命令行执行如下命令：

    #下面2个命令任意一个即可 #ant -buildfile build.xml ide-intellij ant ide-intellij

    执行命令后，我们发现构建失败，如下： 判断是commons-daemon-1.2.2.jar下载失败了，对应链接点击进去发现404。我们可以修改build.properties.default文件的配置，将commons-daemon-1.2.2升级为commons-daemon-1.2.3，再执行命令即可，如下： 实际命令执行过程中需要从中央仓库下载jar包，可能会有些慢，稍等片刻即可，命令正确执行完后，会有如下提示： 默认情况下，下载的jar包会放置到用户根目录下的tomcat-build-libs目录下，文件如下：

    2.1.5.3 IDEA设置PATH VARIABLES

    在上一步ant ide-intellij执行完，最后其实我们发现命令行已经提示我们设置PATH VARIABLES，设置过程可以参考下图：

    ANT_HOME=/usr/local/ant TOMCAT_BUILD_LIBS=/Users/liuyang/tomcat-build-libs

    2.1.5.4 ant deploy生成build文件

    接着我们可以进行deploy操作进行构建了，如下图所示： deploy操作完成后，我们运行org.apache.catalina.startup.Bootstrap的main方法，发现如下报错： 发生错误的原因是我们未设置catalina.home JVM参数。

    2.1.6 设置VM Options

    tomcat源码运行需要一个编译好的目录作为catalina.home才能运行，这里我们选择上一步生成的output/build作为catalina.home，并设置jvm参数，如下：

    -Dcatalina.home="/Users/liuyang/Downloads/apache-tomcat-8.5.58-src/output/build" -Dfile.encoding=UTF8 -Duser.language=en -Duser.region=US

    第一行是为了设置catalina.home，2~4行是为了日志解决乱码问题（非必要）。 我们设置JVM参数，可以参考下图： 设置好，我们运行org.apache.catalina.startup.Bootstrap的main方法，控制台提示如下： 我们打开浏览器，访问http://localhost:8080/显示如下内容，则说明容器启动成功了，如下：

    2.2 Maven+下载Tomcat编译包

    2.1.5做的操作其实就是编译tomcat源码包，构建可运行的tomcat编译文件，过程有些复杂，而且要踩很多坑。我们可以去Tomcat官网，下载源码版本对应的编译输出文件的zip包，直接将zip包解压后内容(bin lib conf work webapps目录)，复制到${项目根目录}/output/build目录下即可，进而代替自己通过ant构建。如果是从Tomcat官网下载的，可以完全忽略步骤2.1.1和步骤2.1.5，如下图所示：

    2.3 Git仓库下载

    笔者将搭建的环境上传到了远程git仓库，可以直接下载仓库代码，然后按照步骤2.1.6配置VM Options即可。仓库地址如下：https://gitee.com/rxyor_source/tomcat-for-idea.git 。不要忘记给笔者点个Star哟！

    参考

    https://developer.aliyun.com/article/666276 https://www.yuque.com/alipayrrql7pkhl7/ofayer/mxmcz9

    Processed: 0.010, SQL: 8