Gradle系列 (上篇) —Android自定义Gradle插件并在项目中使用

一、关于Gradle

Android项目的构建过程是通过一系列Gradle插件完成的,而Gradle插件是使用Groovy语言实现的,Groovy是一种脚本语言,在国外还是很火的,但是国内使用的貌似不多,Groovy 可以与 Java 语言无缝对接,在写 Groovy 的时候如果忘记了语法可以直接按Java的语法继续写,也可以在 Java 中调用 Groovy 脚本,都可以很好的工作。关于Groovy语言可以到官网做稍微了解学习:Groovy官网,也可以到精通Groovy简单学习。

Gradle中的所有内容都基于两个基本概念:Project和Task

Project:这个接口是build file与Gradle交互的主要API,通过Project接口可以访问Gradle的功能。
Task:一个Project本质上是Task对象的集合,每个Task都执行一些基本的工作,比如compileDebugJavaWithJavac、assembleRelease等等。

Android项目的build过程

上面这张图诠释了Gradle build的生命周期的过程,分为三个阶段。对于Android项目,在Configuration阶段会解析项目根目录下的build.gradle文件。

上面的 classpath 'com.android.tools.build:gradle:3.6.1' 就是用来导入用于构建Android项目的Gradle 插件库的,导入插件库以后,就可以在项目的子module的build.gradle中应用该插件库中的插件了:

apply plugin: 'com.android.application'

为了更清晰的理解gradle插件和使用,那接下来就来自定义一个gradle插件并使用它。

二、自定义Gradle插件

Gradle 一共提供了三种方式创建自定义插件:

1、直接在build脚本中开发包含插件的源代码:

插件可以自动编译并包含在build脚本的classpath中,而无需执行其他任何操作。 但是不能在build脚本之外重用插件。

2、在buildSrc这个project中创建自定义插件:

在项目中创建module,命名为BuildSrc(必须为BuildSrc),与app同级。该方式与第三种有点相似,下面会重点介绍第三种方式。该插件对build使用的每个build脚本都是可见的。 但是在build之外是不可见的,所以不能在build之外重用该插件。

3、在独立的module中创建自定义插件:

为自定义gradle插件创建一个单独的project。 该project生成并发布一个包,可以在多个build中使用该包。

  • 创建一个module(Android Library),命名随意,我这里叫“MyPlugin”。
  • 删除多余的文件,只留下src/main以及build.gradle文件,如下:

首先我们要在src/main/这个路径下创建两个文件夹:一个是groovy,另外一个是resources/META-INF/gradle-plugins
注意:这里的目录名字不能写错 ,不然运行的时候会找不到。
修改过后的截图如下:

接下来就可以完善插件内容和配置信息了。
因为插件是用groovy语言写的,所以接下来我们要在myplugin中的build.gradle添加如下信息,先删除之前的内容。

apply plugin: 'groovy'
apply plugin: 'maven'

dependencies {
    implementation gradleApi()
    implementation localGroovy()
}

repositories {
    mavenCentral()
}


//设置插件的GAV参数
group = 'com.zhuyong.myplugin'
archivesBaseName = 'MyPlugin'
version = '1.0.0'


uploadArchives {
    repositories {
        mavenDeployer {
            //在当前同级目录下生成maven包
            repository(url: uri('repository'))
        }
    }
}

此时可以执行以下Sync同步一下。下一步要开发插件的可执行代码了,在groovy文件夹下新建package包:com/zhuyong/myplugin,然后新建一个xxx.groovy的文件(创建方式:new → file → xxx.groovy ) ,我这里的groovy叫做MyPlugin.groovy,截图如下:

这个groovy文件的是为成为gradle插件而服务的,需要实现org.gradle.api.Plugin的接口,然后在重载的apply()方法中是插件执行的逻辑,我们在这个插件中输出一些字符串来验证是否执行了当前插件:

OK,Plugin已经完成了,那么如何引用它呢,别急继续看。
如何让其他Project知道我们这个是gradle插件呢?关键就在刚才创建的resources/META-INF/gradle-plugins,在该目录下创建properties类型的文件,这里文件命名很重要,这里的命名就是后面我们使用插件所依赖的方式,比如命名为custom-gradle-plugin.properties,那么在使用时就是:

apply plugin: 'custom-gradle-plugin'

这里新建完成properties文件以后,输入以下内容:implementation-class=自定义的Plugin类的路径,截图如下:

  • 打包发布自定义插件

我们已经自定义好了插件,下一步我们就要进行打包的过程了,刚才已经在build.gradle里面指定好了打包的路径以及版本号等参数信息,现在我们需要打包一下,在右侧边栏的myplugin这个module下,在upload下面有一个uploadArchives,双击他就会开始打包了:

此时我们可以看到打包的过程如下:

此时,在myplugin目录下就可以看到生成的文件夹了:

  • 引用自定义插件
    第一步:在项目根目录下的build.gradle中添加以下代码:
maven {
    url uri('myplugin/repository')
}

------------------------------------------------------------------

classpath 'com.zhuyong.myplugin:MyPlugin:1.0.0'

截图如下:

第二步:在app目录下的build.gradle中添加以下代码:

apply plugin: 'custom-gradle-plugin'

截图如下:

此时,执行Sync或者clean,就可以在控制台输出之前我们写的代码了,如下:

OK,到此为止就已经完成了自定义Gradle插件的全部内容了,下篇我们将介绍如何通过插件在class文件内注入自定义代码——《Gradle系列 (中篇) —在自定义Gradle插件中使用javassist往class中注入代码

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

推荐阅读更多精彩内容