Gradle插件开发秘籍之断点调试(基于Intellij)

Gradle插件开发这件事说大不大说小不小,可是对于有必定体量规模的Java项目来说,从插件开发入手来思考解决问题,有的时候能找到意想不到的法门。因此说这是一门锦上添花的手艺。
废话少说,相信对于不少Gradle插件开发朋友们,开发过程当中很大的一个痛点就是,插件的调试很痛苦,下面我就分享一下在这方面的心得。socket

1、增长运行参数

好吧这个很菜鸟,好比很经常使用参数的是--stacktrace,报错后会打印出堆栈信息工具

2、Log输出控制

这个很少说了,println就能够了,能够本身设置一些分级和flag。gradle

3、干货技巧:开启调试模式,attach a debugger!

先上最终效果图:
图片描述spa

如上图,是能够正常地设置断点调试和step into和step out、resume等等。
实现办法和原理:
你们都知道Gradle基于Groovy,而Groovy其实就是Java,因此也一样遵循JDWP协议,只是这个技巧彷佛在国内的文章中没有人出来分享,我就在此分享给你们。
首先,在你要执行gradle命令的环境中加入以下环境变量(以Linux、MacOS为例):插件

export GRADLE_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"

其中,address等号后面的参数就表示debugger要监听的端口,这里咱们设置为5005。
而后执行gradle或gradlew任务,会发现有以下提示:命令行

以debug模式运行gradle

这时任务就不会继续执行了,挂起等待Debugger的handshake!
这时咱们启动IDE,以Intellij为例,打开咱们的gradle插件项目(包含正在运行的插件源码的项目),而后找到工具栏的执行区域,进入以下:debug

建立debugger

在界面里添加一个运行项,Remote:调试

建立debugger

须要配置的最核心参数就是如图所示的端口号,就是上文中的address:code

配置debugger

注意到下面有一个Search sources using ...意思是从什么范围查找源码,保持默认就行了,这个debugger收到JDWP消息后会从当前工程中搜索源码,基于当前的源码进行与gradle命令行中的JDWP agent进行交互。server

OK,若是插件源码中打好断点,执行到代码时就会挂起在相应位置了,大部分调试功能都很好使,你们能够尝试一下!这个技巧仍是比较简单的,你们只要了解一下JDWP的核心原理,就能够理解上述过程了!

时间有限,若有不妥,欢迎指正!

相关文章
相关标签/搜索