Gradle学习系列之十——自定义Plugin（本系列完）

　　在本系列的上篇文章中，我们讲到了如何自定义Task类型，在本篇文章中，我们将讲到如何自定义Plugin。

　　请通过以下方式下载本系列文章的Github示例代码：

git clone https://github.com/davenkin/gradle-learning.git

　　在Plugin中，我们可以向Project中加入新的Task，定义configurations和property等。我们3种方法可以自定义Plugin，这些方法和自定义Task类型的3种方法相似。在接下来的例子中，我们将分别通过这3种方法来创建一个DateAndTimePlugin，该Plugin定义了2个Task，分别用于输出系统当前的日期和时间，另外，我们可以配置日期和时间的输出格式。

（一）在build.gradle文件中直接定义Plugin

　　和在build.gradle文件中定义Task类型一样，我们可以将对Plugin的定义直接写在build.gradle中：

apply plugin: DateAndTimePlugindateAndTime {timeFormat = 'HH:mm:ss.SSS'dateFormat = 'MM/dd/yyyy'
}class DateAndTimePlugin implements Plugin<Project> {void apply(Project project) {project.extensions.create("dateAndTime", DateAndTimePluginExtension)project.task('showTime') << {println "Current time is " + new Date().format(project.dateAndTime.timeFormat)}project.tasks.create('showDate') << {println "Current date is " + new Date().format(project.dateAndTime.dateFormat)}}
}class DateAndTimePluginExtension {String timeFormat = "MM/dd/yyyyHH:mm:ss.SSS"String dateFormat = "yyyy-MM-dd"
}

　　每一个自定义的Plugin都需要实现Plugin<T>接口，事实上，除了给Project编写Plugin之外，我们还可以为其他Gradle类编写Plugin。该接口定义了一个apply()方法，在该方法中，我们可以操作Project，比如向其中加入Task，定义额外的Property等。

　　在上例中，我们在DateAndTimePlugin中向Project添加了2个Task，一个名为showTime，一个名为showDate。请注意创建这2个Task所使用的不同方法，更多的创建Task的方法，请参考本系列这篇文章。

　　每个Gradle的Project都维护了一个ExtenionContainer，我们可以通过project.extentions进行访问，比如读取额外的Property和定义额外的Property等。在DateAndTimePlugin中，我们向Project中定义了一个名为dateAndTime的extension，并向其中加入了2个Property，分别为timeFormat和dateFormat，他们又分别用于showTime和showDate。在使用该Plugin时，我们可以通过以下方式对这两个Property进行重新配置：

dateAndTime {timeFormat = 'HH:mm:ss.SSS'dateFormat = 'MM/dd/yyyy'
}

（二）在当前工程中定义Plugin

　　在当前工程中的buildSrc/src/main/groovy/davenkin目录下创建DateAndTimePlugin.groovy文件，将build.gradle中定义DateAndTimePlugin的代码提取到给文件中，但是除去对DateAndTimePluginExtension的定义，因为我们将在另外一个单独的文件中定义DateAndTimePluginExtension。

package davenkinimport org.gradle.api.Plugin
import org.gradle.api.Projectclass DateAndTimePlugin implements Plugin<Project> {void apply(Project project) {project.extensions.create("dateAndTime", DateAndTimePluginExtension)project.task('showTime') << {println "Current time is " + new Date().format(project.dateAndTime.timeFormat)}project.tasks.create('showDate') << {println "Current date is " + new Date().format(project.dateAndTime.dateFormat)}}
}

　　再创建DateAndTimePluginExtension.groovy：

package davenkinclass DateAndTimePluginExtension {String timeFormat = "MM/dd/yyyyHH:mm:ss.SSS"String dateFormat = "yyyy-MM-dd"
}

　　这里，我们将2个类文件都放在了davenkin包下。Gradle在执行时，会自动扫描buildSrc目录，并会在执行Task之前构建该目录下的内容。在build.gradle文件中，在apply该Plugin时，我们需要声明对该Plugin的全名称，即包含报名：

apply plugin: davenkin.DateAndTimePlugindateAndTime {timeFormat = 'HH:mm:ss.SSS'dateFormat = 'MM/dd/yyyy'
}

　　执行“gradle showTime”，命令行输出如下：

:buildSrc:compileJava UP-TO-DATE
:buildSrc:compileGroovy UP-TO-DATE
:buildSrc:processResources UP-TO-DATE
:buildSrc:classes UP-TO-DATE
:buildSrc:jar UP-TO-DATE
:buildSrc:assemble UP-TO-DATE
:buildSrc:compileTestJava UP-TO-DATE
:buildSrc:compileTestGroovy UP-TO-DATE
:buildSrc:processTestResources UP-TO-DATE
:buildSrc:testClasses UP-TO-DATE
:buildSrc:test UP-TO-DATE
:buildSrc:check UP-TO-DATE
:buildSrc:build UP-TO-DATE
:showTime
Current time is 19:08:35.489BUILD SUCCESSFULTotal time: 2.995 secs

