前言
今年的更新频率简直是降至冰点了,一方面平时加班相对多一些了,下班只想玩手机;另一方面,好像进了大厂后,学习动力也很低了,总之就,很懒散,博客的话,今年都才只更新了不到5篇。
现在慢慢有一点状态,开始学点技术;今天这篇就是讲maven插件,为啥会折腾这个,公司内有个mybatis generator,针对公司内部做了一些定制开发,具体内容不知道,但是,有个很蛋疼的问题,在根据数据库表,反向生成po的时候,不能把数据库表的字段的注释,给生成为po的field 注释。
之前试过自己折腾一下,解决这个问题,但是实在不了解maven插件这块,因此一直就忍了将就用,大不了就没有注释嘛;前几个月就把maven源码下载下来了,但是源码里一堆的单元测试,却一直不知道怎么像我们平时使用的方式那样去debug,最后就三天打鱼两天晒网地瞎看,效果很差,看了多少就忘多少,最近才把debug插件的方式折腾ok,这里就分享给大家。
下边正文。
越是复杂的开源项目,里面用到的maven插件就越多,一个pom,大几百行是常事,经常呢,大家都是只知道怎么配置,或者说,不知道怎么配置,需要改配置的时候,就一顿猛搜,经常网上搜出来的,可能还因为版本不匹配发生“他文章里可以,我这边为啥不行”。
反正,总结一句话,maven插件很多时候,对大家来说,就是一个黑盒。
而我们恰恰不太能忍受黑盒,当然了,像什么jvm那种c++写的黑盒就算了,让人头秃。
另外,可以再给大家一个看这篇文章的理由,就问你一个问题:spring boot是怎么打包成fat jar,又是怎么从一个fat jar启动的?
是吧,这里的答案就在spring boot的maven插件里了。今天我们肯定不会那么复杂,搞个clean插件学习下,就ok了。
怎么单行调试一个插件的源码呢
创建演示工程
我们需要一个maven的project,最终弄完,我这边样子是这样的:
下边是步骤:直接像下面这样生成一个,然后next结束:
为了方便演示,我们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.example</groupId>
<artifactId>test-project</artifactId>
<version>1.0-SNAPSHOT</version>
<name>test-project</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
</build>
</project>
大家看上面这个pom,很干净,会不会以为这样就没有配置插件了呢,不是的,默认的,就会给我们的maven的生命周期绑定一些插件,比如在clean阶段绑定maven-clean-plugin插件。可以看我下图,可以看到这里还是有好几个插件的,为了力求简单好理解,我们关注clean插件,我这边是2.5版本,大家对于版本号不用纠结,可能不同的idea版本出来的会有差异。
调试clean插件
怎么调试呢,首先得触发maven的clean插件执行,是吧?怎么触发执行呢?
如何触发执行clean插件
针对这种命令很简单的,不需要给插件传参数的命令,直接上图这样就可以触发调试运行。
大家来看看执行效果:
上面这一串,看起来很长,其实很多都是-D指定的SystemProperty和classpath,最终呢,其实就是java -main类 -args的格式。
这里的参数就是"clean:clean"。
去哪里打断点
有人开始问了,你不是说调试吗,这都一把跑完了啊,再说了,我想打断点去哪里打呢?
ok,要打断点,我们得知道,mvn clean肯定会执行到的那个方法,然后才能在那里提前打断点埋伏,就好像我们总是知道,程序执行,会进入main方法一样。
而mvn clean,一定会执行到clean插件中的CleanMojo这个class(这部分知识算是需要提前了解的部分):
要调试这个类,必须得在当前的project(idea里,一个project包含多个module)里,能找到这个class。在idea里,老子上来就是double shift,
看起来,找不到这个类啊,还怎么玩?最简单的办法是,先直接把这个jar包加到project里面,
添加到libraries里:
加的时候,会提示你,要不要加入到当前这个project,要选:yes。加了后,就可以看到:
老子抬手又是doubel shift,可以看到,这个cleanMojo已经存在了。
既然存在了,接下来就是打断点:
继续触发执行debug
可以看到,已经成功停在了我们的断点上,接下来单步调试就行。但是哈,大家也注意到,我们这边因为是打在反编译的class上的,而反编译的class呢,肯定没有源码那么舒服的,这个问题呢,也简单,等我循序渐进来讲。
去哪里打断点--方式2
我们下边这个方式,当然是想办法在源码上打断点,源码去哪里获取?
https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-clean-plugin/2.5
源码下载下来后,我尝试了下图这样的方式(就是在前面方案的基础上,把源码附上了):
这种方式,打个断点,看看:
这个方式是可以调试插件本身那几个java文件,但是插件依赖的那些,就还是有问题,这种方式吧,鸡肋。
去哪里打断点--最推荐的方式
我们还是不搞那些有的没的了,来官方的插件开发地址拉代码:
https://maven.apache.org/scm.html
下载后解压,发现是个maven工程,舒服了。直接导入idea。导入后,我们打好了断点,下边开始,跑一波debug。
可以看到,这把舒服了,确确实实,调试的是源代码了。但是,这里提醒一下,不要想着去改代码,如果直接改,改了肯定就class和java源码的行号,对应不上了,至于为什么,这是一个值得大书特书的故事了,留待后续。
扩展
前面我们说的,触发maven clean执行,是用的这种方式。
实际上,这种只能应付简单场景,不需要传参什么的,复杂场景还是需要像下面这样:
比如,我们公司的那个mybatis 生成器:
就会指定很多参数,比如对应的配置文件的位置,对吧。
本文由博客一文多发平台 OpenWrite 发布!