gradle插件基础

gradle插件分为两种,一种是脚本插件,一种是对象插件

脚本插件:脚本插件就是一个普通的xxx.gradle文件,通过在xxx.gradle定义一系列task,在另一个gradle文件中通过
apply from:'xxx.gradle'引用即可使用xxx.gradle定义的task。

主工程根目录创建xxx.gradle文件(xxx代表任意)

xxx.gradle文件
task testPlugin{
    doLast{
        println("xxx.gradle doLast")
    }
}

module工程引用,本次是app主工程的build.gradle引用:

apply from:"../xxx.gradle"

主要xxx.gradle与app工程同级因此需要../

引用完成后就可以输入编译命令:

gradle testPlugin

输出:

> Task :app:testPlugin
xxx.gradle doLast

对象插件
对象插件是指实现了org.gradle.api.Plugin接口的类。类需要实现void apply(T target)方法,T为泛型代表插件
作用到的对象。通常为Project对象。

编写对象插件有三种方式:

1.直接在gradle脚本文件中
2.在工程的buildSrc工程下面
3.独立工程

相比而言,1和2两种方式都是不对外暴露的,只能在当前工程或者module之间使用,如果要让其他项目使用还是需要使用
第三种方式。
下面我们一一来实现一下:

在gradle脚本中实现

此方法最简单,直接打开app.gradle写入,下面代码增加动态配置的代码
1.实现Plugin接口,重写apply方法

插件拓展
class CustomExtension{
    def message = "extension message"
    def what = 0
}

class CustomPlugin implements Plugin<Project> {

    @Override
    void apply(Project target) {
        //插件扩展参数为名称 类型 和参数(可无)
        def extension = target.extensions.create("cusExtension",CustomExtension)
        target.task("pluginTask"){
            doLast{
                println("task name is ${name}  message is ${extension.message}  what is ${extension.what}")
            }
        }
    }
}

配置扩展

cusExtension.message = "extension change   message"

通过DSL块配置扩展

cusExtension{
    message = "extension DSL change   message"
    what = 2
}

2.依赖插件

apply plugin : CustomPlugin

执行命令:

gradlew pluginTask

输出结果:

> Task :pluginTask
task name is pluginTask  message is extension DSL change   message  what is 2
buildSrc目录下

工程目录下新建buildSrc moudle,因为buildSrc不是一个Android moudle工程,因此需要我们做一些处理。

1.删除工程目录下main文件夹中的资源
2.在main文件夹下新建groovy文件夹(buildSrc/src/main/groovy)并创建包名文件夹,在包名文件夹下创建 CustomAlonePlugin.groovy文件(CustomAlonePlugin是文件名),我们的插件代码在写在其中。

注意:一定要写.groovy后缀,不然工具识别不出

package com.myplugin

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

public class CustomAlonePlugin implements Plugin<Project> {

    @Override
    void apply(Project target) {
        //插件扩展参数为名称 类型 和参数(可无)
        def extension = target.extensions.create("cusExtension",CustomExtension)
        target.task("pluginTask"){
            doLast{
                println("task name is ${name}  message is ${extension.message}  what is ${extension.what}")
            }
        }
    }
}

class CustomExtension{
    def message = "extension message"
    def what = 0
}

其中CustomExtension是配置项,供依赖项动态配置修改,配置方法和上面配置一样

3.main文件夹下面创建resources文件夹,在此文件夹下创建META-INF/gradle-plugins文件夹路径,在此文件夹中创建myCustomPlugin.properties文件(buildSrc/src/main/resources/META-INF/gradle-plugins/myCustomPlugin.properties)。

注意myCustomPlugin就是插件的id(可修改),供其他module依赖。

4.myCustomPlugin.properties文件夹下配置代码:
implementation-class = com.myplugin.CustomAlonePlugin//对应插件的类
5.build.gradle下添加依赖
apply plugin: 'groovy'
dependencies {
    implementation gradleApi()
    implementation localGroovy()
}
6.依赖插件

写完上面的代码后,module就可以依赖了

apply plugin : 'myCustomPlugin'
//配置扩展
cusExtension.message = "extension change   message"

//通过DSL块配置扩展
cusExtension{
    message = "extension DSL change   message"
    what = 2
}

执行:

gradlew pluginTask

结果:

> Task :pluginTask
task name is pluginTask  message is extension DSL change   message  what is 2
独立工程

buildSrc中创建插件只能在单一工程下多模块复用,要想在多个项目中复用就需要使用独立工程编写插件
,然后将插件上传到maven仓库中,最后在需要以来的项目中显式的添加对插件的依赖

