Android gradle-plugin 相关

一、概念

Gradle Plugin 的作用是什么?
  • 模块化构建脚本的功能
  • 公共的功能可以抽取出来成为插件,可以供多个 Module (build.gradle)使用,增加复用性。

在 Android Studio 中gradle作为主要的构建工具,其核心工作任务在于执行一系列的Task。而 plugin 在 gradle 构建过程又扮演着举足轻重的角色,有时为了完成相应的构建任务必须通过引入相应的插件来辅助,这些插件中定义了构建Project需要的一系列Task,并且负责执行相应的Task,比如构建android应用 'com.android.application',构建 Library 的 'com.android.library'。 除了系统自带的插件外,有时候我们也需要开发属于我们自己的plugin,比如热修复,插件化开发中基本上都有可能会去自定义插件。

二、定义gradle plugin 的几种方式

自定义插件主要有三种方式

1、直接在 module 的 build.gradle 中开发
2、创建当前项目使用的插件
3、创建通用的插件,发布到maven

2.1 build.gradle 中开发

我们在自己module 的 build.gradle 中编写代码

apply plugin: 'com.android.application'

apply plugin: HelloPlugin

class HelloPlugin implements Plugin<Project>{
    @Override
    void apply(Project project) {
        project.task('testPlugin')  {
            println 'hello, plugin!'
        }
    }
}

上面我们定义了一个名为HelloPlugin的插件,然后其中定义了testPlugin 的task,下面我们测试看看效果,在Terminal 中执行 ./graadlew testPlugin 命令。

执行结果

当然除了可以定义 task,还有很多其他用处,这里以 task 为例,看如何定义Gradle Plugin

2.2 创建当前项目使用的插件

1、新建一个类型为Java Library的Module,名字为buildSrc,注意这个名字只能为buildSrc,如果不是这个名称,这里是无法apply包名的,会提示找不到。buildSrc这个module是预留的module,会从这个module下搜寻gradle plugin。(或者直接在项目下新建一个 buildSrc 的文件夹,在添加build.gradle文件 和 src/main 目录)

2、除build.gradle,src/main外,其他文件都删除掉,删除main下的文件。

3、在src/main下新建groovy文件夹。

4、在groovy文件夹下新建package,包名随便取,例如com.daddyno1.buildsrc

5、在package下创建.groovy的文件,例如MyPlugin.groovy。

6、在跟 groovy 平级创建目录:resources/META-INF/gradle-plugins

7、在resources/META-INF/gradle-plugins下创建 ***.properties。注意:***就是以后 apply plugin:'***'的标识。本例中用:com.daddyno1.properties

8、编辑 com.daddyno1.properties 内容,标识真正的Plugin实现类,如:implementation-class=com.daddyno1.buildsrc.MyPlugin

9、修改 build.gradle文件:

apply plugin: 'groovy'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
   //Creates a dependency on the Groovy that is distributed with the current version of Gradle.
    implementation localGroovy()

    //Creates a dependency on the API of the current version of Gradle.
    implementation gradleApi()
}

sourceCompatibility = "8"
targetCompatibility = "8"

整体项目目录如下:

MyPlugin.groovy 如下:

package com.daddyno1.buildsrc

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

class MyPlugin implements Plugin<Project>{

    @Override
    void apply(Project project) {
        println "========================= start ======================="
        println "========================= end ======================="
    }
}

在需要用到 pluginmodule 中使用 apply plugin: 'com.daddyno1'

编译一下看效果:

2.3 创建通用的插件,发布到maven

略,具体参考:https://www.jianshu.com/p/6ec6b06cb5d6 。 其实跟第二种差别不大,就是使用了 maven plugin 把代码发布到仓库。

三、插件扩展 Extension

什么是扩展插件?

扩展插件 Extension 就是用于 Plugin 与 Project 通讯用的。

我们可以在 build.gradle 中通过配置 Extension 相关属性,然后将这个 Extension 这个对象传递给我们自定义的Plugin。 更详细的举例参考(https://www.jianshu.com/p/ffd6153ace1d

四、通过学习 hugo (https://github.com/JakeWharton/hugo)能够获得什么

1、通过面向切面的方式(AspectJ)实现对方法的性能检测。
2、定义Android Gradle Plugin,更好的理解 Plugin的作用 (公共的功能可以抽取出来成为插件,可以供多个 Module (build.gradle)使用,增加复用性。
3、Plugin Extension 的使用

参考:
https://www.jianshu.com/p/ffd6153ace1d
https://www.jianshu.com/p/6ec6b06cb5d6

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

推荐阅读更多精彩内容