自定义Gradle Plugin

第一步 :
new 一个 module 出来,选择android library即可

第二步:
将新建的module除了 build.gradlesrc/main 之外的文件删除

第三步:
修改build.gradle文件为以下内容,点击sync now

plugins {
    id 'groovy'
    id 'maven'
    id 'java'
}

repositories{
    mavenCentral()
}

dependencies {
    implementation fileTree(dir: 'libs',includes: ['*.jar'])

    implementation gradleApi()
    implementation localGroovy()

    implementation 'com.android.tools.build:gradle:4.2.2'
}

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

第四步:
src/main文件下创建groovy文件夹,然后我们去自定义一个plugin类实现Plugin接口,我这里随意创建了一个命名为TimePlugin的类

package com.ym.plugin;

//这里要注意,不要导错包了,不然我们后面部署的时候会有编译异常
import org.gradle.api.Plugin;
import org.gradle.api.Project;

public class TimePlugin implements Plugin<Project> {
    //当插件被引用时,此方法会在编译时执行
    @Override
    public void apply(Project project) {
        System.out.println("这是我的个人插件");
    }
}

第五步:
src/main下面创建resources/META-INF/gradle-plugins文件夹,在此文件夹下创建Time-plugin.properties文件,这里的「Time-plugin」是随意命名的,会在稍后app引用插件的步骤中,使用到此名称,文件中的内容如下,其中com.ym.plugin.TimePlugin是步骤4我们自定义的插件类

implementation-class=com.ym.plugin.TimePlugin

第六步:
对插件进行部署,我们可以部署到远程maven,也可以部署到我们本地,我们这里就简单部署到本地就可以,在build.gradle文件中添加以下代码

plugins {
    id 'groovy'
    id 'maven'
    id 'java'
}

repositories{
    mavenCentral()
}

dependencies {
    implementation fileTree(dir: 'libs',includes: ['*.jar'])

    implementation gradleApi()
    implementation localGroovy()

    implementation 'com.android.tools.build:gradle:4.2.2'
}

//这里是插件部署时需要用的group名称和版本号,自己随意设置
group='lollipop.plugin.timePlugin'
version='1.0.0'

uploadArchives {
    repositories {
        mavenDeployer {
            //插件部署的目录文件夹,这里是和当前项目所在文件夹,和项目平级,仓库名为:asm_repo. 注意这里是../../
            repository(url :uri('../../asm_repo'))
        }
    }
}
java {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}

第七步:
sync后,我们可以在gradle插件中找到对应的task,进行部署即可

部署插件.png

部署后我们可以在对应的文件夹中看到插件仓库 「asm_repo」文件夹

第八步:
插件的使用,首先我们需要在项目的build.gradle加入自定义的插件

plugins {
    id 'com.android.application'
    id 'kotlin-android'

    //这里为resources/META-INF/gradle-plugins目录下创建的文件名
    id 'Time-plugin'
}

其次我们在根目录的build.gradle中添加插件

buildscript {
    repositories {
        //这里需要注意,路径为../asm_repo ,而不是我们刚才部署时,用的../../asm_repo
        //因为根 gradle 和插件的 gradle 的相对层级就是少一级。如果路径不对的话,是会
        //提示异常:Could not resolve all artifacts for configuration ':ckasspath' .
        // Could not find lollipop.plugin.timePlugin:lollipopPlugin:1.0.0 .
        maven {url uri('../asm_repo')}
        google()
        mavenCentral()
    }
    dependencies {
        // 这里的路径为 group名:module名:version版本
        classpath "lollipop.plugin.timePlugin:lollipopPlugin:1.0.0"
    }
}

第八步:
执行./gradlew clean assembledebug命令,我们可以看到在控制台,打印出了以下内容,则说明我们的插件正常运行了

插件引用.png

第九步:
如果我们修改了自定义插件的逻辑,即TimePluginapply()方法中的逻辑,那么我们需要删除本地的插件仓库,重新执行下插件本地部署,这一步我们需要先把插件在build.gradle中相关的引用注释掉,因为我们已经把插件本地仓库删除了,如果不注释的话,会编译报错的

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

推荐阅读更多精彩内容