Gradle自定义插件实现自定义Task

最近在研究自定义插件,写个最简单的Demo玩玩,如何简单的实现自定义Plugin,当然这里指的是自定义的。
首先肯定是要参考官网的文档
https://guides.gradle.org/writing-gradle-plugins/
官方文档的内容挺多了,最近还是没有太大时间详细去看,所以这里只拿这一段来操作,自定义plugin

1. 创建自定义Plugin的Module 并 配置gradle

新建一个module并且命名为buildsrc,可以看官网文档的事例


在module的gradle中添加

repositories {
    mavenCentral()
}

为了能够写自定义任务,我们需要添加依赖,可以参考官方文档


dependencies {
    compile gradleApi()
    compile localGroovy()
}

这样就算是配置好了

2. 自定义任务

在java中创建一个类来自定义任务,该类需要继承DefaultTask

public class MyTest extends DefaultTask {

    public String str;

    @TaskAction
    public void say(){
        System.out.print(str);
    }

}

用@TaskAction注释来标明执行任务时所执行的方法

3. 自定义Plugin

在main文件夹下创建groovy目录(该目录下可以写groovy代码,也可以写java代码)



创建自定义Plugin,我这命名为TestPlugin

public class TestPlugin implements Plugin<Project> {
    @Override
    public void apply(Project project) {
        project.getTasks().create("hello", MyTest.class, new Action<MyTest>() {
            @Override
            public void execute(MyTest myTest) {
                myTest.str = "aaaaaaaaaaaaaaaa";
                myTest.say();
                myTest.str = "hello";
            }
        });
    }
}

在此创建了一个名为hello的任务,然后映射到我们自定义的任务的类MyTest。

4. 引用插件

我这里因为没有其它模块,所以直接在根目录中引用插件
在原本的gradle文件中加入apply plugin: com.test.plugin.TestPlugin

apply plugin: com.test.plugin.TestPlugin

buildscript {
    
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.2.1'
        

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        google()
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

5.运行结果

我们直接在命令行中运行hello命令查看结果,输入gradlew hello(gradlew是我这台机的,有些是gradle)


可以看到上面我们写的execute回调会在Configure project阶段运行的,而str = "hello"也是在这个阶段设置的,那么我们像其它插件一样写个闭包,看看效果,在gradle中加入

hello{
    str = "what"
}

加入闭包设置str 为 what,看看打印的结果



看到最后的结果会是在闭包中设置的内容

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

推荐阅读更多精彩内容