编写自定义Android Gradle Plugin

什么是Gradle

Gradle是我们在Android工程中的 自动构建工具自动化构建 就是将我们的代码打包成jar、aar、apk的过程。
我们知道,我们编写的Java、xml并不能直接运行在ART、Dalvik或者JVM上。需要将其编译为dex或jar、class,如可可能的话还要直接运行。Gradle将这些操作打包成一个命令。
在Java历史上有过Ant、Maven。发展到现在Gradle被认为集合了Ant和Maven的灵活和易用等优点,在这里不做论述。

自定义Gradle插件能做什么

利用Gradle,我们可以:

  1. 自动生成代码(Android R.java 以及GreedDao,Dagger等众多开元库就是这么做的(APT))
  2. 代码或文件检查(lint就是这么做的)和抛出自定义编译时错误(有时候不方便用lint等工具检查)
  3. 在打包的过程中做一些我们希望自动执行的事情,比如讲打包好的文件发到群里@相关人员等

Gradle插件如何编写

Gradle插件有三种编写,并应用的方法:

  1. 编写Gradle文件,在应用模块上用apply from: ...应用该文件。
  2. 在project目录下,新建名为buildSrc的groovy模块,用apply plugin: ...应用该模块。
  3. 新建groovy模块,打包成jar包,发布,用classpath ...引入jar包,用apply plugin: ...应用该jar包

第三种方式一般用于发布出来,但是在自己的项目中不方便debug,以及随时扩展,更适合在为其他项目服务。
下面我们主要讲一下前两中方式:

Gradle脚本插件

优点:编写灵活,适合简单的插件

  1. 编写脚本文件:
class Myplugin implements Plugin<Project> {
    @Override
    void apply(Project target) {
        target.task('hello', group: 'util') {
            doLast {
                logger.quiet("Hello Plugin.")
            }
        }
    }
}
// 需要在脚本中写这么一句,否则脚本不会运行
apply plugin:Myplugin
  1. 在需要应用plugin的模块的build.grale文件中添加脚本文件:
apply plugin: 'com.android.application'  
//引入脚本文件  
apply from: 'plugin.gradle'
android {
  ……
}
dependencies {
  ……
}

buildSrc插件

优点:适合复杂插件

  1. 新建Java library名为buildSrc:
    新建library
项目结构
  1. 修改buildSrc目录下的build.gradle,将Java模块改为groovy模块:
apply plugin: 'groovy'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation gradleApi() //gradle sdk
    implementation localGroovy() //groovy sdk
}
  1. 删除Java目录,新建groovy目录,用于添加groovy文件:

    新建grooy目录

  2. 添加Plugin文件,后缀为.groovy

// MyTask.groovy
import org.gradle.api.internal.AbstractTask
import org.gradle.api.tasks.TaskAction
import org.gradle.tooling.BuildException

class MyTask extends AbstractTask{
    @TaskAction
    void action(){
        println("Hello World")
    }
}

// MyPlugin.groovy
package com.chenhaosun

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.Task

class MyPlugin implements Plugin<Project> {
    @Override
    void apply(Project project) {

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

推荐阅读更多精彩内容