Android Gradle 插件

1.插件类型

Gradle的插件分为两种类型:脚本插件(script plugins)和二进制插件(binary plugins)。

脚本插件就是额外的构建脚本,脚本插件通常用来对构建过程进行深度配置,同样遵循声明式的思想。脚本插件常常作为另一个脚本文件(即*.gradle) 文件被放置在项目目录中,以本地文件的形式应用插件。

二进制插件就是实现了Plugin接口的类,可以用java、kotlin和groovy编写,更容易进行测试,还可以被打包成jar包共享出去。

2.Gradle插件的三种实现方式

1.脚本插件

直接在build.gradle中编写一个实现了org.gradle.api.plugins接口的类, 这个类就是一个插件。

2.在buildSrc中编写插件类

Gradle提供了一种在现有项目中编写二进制插件的方法,在项目根目录下创建 buildSrc 文件,并遵循相关规范。

Gradle会自动编译这些目录下的插件,并且将它们解析,使得在项目的所有构建脚本中都可以应用这些目录下的插件。

3.独立项目

单独建立一个项目,打包成一个jar包,实现复用。

3.自定义插件

网上能找到的示例都是基于Gradle6.0之前版本的,本文中使用的是官方文档的最新示例。

项目结构:
Project:
----app
--------build.gradle
----library
--------build.gradle
----plugin
--------src/main/java/
--------build.gradle
----build.gradle
----settings.gradle

1.在项目根目录创建一个新目录,在新目录下创建代码目录及build.gradle文件。

plugins {
    id 'java-gradle-plugin'  //Gradle开发插件
    id 'kotlin'              //使用Kotlin
    id 'maven-publish'       //插件发布
}
 
dependencies {
    implementation "com.android.tools.build:gradle:4.2.1"  //使用com.android.build.api
}
 
gradlePlugin {
    plugins {
        MethodTracer {
            id = 'com.example.plugin'                                //定义插件id
            implementationClass = 'com.example.plugin.CustomPlugin'  //定义插件实现类
        }
    }
}
 
publishing {
    // 定义发布什么
    publications {
        plugin(MavenPublication) {
            groupId = 'com.example'     //这三部分组成了:com.example:plugin:1.0.0-SNAPSHOT
            artifactId = 'plugin'
            version = '1.0.0-SNAPSHOT'
 
            from components.java        //使用默认的配置生成jar包
        }
    }
    // 定义发布到哪
    // publishPluginPublicationToRepoRepository 发布到 plugin/build/repo
    // publishPluginPublicationToMavenLocal 发布到 ~/.m2/repository
    repositories {
        maven {
            name = 'repo'
            url = layout.buildDirectory.dir("repo")
        }
    }
}

2.在项目根目录的settings.gradle中添加:include ':plugin'

3.在项目根目录的build.gradle中添加本地依赖:

buildscript {
    repositories {
        mavenLocal()
    }
    dependencies {
        classpath 'com.example:plugin:1.0.0-SNAPSHOT'
    }
}

4.在app目录的build.gradle使用插件:apply plugin: 'com.example.plugin'

5.发布插件:./gradlew publishToMavenLocal

参考文档:

Using Gradle Plugins

Gradle Plugin Development Plugin

Maven Publish Plugin

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

推荐阅读更多精彩内容

  • 随着Android的发展,性能优化、组件化等等不少开发工作不得不在编译的过程中依赖对Java字节码的修改,这就要求...
    董江鹏阅读 1,114评论 0 3
  • 什么是配置缓存? 配置缓存是一个提升 IDE 和命令行构建速度的基础构建块。这是 Gradle 6.6 版本提供的...
    谷歌开发者阅读 803评论 2 7
  • 前言 Gradle插件在Android中的应用很广泛,很多字节码插桩方案就用到了这方面的知识,Android官方提...
    唠嗑008阅读 8,204评论 4 30
  • 我是黑夜里大雨纷飞的人啊 1 “又到一年六月,有人笑有人哭,有人欢乐有人忧愁,有人惊喜有人失落,有的觉得收获满满有...
    陌忘宇阅读 8,531评论 28 53
  • 信任包括信任自己和信任他人 很多时候,很多事情,失败、遗憾、错过,源于不自信,不信任他人 觉得自己做不成,别人做不...
    吴氵晃阅读 6,187评论 4 8