主工程中添加并调试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<T> 接口。一个工程下,可以有多个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!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,324评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,356评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,328评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,147评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,160评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,115评论 1 296
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,025评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,867评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,307评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,528评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,688评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,409评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,001评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,657评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,811评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,685评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,573评论 2 353

推荐阅读更多精彩内容