为了节省时间我们直接在本工程中创建一个standalone插件模块,但是我们要注意的是这是一个完全独立模块。
可以看到独立工程的模块和buildSrc模块结构是一样的。区别在于buildSrc代码在构建是自动会被编译并被引用。
而独立模块的则需要编译之后上传到maven仓库中,然后在需要引用的项目中显式的引用。

插件代码和之前一样只是改了名称

package com.myplugin

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

public class StandAlonePlugin implements Plugin<Project> {

    @Override
    void apply(Project target) {
        //插件扩展参数为名称 类型 和参数(可无)
        def extension = target.extensions.create("cusExtension",StandExtension)
        target.task("pluginTask"){
            doLast{
                println("task name is ${name}  message is ${extension.message}  what is ${extension.what}")
            }
        }
    }
}


class StandExtension{
    def message = "extension message"
    def what = 0
}

build.gradle则有的不同,因为需要发布到maven,所以增加了发布的代码:
引用依赖apply plugin: 'maven',通过maven插件快速的配置group version和uploadArchives相关属性。
为了方便本次上传到主工程repo文件夹下面

apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
    implementation gradleApi()
    implementation localGroovy()
}
group 'com.myplugin.plugin'
version '1.0.0'
uploadArchives{
    repositories {
        mavenDeployer {
            repository(url:uri('../repo'))
        }
    }
}

然后执行命令gradlew uploadArchives或者在AS右侧边栏对应工程的tasks中找到uploadArchives
点击执行。执行完毕后就可以在主工程找到repo目录。里面存放的是生成好的jar包与一些文件。maven-metadata.xml存放的是配置信息

<metadata>
  <groupId>com.myplugin.plugin</groupId>
  <artifactId>standalone</artifactId>
  <versioning>
    <release>1.0.0</release>
    <versions>
      <version>1.0.0</version>
    </versions>
    <lastUpdated>20191225120458</lastUpdated>
  </versioning>
</metadata>

然后我们就可以在主工程build.gradle依赖插件。依赖规则

classpath 'groupId:artifactId:version'

同时在repositories中添加依赖路径

maven {
 url uri('repo')
}
buildscript下配置代码如下:
buildscript {
    repositories {
        //maven仓库路径
        maven {
            url uri('repo')
        }
        google()
        jcenter()

    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.1'
        //依赖
        classpath 'com.myplugin.plugin:standalone:1.0.0'

    }
}

依赖完成后我们可以在对应的子工程的build.gradle中进行依赖插件

apply plugin :'standAlonePlugin'
cusExtension.message = "extension change    message"

//通过DSL块配置扩展
cusExtension{
    message = "extension DSL change   message"
    what = 2
}

执行命令:

gradlew pluginTask

输出日志:

StandAlonePlugin task name is pluginTask  message is extension DSL change   message  what is 2

说明引用成功。

总结:

1.插件分为脚本插件和对象插件
2.脚本插件直接在.gradle文件中编写,通过apply from '文件名.gradle'引用
3.对象插件需要继承Plugin类,实现apply方法。可以在当前build.gradle中编写也可以在buildSrc模块中
编写还可以在独立工程中编写。当前模块下编写的可以通过apply plugin :'ClassName'依赖。buildSrc和独立模块通过pluginId依赖apply plugin:'pluginId'

本文写的插件只是一些简单的插件,目的是简单了解一下gradle的流程。
本文参考:玉刚说文章
官方自定义插件文章

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

推荐阅读更多精彩内容

  • 背景 做为一个Android的开发者,我相信现在几乎所有的Android开发都是利用Android Studio作...
    Only凹凸曼阅读 4,034评论 1 10
  • Gradle 定义 Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化建构工具。...
    Code猎人阅读 5,213评论 0 14
  • Gradle插件让我们把可以复用的构建逻辑打包起来,这样就可以用到其他项目当中。我们可以在Gradle中引用自己的...
    HoooChan阅读 1,893评论 1 2
  • 五一假期,心血来潮要做凉皮,和好面醒发后,就到了洗面环节,壮壮自告奋勇要来做,还像模像样的系上了围裙,告诉他方法后...
    栖居在神恩典的臂弯阅读 227评论 0 0
  • 今天学习的怎么和顾客聊天,鑫鑫店长给大家整理了一个很清晰的思路。感觉都是自己想多了,但是不想那么多怎么和顾客聊,是...
    加加_go阅读 89评论 0 0