主工程中添加并调试Gradle Plugin工程

背景介绍:
在某些情况下,我们需要在打包过程中执行一些自定义Task,或者我们想支持我们自定义的Gradle指令。一般有两种方式可以实现:

  • build.grade 中添加自定义代码
  • 自定义Gradle Plugin

为了能够直接debug自定义Gradle Plugin中的Groovy代码,我们采用将Gradle工程直接引入主工程的方式来实现。 如果是想封装Plugin的实现,可以单独建个工程,build生成lib包,然后在主工程中引用。下面主要说以下如何添加一个Gradle工程到主工程,并如何对它进行调试。

添加工程:

  • 安装Groovy,可以通过brew, sdkman 等工具来下载安装。
  • 在主工程新建一个Module, Module name随意,但是文件夹名称必须为 buildSrc。 Model的类型选择为Groovy类型。(如果类型选择不对也不要在意,后面可以尝试修改Model的build.gradle文件来修改类型)
  • 在新Model中新建如下的目录结构, 可以把原有的默认文件全删除,然后再新建。需要注意的是groovy文件夹的层级必须一致(如果出现文件夹不识别的情况,重新标记下文件夹的作用) 。官方解释:You can put the source for the plugin in the rootProjectDir/buildSrc/src/main/groovy directory. Gradle will take care of compiling and testing the plugin and making it available on the classpath of the build script.
  • 在groovy文件夹下 创建自己的Plugin逻辑也就是实现 Plugin 接口。一个工程下,可以有多个plugin实现。需要注意的是resources文件夹中必须添加对应Plugin的声明。具体格式是: 在resources目录下META-INF.gradle-pludins包下新建一个 plugin-name.properties(plugin-name是自己取的),最后在.properties 文件中指定该plugin的实现类。

到此为止,一个GradlePlugin工程就添加到主工程了,我们可以自定义一些任务并指定它的执行时机。

开启调试
Groovy的语法相对比较”开放“,Intel J很多时候不能给出代码异常的提示,所以很多时候我们需要调试来定位问题。

  • 在Debug Configurations里新建一个Remote类型的配置。
  • 端口都选择默认,直接点击保存。

  • 开启调试:

        $ export GRADLE_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"
    
  • 启动待调试的Task:

        $ ./gradlew aRelease -Dorg.gradle.daemon=false
    

    //一定要关闭daemon,一定要关闭daemon,一定要关闭daemon

  • 点击调试Remote 任务:

  • 关闭调试:

        $ unset GRADLE_OPTS
    

最终可以随意开发和调试Plugin代码了。Cheers!

你可能感兴趣的:(主工程中添加并调试Gradle Plugin工程)