Android之Gradle<第五篇>:Gradle插件
[插件的作用]
1.可以添加任务到你的项目中,帮你完成一些事情,比如测试、编译、打包
2.可以添加依赖配置到你的项目中,我们可以通过他们配置我们项目在构建过程中需要的依赖,比如我们编译的时候依赖的第三方库等
3.可以向项目中现有的对象类型添加新的扩展属性、方法等,让你可以使用它们帮助我们配置、优化构建,比如android{}这个配置块就是Android Gradle插件为Project对象添加的一个扩展
4.可以对项目进行一些约定,比如应用java插件之后 ,约定src/main/java目录下是我们的源代码存放位置,在编译的时候也是编译这个目录下的Java源代码文件。
[Android自带插件]
每个Project下都有这样一个文件build.gradle
,在这个文件中有个默认的插件:
apply plugin: 'com.android.application'
以及
apply plugin: 'com.android.library'
单引号中是Plugin ID,插件的ID都是唯一的。
插件的应用都是通过Project.apply()方法完成的,这个方法不仅可以应用插件,还可以应用某个脚本。
[应用脚本]
如图所示,某脚本的文件名是:version.gradle,显然,这个文件名不是默认文件,那么怎么才能应用这个脚本呢?
通过Project.apply()方法可以应用任意脚本,代码如下:
apply from:'version.gradle'
紧接着,打印脚本中的属性
task taskA{
doLast {
println "versionName: ${versionName}"
println "versionCode: ${versionCode}"
}
}
[在哪里配置第三方插件的依赖]
在主Project的找到文件build.gradle,这个文件中有这样一段代码:
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath "com.android.tools.build:gradle:4.0.0"
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
通过classpath
关键字配置插件的依赖,如果这个B插件来自A()仓库,那么还需要在repositories
中配置仓库,如下:
buildscript {
repositories {
google()
jcenter()
A()
}
dependencies {
classpath "com.android.tools.build:gradle:4.0.0"
classpath "B"
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
插件的依赖配置好之后,就可以在子Project中应用插件了:
apply plugin: '这里放置插件的ID'
[另一种方式应用插件]
一般应用插件我们这样做:
apply plugin: 'com.android.application'
但是有一种不常见的应用方式也需要了解以下:
plugins{
id('com.android.application')
}
或者
plugins{
id 'com.android.application'
}
[自定义插件]
有时可以根据自己的实际业务自定义一些插件,来辅助项目的构建。自定义插件涉及到的知识点特别多,比如创建任务、创建方法、进行约定等。对于自定义插件,本章只做简单介绍。
在build.gradle
中创建一个简单的插件,代码如下:
apply plugin: MyCustomPlugin
class MyCustomPlugin implements Plugin<Project>{
@Override
void apply(Project project) {
project.task('custom_task', {
println("我是一个自定义插件!")
})
}
}
被创建的插件名称是:MyCustomPlugin
,这个插件主要是实现新建一个名字叫custom_task
的Task。
通过已下命令执行该task
gradlew custom_task(linux下gradlew前面要加./)
执行结果如下:
图片.png自定义插件必须要实现Plugin
接口,这个接口的源码如下:
package org.gradle.api;
public interface Plugin<T> {
void apply(T var1);
}
Plugin
接口只有一个apply
方法,所以我们可以将自己想做的事情全部放在这个方法中实现,比如在apply
方法中创建一个名称为custom_task
的Task。
[本章完...]