　　可以看到，Gradle会首先构建buildSrc目录，然后才执行showTime（红色部分）。

（三）在单独的项目中创建Plugin

　　新建一个项目，将（二）中buildSrc目录下的内容拷贝到该项目下，定义该项目的build.gradle文件如下：

apply plugin: 'groovy'
apply plugin: 'maven'version = 1.0
group = 'davenkin'
archivesBaseName = 'datetimeplugin'
repositories.mavenCentral()dependencies {compile gradleApi()groovy localGroovy()
}uploadArchives {repositories.mavenDeployer {repository(url: 'file:../lib')}
}

　　此外，我们还可以为该Plugin重新命名，如果我们希望将该Plugin命名为time，那么我们需要在src/main/resources/META-INF/gradle-plugins目录下创建名为time.properties的文件，内容如下：

implementation-class = davenkin.DateAndTimePlugin

　　在执行“gradle uploadArchives”时，Gradle会将该Plugin打包成jar文件，然后将其上传到上级目录下的lib目录中（../lib）。之后，在客户端的build.gradle文件中，我们需要做如下定义：

buildscript {repositories {maven {url 'file:../lib'} }dependencies {classpath group: 'davenkin', name: 'datetimeplugin',version: '1.0'}
}
apply plugin: 'time'dateAndTime {timeFormat = 'HH:mm:ss.SSS'dateFormat = 'MM/dd/yyyy'
}

　　首先我们配置repository以执行lib目录，然后声明对DateAndTimePlugin的依赖，再apply该Plugin，此时我们应该使用“time”作为该Plugin的名称，最后对该Plugin进行配置。

（本系列完）

Gradle学习系列之十——自定义Plugin（本系列完）相关推荐

各种音视频编解码学习详解之编解码学习笔记（十）：Ogg系列
最近在研究音视频编解码这一块儿,看到@bitbit大神写的[各种音视频编解码学习详解]这篇文章,非常感谢,佩服的五体投地.奈何大神这边文章太长,在这里我把它分解成很多小的篇幅,方便阅读.大神博客传送门 ...
编解码器的学习笔记（十）：Ogg系列
Ogg是一个自由和开放的标准容器格式,由Xiph.Org 维修基金. Ogg格式不受软件专利的限制,它的目的是有效地处理高品质的流媒体和数字媒体. Ogg意指一种文件格式,能够纳入各式各样自由和开放源 ...
深度学习（四十）优化求解系列（2）简单理解神经网络求解过程-未完待续
对于神经网络的求解过程BP,其实说白了就是复合函数的求导过程,所以我们需要先复习一下高数复合函数的求导过程. 一.复合函数的求导法则 1.复合函数: 此函数是一个包含了三层映射过程的复合函数,为了跟后 ...
【深度学习之美】卷地风来忽吹散，积得飘零美如画（入门系列之十）
系列文章: 一入侯门"深"似海,深度学习深几许(深度学习入门系列之一) 人工"碳"索意犹尽,智能"硅"来未可知(深度学习入门系列之二) 神经 ...
VSTO 学习笔记（十二）自定义公式与Ribbon
原文:VSTO 学习笔记(十二)自定义公式与Ribbon 这几天工作中在开发一个Excel插件,包含自定义公式,根据条件从数据库中查询结果.这次我们来做一个简单的测试,达到类似的目的. 即在Excel ...
Gradle学习(二十)——多项目构建详解
跨项目配置虽然子项目之间可以完全隔离单独配置,但是子项目直接有相同特征的情况也是很常见的,多个项目共享配置是更好的选择. 配置和执行在gradle学习-十八-构建的生命周期这一篇中我们已经讲过Gr ...
LSTM长短记，长序依赖可追忆（深度学习入门系列之十四）
摘要:如果你是一名单身狗,不要伤心,或许是因为你的记忆太好了.有时,遗忘是件好事,它让你对琐碎之事不再斤斤计较.然而每当自己记不住单词而"问候亲人"时,也确实气死个人.于是你懂得了 ...
shiro学习系列：shiro自定义filter过滤器
shiro学习系列:shiro自定义filter过滤器自定义JwtFilter的hierarchy(层次体系) 上代码 package com.finn.springboot.common.conf ...
Gradle 自定义Plugin插件之360加固
之前发布的文章:Gradle 自定义Plugin插件之上传APK到蒲公英.让我们知道了自定义插件的一些功能. 一般来说,在发布的时候,我们的APK都需要加固的,毕竟安全点.这里,我们就结合之前的插件, ...

Gradle学习系列之十——自定义Plugin（本系列完）

Gradle学习系列之十——自定义Plugin（本系列完）相关推荐

最新文章

热门文章