自定义Gradle Plugin入门

参考自
https://blog.csdn.net/huachao1001/article/details/51810328
https://blog.csdn.net/huachao1001/article/details/51819972
https://blog.csdn.net/tscyds/article/details/78082861

在Android项目当中,Google官方使用Gradle来对其进行构建。所以这就使得我们可以通过自定义的Gradle插件来修改编译后的class文件。修改class文件的字节码可以使得我们来做一些用日常思路比较麻烦的事情,例如:

  • 对于关键节点的插桩做性能监控。
  • 修改第三方依赖。

等等(其实我只用到了插桩做了一个简单的性能监控)

新建一个Gradle Module

Gradle Module从引用方式上可以分为两种

  • 一种是只能在本工程中使用的Groovy插件
  • 另一种是可以将其打包发布出去使用的Groovy插件

两种方式相同的部分

由于在AS中没有“新建Gradle Plugin”这种选项,
所以我们可以选择新建Java Module或者是Android Module。
如果是新建一个Android Module,则需要将文件夹中的内容悉数删除,只留下build.gradle文件和src/main目录。之后在src/main目录下新建一个groovy目录即可。
(总之最后的目录结构是这个样子即可)


以下是两种方式的不同部分

只能在本工程中使用的Groovy插件

将这个Module的module name命名为buildSrc(这个Module的名称必须为buildSrc)

可以将其打包发布的Groovy插件

可以打包发布的Groovy在Module的命名上并没有什么特殊的要求。在新建完成groovy目录之后,在main目录下新建resources/META-INF目录。在META-INF中新建一个“.properties”文件。这个文件的名称就是日后在apply plugin中使用的名称。

例如将其命名为"pluginTest.properties"那么在需要引用这个插件的Gradle中就要写成

apply plugin: 'pluginTest'

在这里有一些坑,“.properties”和“.groovy”比较容易在引用的时候报not found,这里在AS当中必须将扩展名显式的写入到文件名当中,比如“pluginTest.properties”,和“Test.groovy”

在编写完成后在插件的Gradle中配置以下的脚本,可以将其发布至本地repo中

uploadArchives {
    repositories.mavenDeployer {
        repository(url: uri('../repo')) //仓库的路径,此处是项目根目录下的 repo 的文件夹
        pom.groupId = 'example.asus.Test2Groovy'  //groupId ,自行定义,一般是包名
        pom.artifactId = 'Test2Groovy' //artifactId ,自行定义
        pom.version = '1.0' //version 版本号
    }
}

然后执行uploadArchives(双击一下执行,还是比较方便的)


在工程中引用

只能在本工程中使用的Groovy插件

在引用的时候只需要在app下的build.gradle中配置

apply plugin: example.asus.test.Plugin_perormanceAnalysis

格式为:包名+Plugin的类名
即可(注意没有引号)

打包发布的Groovy插件

(之前试过很多种方法,但是我只试出来一种可以用到的,仅做以记录,希望诸位多多指教)
在app下的build.gradle中末尾加入

repositories {
    jcenter()
    google()
    maven {
        url uri('../repo')
    }
}

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

推荐阅读更多精彩内容