Gradle之自定义插件的三种形式(六)

自定义Gradle插件主要有三种形式,分别是build.gradle中编写、buildSrc工程项目中编写、独立项目或独立module中编写。

1. 在build.gradle中编写自定义插件

对象插件是实现了org.gradle.api.plugins接口的插件,这个接口中只定义个一个简单的apply方法,想要实现自定义插件就需要去实现org.gradle.api.plugins接口。
Groovy、Java、Kotlin都可以作为实现插件的语言,在本文的示例中,使用Groovy作为实现语言。
在实际工作中我们很少会在build.gradle中编写自定义插件,这里是为了带大家写个最简单的例子,可以最快最直接的了解什么是自定义插件。

1.1 这里使用AS来编辑,新建一个项目,在module中的build.gradle中键入以下内容:
// Apply the plugin
apply plugin: GreetingPlugin

class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.task('GreetingPluginTask') {
            doLast {
                println '自定义插件'
            }
        }
    }
}

在build.gradle中自定义了一个插件GreetingPlugin,在apply方法中创建一个名称为GreetingPluginTask的任务。在AS的Terminal中输入gradlew.bat GreetingPluginTask来执行GreetingPluginTask任务。

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradle>gradle  GreetingPluginTask

> Task :app:GreetingPluginTask 
自定义插件


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

1.2 自定义插件扩展

再举一个简单的插件拓展例子,通过插件拓展来配置GreetingPluginTask的输出字符串,如下所示。
build.gradle

apply plugin: GreetingPlugin
greeting.message="自定义插件拓展"//2
class GreetingPluginPluginExtension{
    String message="from GreetingPlugin"
}
class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        def extension=project.extensions.create("greeting",GreetingPluginPluginExtension)//1
        project.task('GreetingPluginTask') {
            doLast {
                println extension.message
            }
        }
    }
}

GreetingPluginPluginExtension类中定义了message变量,GreetingPluginPluginExtension是一个Groovy Bean(类似于JavaBean)。注释1处用于添加拓展插件GreetingPluginPluginExtension到插件列表中,名称为greeting。注释2处设置GreetingPluginPluginExtension的message值。
Terminal中输入gradlew.bat GreetingPluginTask来执行GreetingPluginTask任务。

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradle>gradle GreetingPluginTask

> Task :app:GreetingPluginTask 
自定义插件拓展


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

2. buildSrc工程项目

除了在build.gradle中编写的自定义插件,还可以将插件的源代码放在rootProjectDir/buildSrc/src/main/groovy目录中,Gradle会自动识别来完成编译和测试。Android Studio会找rootPrjectDir/buildSrc/src/main/groovy目录下的代码。

坑:当新建libraray module并命名为buildSrc后会提示Plugin with id'com.android.library' not found.

这是因为buildSrc是Android的保留名称,只能作为plugin插件使用,我们修改buildSrc的build.gradle文件后就不报错了。

具体流程如下:

2.1. 首先创建一个名为buildSrc的module,注意,名称必须为buildSrc
image
2.2. 然后将其它不需要的文件删除,新建需要的文件夹和文件,最后的目录结构如下图所示:
image
2.3. 新建对应的文件和文件夹之后,工程开始会不认这个buildSrc,我们修改build.gradle:
apply plugin: 'groovy'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

点击Sync Now,完了之后发现groovy文件夹变蓝色了

2.4. 在对应的包下面新建YolynPlugin.groovy,输入以下内容
import org.gradle.api.Plugin
import org.gradle.api.Project

class YolynPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.task('yolynplugin') {
            doLast {
                println("this is YolynPlugin")
            }
        }
        println("welcome to YolynPlugin")
    }
}
2.5. 再在com.yolyn.plugin.properties文件中添加以下内容(注意这里properties的名称就是我们之后要引用这个插件时apply plugin:''引号填入的内容)
implementation-class=YolynPlugin

这里的YolynPlugin就是我们创建的YolynPlugin.groovy文件,一定要对应上,否则会报找不到的错误。

2.6. 在app的gradle中去引用这个插件
apply plugin:  'com.yolyn.plugin'

com.yolyn.plugin是我们之前创建的properties的名称

重新build一下

2.7. 在terminal中可以键入命令
gradle yolynplugin   
或者gradlew yolynplugin  
或者gradlew.bat yolynplugin

输出内容:

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle yolynplugin

> Configure project :app 
welcome to YolynPlugin

> Task :app:yolynplugin 
this is YolynPlugin


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

疑问1
这里有一个疑问,为什么先打印出welcome to YolynPlugin,是因为doLast吗,怎么解释?
疑问2
我们再创建一个插件叫OtherPlugin.groovy

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

class OtherPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.task('otherplugin') {
            doLast {
                println("this is OtherPlugin")
            }
        }
        println("Welcome To OtherPlugin")
    }
}   

