Gradle —— 自定义 Plugin(1)

自定义 Plugin 可以向任意一个 Gradle 类进行操作。比如向 Project 添加 TaskConfigurationProperty 等。
Task 一样,我们会用 3 种方式来创建自定义 Plugin

在 build.gradle 中直接定义 Plugin

apply plugin: DateAndTimePlugin

// 运行时配置的 extension
dateAndTime {
    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') {
            doLast{
                println "Current time is " + new Date().format(project.dateAndTime.timeFormat)
            }
        }
        project.task('showDate') {
            doLast {
                println "Current date is " + new Date().format(project.dateAndTime.dateFormat)
            }
        }
    }
}

// 插件默认的 extension
class DateAndTimePluginExtension {
    String timeFormat = "MM/dd/yyyyHH:mm:ss.SSS"
    String dateFormat = "yyyy-MM-dd"
}

执行命令 gradle :showTimegradle :showDate 可以分别显示当前时间和日期。

  • 我们自定义 Plugin 就需要实现 Plugin<T> 接口。该接口接收一个 Gradle 类,而且它只有一个 apply(T t) 方法。因此一个 Plugin 实际上是一个 hook 方法,它在 Gradle 的打包流程中 hook Gradle 的某些类。

比如我们上面的例子,就是向 Project 添加了 2 个 Task,一个名为 showTime,一个名为 showDate

  • Project#apply() 会在 Configure 阶段被执行。

  • 每个 GradleProject 都维护了一个 ExtensionContainer,我们可以向其中添加自定义扩展,并附上默认值。

比如上面例子,我们就给 Project 添加了一个名为 dateAndTimeextension,它的默认值是 DateAndTimePluginExtension 的实例,它已经有了两个默认扩展值,分别是 timeFormatdateFormat。例子中 create 方法使用的是create(String name, Class<T> type, Object... constructionArguments)

  • 在使用时,我们可以通过 project.extensions 来访问已定义的扩展,并对其中的配置重新赋值。

比如上例中,我们通过

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

在运行时对名为 dateAndTime 的扩展配置进行了重新赋值。之所以没有显式调用 extensions,这是因为 Gradle 中大量应用了代理模式。这里 Project 将参数 dateAndTime 代理给了 ExtensionContainer,因此最后操作的是 ExtensionContainer 中已有的 dateAndTime 扩展。

在当前工程中定义 Plugin

创建如下的工程目录

gradle 工程

Gradle 会默认去寻找 /buildSrc/src/main/groovy 下的所有文件,如果发现有 Plugin 则会将该 Plugin 添加到 PluginContainer 中。类 DateAndTimePluginDateAndTimePluginExtension 分别来自上节中的 pluginextension 代码,只不过多了一个包名 learning。在使用该 Pluginbuild.gralde 文件中,在 applyPlugin 时,我们需要声明对该 Plugin 的全限定名:apply plugin: learning.DateAndTimePlugin。之后我们就可以配置自定义扩展 dateAndTime了。

apply plugin: learning.DateAndTimePlugin

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

运行 gradle :showTime 可得结果。


关于 Extension 的写法

我们上面写的 Extension 就是一个 Java Bean 类,但是其实 Extension 还有另外的写法。

public class BinaryRepositoryExtension {
    private final Property<String> serverUrl;

    public BinaryRepositoryExtension(Project project) {
        serverUrl = project.getObjects().property(String.class);
    }

    public Property<String> getServerUrl() {
        return serverUrl;
    }
}

上面的 BinaryRepositoryExtension 使用了 Property 来保存 serverUrl。从构造函数中传入 project,这样就形成了 ExtensionProject 之间的桥梁。
同时,Plugin 中构造 Extension 的方法也需要改变:

BinaryRepositoryExtension extension = target.getExtensions().create("binaryRepo", BinaryRepositoryExtension.class, target);

target.getTasks().register("latestArtifactVersion", LatestArtifactVersion.class, new Action<LatestArtifactVersion>() {
            @Override
            public void execute(LatestArtifactVersion latestArtifactVersion) {
                latestArtifactVersion.getServerUrl().set(extension.getServerUrl());
            }
        });

这里使用的是接受 Project 参数的 create 方法。

Property 是什么?

Extension 之前的写法中,就是一个纯粹的 Java Bean,我们在使用时本质上也是直接给 Extension 中的变量进行赋值。
例如

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

就是直接对 timeFormat 进行赋值。这里 timeFormatString 类型。
而我们使用改进写法的 BinaryRepositoryExtension 中,它的 serverUrl 不再是单纯的 String 类型,而是由 Property 进行包装后的类型。
那么这里的 Property 是什么呢?这是 Gradle 提供的延迟加载机制,是 Gradle 4.0 之后提供的。这主要是为了保证 Property 中的值在使用时才被计算,而不像以前一样声明时就被计算好了。

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

推荐阅读更多精彩内容