Maven源码调试工程搭建

思路

咱们后面的文章《【曹工杂谈】Maven和Tomcat能有啥分割呢，都穿打补丁的衣服吗》剖析了Maven大体的执行阶段，次要包含三个阶段：

  1. 启动类阶段，负责加载框架；
  2. 框架外围（maven core）阶段，次要负责依据参数中的goal，如clean，找到对应的插件的jar包，生成插件对象，解析参数并调用插件代码；
  3. 插件执行阶段，执行实现后，控制权会交还给框架外围，由maven core实现善后工作。

这三个阶段，别离会去不同的中央加载对应的jar包。

大略理解了这个流程后，咱们开始思考，咱们到底要调试哪一部分的代码。

  • 如果咱们要调试阶段一的代码，那么，又分两种状况，是否须要改变阶段一的代码，如果须要改变，那么，就要找到阶段一的jar的源码，而后加载到idea中，并且，启动调试的时候，也需把classpath指定到咱们的源码工程；如果不须要改变，那就能够参考：《【曹工杂谈】详解Maven插件调试办法》，间接把jar包引入idea的project classpath即可。
  • 如果咱们须要调试阶段二的代码，那么，也分两种状况，须要改变代码，就去找源码，而后引入到idea；同时，阶段一去找阶段二的时候，默认还是去了%MAVEN_HOME%/lib/*.jar下边去找，咱们这时候就得纠正它的错误行为，让它转而去咱们的源码工程下找阶段二的代码。
  • 如果须要调试阶段三的代码，如果须要改变，默认也是要引入插件的源码工程；然而，阶段二，去找插件代码的时候，要让它去咱们的源码工程下找代码是比拟艰难的（默认就是去本地仓库找，要纠正这个行为，难度较大），因而，就算了。咱们还是会引入插件的源码，然而，每次改了插件代码，手动部署到本地仓库就行。

咱们接下来，就开始实现下面的三个指标。

搭建阶段三的调试工程

大部分人可能感兴趣的还是插件代码，想本人搭着玩的，能够参考：《【曹工杂谈】详解Maven插件调试办法》

然而在这里，我还是须要基于我在gitee上新建的一个仓库，来给大家解说。后续的源码剖析文章（如果有的话）也会基于这个工程来解说。

代码在这里：https://gitee.com/ckl111/mave...

下边介绍下目录构造：

  • test-maven-core，用来在这个module的pom上，执行mvn clean等命令
  • plugin-sources，用来寄存插件的代码，后续的插件源码都会往这里放
  • plexus-classworlds-source，用来寄存阶段一的那个启动类的源码
  • 除此之外，都是maven框架自身的源码，这部分，统称为maven core

下载了源码后，进行idea导入，导入时，抉择这个主目录下的pom，这个pom，就是框架外围的pom，默认只会导入框架外围的maven工程；咱们还须要手动，把test-maven-core、plugin-sources、plexus-classworlds-source都导入一下（对着pom右键，Mark As Maven Project即可）。

导入实现后，咱们默认会有4个root maven工程，其中，最下面的那个Apache Maven，就是maven外围框架。

接下来，也简略了，如果不须要批改代码的话，那就能够在任意地位打断点了。打完断点，怎么触发呢， 下边这样就行了。

我这边曾经ok了，你呢？

如果想批改插件代码，改完后，记得mvn install插件到本地仓库。

搭建阶段二的调试工程

如果大家只是想跟着代码debug，那么，间接在maven框架对应的类上打断点就行了，下图就是在maven core这个module上打断点。

如果可能本人想改改maven源码、辅助学习的话，咱们就得动点心理。

在此之前，咱们须要把整个maven框架外围，先编译一次，因而，在G:\gitee-projects\maven-3.8.1-source-learn（只是我这边的目录）下，执行：

mvn -DskipTests=true install

如果大家有报错，什么rat相干的，能够来这里：

把这个插件元素（<plugin>元素）删掉。

我这边还遇到了checkstyle报错，同样，也在这个pom里，把checkstyle查看删掉。

最终呢，还是执行ok了。

下面这步ok后，在昨天的文章里《【曹工杂谈】Maven和Tomcat能有啥分割呢，都穿打补丁的衣服吗》，咱们说了，maven的启动类，是去下边这个中央，找maven core代码的：

F:\tools\apache-maven-3.8.1-bin\apache-maven-3.8.1\bin\m2.conf.

文件内容本来是这样的：

main is org.apache.maven.cli.MavenCli from plexus.coreset maven.conf default ${maven.home}/conf[plexus.core]load       ${maven.conf}/loggingoptionally ${maven.home}/lib/ext/*.jarload       ${maven.home}/lib/*.jar

其中，load ${maven.home}/lib/*.jar就加载了maven的外围框架jar。这个中央，咱们得改改，让它还得去咱们idea中源码工程下加载class。

main is org.apache.maven.cli.MavenCli from plexus.coreset maven.conf default ${maven.home}/conf[plexus.core]load       ${maven.conf}/loggingoptionally ${maven.home}/lib/ext/*.jarload       G:\gitee-projects\maven-3.8.1-source-learn\maven-artifact\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-builder-support\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-compat\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-core\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-embedder\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-model\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-model-builder\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-plugin-api\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-repository-metadata\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-resolver-provider\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-settings\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-settings-builder\target\classesload       G:\gitee-projects\maven-3.8.1-source-learn\maven-slf4j-provider\target\classesload       ${maven.home}/lib/*.jar

也就是去咱们得target下加载classes。

这样呢，咱们就能够改变咱们idea里导入的maven 外围框架的代码，而后compile了，compile后，class进入到对应的target目录下，正好就在上文的m2.conf里的门路中。

为了验证是否失效，咱们轻易在maven外围框架打了个断点，看看以后类的类加载器的门路，发现的确曾经ok了。

搭建阶段一的调试工程

阶段一，也就是那个启动jar包，对应的源码在：

咱们只须要在启动测试工程里，把classpath指向这里的target目录，而不是maven装置目录下的plexus-classworlds-2.6.0.jar就能够了。

咱们把这段复制进去，而后把其中，指向jar包的替换掉：

-classpath "G:\gitee-projects\maven-3.8.1-source-learn\target;F:\tools\apache-maven-3.8.1-bin\apache-maven-3.8.1\boot\plexus-classworlds.license;C:\Program Files\JetBrains\IntelliJ IDEA 2021.1.1\lib\idea_rt.jar"

把这段贴到maven执行的参数中即可。

总结

汇总一下：

  1. 阶段一，指定classpath来调试咱们的源码工程：

    -classpath "G:\gitee-projects\maven-3.8.1-source-learn\target;F:\tools\apache-maven-3.8.1-bin\apache-maven-3.8.1\boot\plexus-classworlds.license;C:\Program Files\JetBrains\IntelliJ IDEA 2021.1.1\lib\idea_rt.jar"
  2. 阶段二，框架外围阶段，通过批改maven装置目录下的m2.conf的内容来实现
  3. 阶段三，插件源码阶段，批改源码后，通过编译部署到本地仓库后实现

我是逐日, 深圳腾讯打工人，成都深圳两地重复横跳的后端java程序猿一枚. 之前在深圳3年，起初去了成都4年，当初又来了深圳，也开始写写前端，有须要内推的能够找我。对于一线编码实战、网络、数据库、高并发等有浓厚兴趣。

也欢送加我，拉进技术群一起交换；腾讯内推也能够找我。

本文由博客一文多发平台 OpenWrite 公布！