----《Android 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 中: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 中都是这种方式了。