Android Gradle之自定义Gradle Plugin

       Android自定义plugin有三种方法,本文只记录自定义的plugin作为独立项目,主要分为以下六个步骤

1.首先新建java/kotlin library这个module,作为我们此次要自定义的plugin,build.gradle文件如下
plugins {
    id 'java-library'
    id 'kotlin'
    id 'maven'   //本文用到maven本地仓库来管理plugin
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_7
    targetCompatibility = JavaVersion.VERSION_1_7
}

dependencies {
    implementation gradleApi()   //使用到gradle包里的方法进行自定义plugin
}

//上传plugin到本地maven仓库
uploadArchives{
    repositories {
        mavenDeployer {
            repository(url: uri(rootProject.ext.maven_dir))
            pom.groupId = 'com.kunsan.plugin'
            pom.artifactId = 'myplugin'
            pom.version = '1.0.0'
        }
    }
}
2.创建我们要自定义的plugin,实现gradle的Plugin接口
import org.gradle.api.Plugin
import org.gradle.api.Project

class MyPlugin :Plugin<Project>{
    override fun apply(target: Project) {
        println("-----加载插件-----")
    }
}
3.创建properties文件

作为外部依赖我们的plugin的导向标,properties文件的名称就是到时候apply plugin的名称,比如,这边我命名成com.kunsan.plugin.properties,外部要引用我们插件,就是通过apply plugin 'com.kunsan.plugin',然后properties文件的内容如下:

implementation-class=com.kunsan.plugin.MyPlugin

就是第二部创建的MyPlugin的具体路径

4.配置项目plugin引用

以上三个步骤已经把我们自定义plugin就绪,可以提供外部使用的工作都做好了,接下里看下外部怎么使用我们的plugin,在项目级的build.gradle文件中,如下:

apply from: "config.gradle"

buildscript {
    ext.kotlin_version = "1.4.21"
    ext.maven_dir = 'file://H://CustomPlugin/repo'    
    repositories {
        google()
        jcenter()
        maven { url maven_dir }      //依赖本地maven仓库的地址
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.0.1"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        //步骤1中的本地maven配置 groupId+artifactId+version 注意groupId和artifactId以冒号隔开
        classpath 'com.kunsan.plugin:myplugin:1.0.0'     
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        maven { url maven_dir }
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}
5.指定模块引用plugin

       现在我们假设在app模块引入这个插件:build.gradle

plugins {
    id 'com.android.application'
    id 'kotlin-android'
    id 'com.kunsan.plugin'    //plugin名称就是步骤2说的properties文件的名称
}
8.上传plugin

       至此,我们也依赖了自定义的plugin,但是如果此时你直接syns,会报错找不到plugin id,因为此时我们还没有将插件上传到本地maven中,步骤1我们定义了上传方法uploadArchives,双击该脚本命令将plugin上传(注意每次修改MyPlugin的代码,都需要上传一次更新)

gradle

以上就是一次完整的自定义plugin过程,过程还是很简单的,接下来一篇文章会实践真正有实际意义的plugin。

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

推荐阅读更多精彩内容