一步步自定义Gradle插件

AndroidStudio现在的构建工具都是采用的gradle,可能很多小伙伴都感觉比较神秘,今天我们来从零开始自定义一个自动输出Lint报告的Gradle插件,Lint报告中可以初步检查出我们程序中的一些问题,输出HTML或者XML文档。

废话不多说,直接开始开车了。

1.自定义Gradle插件的方式

Gradle是采用Groovy语言,编写Gradle插件主要有三种方法

1.build.gradle脚本中直接使用。这种方式就是直接在Android Studioapp moudle的build.gradle 中进行插件的编写,优点就是不用再上传插件到maven或者其它地方,项目就可以直接使用;缺点也是很明显,就是只能在自己的项目中使用,不能复用,这个不是我们今天要说的。

  1. buildSrc中使用。这种方式需要在项目中新建一个model命名为buildSrc,这个目录就用来存放自定义插件。然后在src/main中建立两个目录,一个就是存放代码的groovy目录,一个是存放自定义插件名称的resources目录。这种定义方式也是只能在我们项目中进行使用,不好复用。我们今天要分享的是最灵活的方式,也就是第三点。

3.独立Module中使用。这种方式就是完全独立开发一个Module,可以随便用。

我们现在一步步来自定义这个Module。

2.自定义Module

2.1配置

首先打开IntelliJ这个神器,可以说是Android Studio之父了,然后按照下面配置新建一个工程。

新建Module.PNG

接着就是配置目录了,和上面说的第二种方式其实一样的,配置好的目录如下,其中groovy目录就是放置代码的地方,resources里面放置的是一个配置文件,文件的名字com.juexingzhe.cleaner就是在用这个插件的地方需要的名字,比如apply plugin:'com.juexingzhe.cleaner'

配置目录.PNG

上面配置文件内容,其实就是一个映射关系,找到我们定义的插件CleanerPlugin,com.juexingzhe.mobile是CleanerPlugin这个插件类所在的包名。
implementation-class=com.juexingzhe.mobile.CleanerPlugin

2.2 撸代码

环境都配置好了,接下来肯定就是实现 com.juexingzhe.mobile.CleanerPlugin这个插件了,先贴出代码我们再做解释。当然groovy也是完全兼容Java的,所以小伙伴们看起来完全无压力啊。
定义插件首先要实现Plugin接口,然后在apply方法中实现插件功能。
我们这里实现的就是输出Lint报告,很简单就是两句话,首先定义文档的输出位置xmlOutput 。

class CleanerPlugin implements Plugin<Project>{
    @Override
    void apply(Project project) {
        project.afterEvaluate {
            project.android.lintOptions.xmlOutput = new File(project.buildDir, "lintResult.xml")
        }
        project.tasks.create('cleanTest', CleanTestTask)
    }
}

为了直观感受,我添加了一个task,也就是cleanTest,这个Task就是打印几句话,证明这个插件确实起作用了,不是我在忽悠小伙伴们。看下Task的代码,因为我们这里要输出Lint报告,所以要依赖lint这个task,也就是dependsOn "lint"这行代码的作用,task的具体工作就是@TaskAction这个注解标注的方法中了,代码就没什么好解释的了。

class CleanTestTask extends DefaultTask{
    CleanTestTask() {
        super()
        dependsOn "lint"
    }
    @TaskAction
    def testClean(){
        System.out.println("==================")
        System.out.println("Test Clean Task")
        System.out.println("==================")
    }
}

到这里我们插件的代码工作基本就完成了,剩下最后一个问题,怎么用这个插件呢?当然就是上传Maven等等的仓库中了,这里为了方便我就上传到自己的本地了。

2.3 上传插件

上传插件就是在这个Module的build.gradle中写Task了,看下代码,我就上传到工程目录的平级目录中的repo目录下了。

apply plugin: 'maven'
group = 'com.juexingzhe.mobile'
version = '1.0.0'

uploadArchives {
    repositories {
        mavenDeployer {
            //本地的Maven地址设置为D:/repos
            repository(url: uri('../repo'))
        }
    }
}

OK,代码的工作就真正完成了,这回没骗人。点击下build就能看见我们定义的uploadArchives这个Task了。

上传Task.PNG

点击下这个任务就能在我们的目录下生成这个插件。


插件仓库.PNG

这样我们的插件就完成了,接下来就是怎么用的问题了。

3.使用插件

首先在要使用这个插件的app目录下的build.gradle中添加下面代码:

1.apply plugin的名字就是上面我们在resources中定义的properties文件的文件名;

2.maven仓库就是我们上面的仓库地址;
3.就是添加依赖,其中com.juexingzhe.mobile就是group,juexingzhe就是上面插件工程的工程名,1.0.0就是版本号了,group和version都是在上面的gradle中定义了,module没定义就默认使用工程名了。

apply plugin: 'com.juexingzhe.cleaner'

buildscript {
    repositories {
        maven {
            url uri('E:/code/repo')
        }
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.3'
        classpath 'com.juexingzhe.mobile:juexingzhe:1.0.0'
    }
}

添加上面代码后Sync一下就能看见我们的Task了:


cleanTest.PNG

到这一步就是大功告成了,点击下这个Task就能执行出报告和打印日志了。


日志.PNG

然后在工程目录app目录下的build就可以找到Lint输出报告了:
lint报告.PNG

我在工程中故意强引用了一些汉字,没有定义到string资源文件中,就能报告出来:


lint报告内容.PNG

4.总结

其实定义插件没有那么困难,语言也是完全可以用Java来编写,插件还是有很多可以用的地方,比如我们定义的编译期注解就可以使用插件的方式来处理,在编译的时候运行我们的插件,完成信息的获取等。
定义过程要注意配置的一些小细节,一步步设置好了就能正常运行出结果的。

后期还会再定义一个处理注解的插件,这个也是路由的前提。

今天开车就到这了,如果觉得还不错,欢迎关注欢迎点赞哦。

最后感谢@右倾倾的理解和支持。

本文结!

欢迎关注公众号:JueCode

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

推荐阅读更多精彩内容