然后同样地在gradle-plugins中创建properties,在app下面的build.gradle引用

在Terminal中输入gradle otherplugin

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle otherplugin

> Configure project :app 
welcome to YolynPlugin
Welcome To OtherPlugin

> Task :app:otherplugin 
this is OtherPlugin


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

发现YolynPlugin中的apply方法也执行了

疑问3
我们把两个Plugin中的doLast去掉
我们再在Terminal中输入gradle otherplugin

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle otherplugin

> Configure project :app 
this is YolynPlugin
welcome to YolynPlugin
this is OtherPlugin
Welcome To OtherPlugin


BUILD SUCCESSFUL in 6s

发现全部都打印出来了,这是为什么?

  1. 对于疑问1:
    我们看一下官方对Projec的task方法的介绍
Creates a Task with the given name and adds it to this project. Calling this method is equivalent to calling task(java.util.Map, String) with an empty options map.

After the task is added to the project, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details

If a task with the given name already exists in this project, an exception is thrown.

throws:
    InvalidUserDataException If a task with the given name already exists in this project.

Parameters:
    name - The name of the task to be created

Returns:
    The newly created task object

大致意思是会创建一个给定名字的task放到这个project里面,调用这个方法相当于调用这个task

再看一下Task的doLast方法:

Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.

这样就能解释了,确实是因为doLast将任务添加到project的tasks的list的最后了,所以才最后执行。具体还可以查看官方文档的Project,文档在gradle安装目录的docs里面可以找到。

==疑问二和疑问三是为什么???求解==

日后继续研究
再看第三种形式

3. 独立项目或独立Module

无论是在build.gradle中编写自定义插件,还是buildSrc项目中编写自定义插件,都只能在自己的项目中进行使用。如果想要分享给其他人或者自己用,可以在一个独立的项目中编写插件,这个项目会生成一个包含插件类的JAR文件,有了JAR文件就很容易进行分享了。

3.1 创建一个名为YolynPlugin的module

跟上面创建buildSrc一样,将其它文件删除,并创建相应的文件和文件夹,最终目录结构如下:

image
3.2 修改build.gradle
apply plugin:'groovy'
apply plugin: 'maven'
dependencies {
    //gradle sdk
    compile gradleApi()
    //groovy sdk
    compile localGroovy()
}

Sync Now

3.3 在com.example.yolynplugin下创建ModuleYolynPlugin.groovy(为了和上面的YolynPlugin区分)
import org.gradle.api.Plugin
import org.gradle.api.Project

class ModuleYolynPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.task("moduleyolynplugin") {
            println("this is module yolynplugin")
        }
    }
}
3.4 在gradle-plugins文件夹下面创建com.example.yolynplugin.properties
implementation-class=ModuleYolynPlugin
3.5 将代码上传到仓库或者本地,这里是放到本地

在这个module的build.gradle追加下面内容

group='com.example.yolynplugin'
version='1.0.0'
//group和version在后面会用到
uploadArchives {
    repositories {
        mavenDeployer {
              //提交到远程服务器:
              // repository(url: "http://www.xxx.com/repos") {
              //    authentication(userName: "admin", password: "admin")
              // }
            repository(url:uri('../repo'))
        }
    }
}

上面各个参数的逻辑意义参考官方文档:
https://docs.gradle.org/current/dsl/index.html
这里直接将插件上传到了本项目的根目录,点击Build之后在Gradle窗口会看到uploadArchives

image

点击uploadArchives会在本地生成插件相关的文件,比如我的目录和文件如下图所示

image

图中的YolynPlugin-1.0.0.jar就是我们需要的插件jar包。

3.6 去app下面的module中引用

在build.gradle中追加下面内容

apply plugin: 'com.example.yolynplugin'//properties的名字
buildscript {
//repositories这个模块的内容告诉gradle去什么地址下载第三方的库。
    repositories{
        maven {
        url uri('../repo')
        }
    }
    dependencies{
                   //group:pluginName:version
        classpath 'com.example.yolynplugin:YolynPlugin:1.0.0'
    }
}

其中com.example.yolynplugin是group,YolynPlugin是自定义插件的名称,1.0.0是版本号

也可以这么写:

dependencies {
     classpath group: 'com.example.yolynplugin', name: 'YolynPlugin',
             version: '1.0.0'
 }

Sync Now

3.7 clean一下Project,然后make Project,在Terminal中输入:gradle moduleyolynplugin
D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle moduleyolynplugin

> Configure project :app 
welcome to YolynPlugin
Welcome To OtherPlugin
this is module yolynplugin


BUILD SUCCESSFUL in 8s

三个插件都成功运行

笔记来源于:
1.https://blog.csdn.net/huachao1001/article/details/51810328
2. http://liuwangshu.cn/application/gradle/6-custonplugin.html

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