Gradle 插件 -- 插件的应用

----《Android Gradle 权威指南》学习笔记

总目录:Gradle 学习系列 -- 目录

上一篇:Gradle 任务 -- 任务规则

下一篇:Gradle 插件 -- 自定义插件

1 插件的作用

1.1 插件会扩展项目的功能,帮助我们在项目的构建中做很多事情:
(1) 可以在项目中添加任务,比如测试、编译、打包。
(2) 可以在项目中添加依赖配置,实现项目在构建过程中的依赖。比如依赖的第三方库。
(3) 可以向项目中现有的对象类型添加新的扩展属性、方法等。可以使用它们帮助我们配置、优化构建。比如 AndroidStudio 中 android{} 这个配置块就是 Android Gradle 插件为 Project 对象添加的一个扩展。
(4) 可以对项目进行一些约定,比如应用 Java 插件之后, 约定 src/main/java 目录下是源代码的位置,在编译的时候也是编译这个目录下的 Java 源码文件。

1.2 对于插件,只需要按照它约定的方式,使用它提供的任务、方法或者扩展,就可以对项目进行构建。

2 应用一个插件

在使用一个插件之前需要先应用它,把它应用到项目中,这样就可以使用它了。
插件的应用都是通过 Project.apply() 方法完成的,apply() 方法有好几种用法,并且插件也分为二进制插件和脚本插件。

2.1 应用二进制插件

2.1.1 二进制插件就是实现了 org.gradle.api.Plugin 接口的插件,它们可以有 plugin.id。

2.1.2 举个例子:

apply plugin:'java'

上面的语句把 Java 插件应用到了项目中,其中 'java' 是 Java 插件的 plugin id,它是唯一的。对于 Gradle 自带的核心插件都有一个容易记忆的名称,称为 plugin id,比如上面的 java。其实它对应的类型是 org.gradle.api.plugins.JavaPlugin。所以也可以写成:

apply plugin: org.gradle.api.plugins.JavaPlugin

又因为包 org.gradle.api.plugins 是默认导入的,所以可以去掉包名直接写为:

apply plugin:JavaPlugin

上面的3中写法是等价的,因为第一种容易记忆,所以用的比较多。第二种写法一般适用于在 build 文件中自定义的插件,也就是脚本插件。

2.1.3 二进制插件一般都是被打包成 jar 文件独立发布的,比如自定义的插件,在发布的时候可以为其指定 plugin id。 这个 plugin id 最好是一个全限定名称,就像包名一样,这样发布的插件 plugin id 就不会重发。

2.2 应用脚本插件

2.2.1 比如在项目根目录下有以下两个 gradle 文件:
build.gradle:

apply from:'version.gradle'

task testVersion{
    doLast{
        println "APP 版本是: ${versionName}, 版本号是:${versionCode}"
    }
}

version.gradle:

ext{
    versionName = "APP1.0.1"
    versionCode = 1.0
}

在命令行中执行命令:gradle testVersion
打印结果:

> Task :testVersion
APP 版本是: APP1.0.1, 版本号是:1.0

2.2.2 其实上面的 version.gradle 算不上一个插件,它只是一个脚本。应用插件脚本,就是把这个脚本加载进来。和二进制插件不同的是它使用的是 from 关键字,后面紧跟一个脚本文件。这个脚本文件可以是本地的,也可以是网络的,如果是网络上的则要使用 HTT PURL。

2.2.3 虽然它不是一个真正的插件,但是也有很大的作用。它是脚本文件模块化的基础,可以把内容很多的脚本文件进行分块、分段整理,拆分成一个个共用、职责分明的文件,然后通过 apply from 来使用它们。比如可以把常用的函数放在一个 util.gradle 文件中。

2.3 apply() -- 闭包的方式

2.3.1 Project.apply() 方法有3中用法,它们接受不同的参数:

// apply 方法
void apply(Map<String, ?> options);
void apply(Closure closure);
void apply(Action<? super ObjectConfigurationAction> action);

闭包的方式如下:

apply{
    plugin 'java'
}

该闭包被用来配置一个 ObjectConfigurationAction 对象,所以可以在闭包里面使用 ObjectConfigurationAction 对象的方法、属性等进行配置。

2.3.2 举个栗子:

apply(new Action<ObjectConfigurationAction>() {
    @Override
    void execute(ObjectConfigurationAction objectConfigurationAction) {
        objectConfigurationAction.plugin('java')
    }
})

2.4 应用第三方发布的插件

2.4.1 第三方发布的一般都是 jar 包的二进制插件,在应用的时候,必须先在 buildscript{} 里配置其 classpath 才能使用,不像 Gradle 内置的插件。比如在 AndroidStudio 中:
buildscript

2.4.2 buildscript{} 块是一个在构建项目之前,为项目进行前期准备和初始化相关配置依赖的代码块。配置好需要的依赖,就可以在项目中应用插件了:

plugins {
    id 'com.android.application'
}

如果没有提前在 buildscript{} 里配置依赖的 classpath,会提示找不到这个插件。

2.4.3 根据上面的内容:
(1) 如果在 AndroidStudio 的根目录的 build.gradle 文件中的 buildscript{} 块中注释掉
classpath "com.android.tools.build:gradle:7.0.4" 这一行,则构建时,则在 app 目录下的 build.gradle 文件中 id 'com.android.application' 这一行会报错

(2) 如果在 app 目录下的 build.gradle 文件中注释掉 id 'com.android.application' 这一行,则代码块 android{}会报错

2.5 通过 plugin DSL 应用插件

plugin DSL 是一种比较新的插件应用方式,具体的格式为:

plugins {
    id 'java'
}

这样就应用了 java 插件,看着更简洁一些,更符合 DSL 规范。现在 IDE 中都是这种方式了。

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

推荐阅读更多精彩内容

  • Gradle 本身只提供基本框架和核心概念,几乎所有的功能都是以插件的方式提供的。 例如构建 Java 应用的功能...
    佛系编码阅读 385评论 0 0
  • 说起Gradle的插件,不得不感叹Gradle的设计。Gradle的设计非常好,它本身提供一些基本的概念和整体核心...
    acc8226阅读 837评论 0 2
  • 探讨Gradle插件的自定义有助更好的理解Gradle,本文综合了userguide中的几篇相关文档,将不单独给出...
    cntlb阅读 2,494评论 0 7
  • 个人博客:http://www.milovetingting.cn Gradle插件 插件的作用 把插件应用到项目...
    milovetingting阅读 857评论 0 1
  • 点赞关注,不再迷路,你的支持对我意义重大!🔥 Hi,我是丑丑。本文 「Android 路线」| 导读 —— 从零到...
    彭旭锐阅读 1,820评论 1 8