Gradle插件系列（一） —— 配置自己的Gradle插件
1 最快速度做一个Gradle插件
整体来说，分4步
- 定义
plugin - 定义扩展
- 将扩展引入插件中
-
apply引用插件
1.1 定义 plugin
注意：以下内容可定义在任意模块的build.gradle中。
// groovy 写法
class FreeCoderPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
}
}
1.2 定义扩展
至于扩展是什么，文章后续将讲到。
// groovy 写法
class FreeCoderExtension {
def name = "perry"
}
1.3 将扩展引入插件中
// groovy 写法
class FreeCoderPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
// 1
def extension = project.extensions.create('freecoder', FreeCoderExtension)
// 2
project.afterEvaluate {
println("hello $extension.name")
}
}
}
标记1处，有几点需要说明：
-
project表示当前插件被哪个项目所引用，那么就表示哪个项目，比如我在app模块的gradle中引用了这个插件，那么打印的值为“:app”。 -
freecoder命名是随意的，它是扩展属性，可为插件中扩展类中的属性赋值。
标记2处：
project.afterEvaluate表示把内部的打印方法添加至执行阶段的队列中去，等整个build.gradle文件定义阶段结束后，待到执行阶段进行输出打印。
freecoder {
name 'zp'
}
这个freecoder就是FreeCoderExtension的别名。
1.4 apply 引用
apply plugin: FreeCoderPlugin
FreeCoderPlugin 就是在插件定义处，定义的插件类名。接着在项目的terminal中执行./gradlew（mac电脑中）。
xxx@xxxdeMacBook-Pro MVVMDemo % ./gradlew
> Configure project :app
hello zp
> Task :help
Welcome to Gradle 6.5.
上述都是在一个build.gradle文件中去简单的定义和使用，但实际上，gradle为我们专门提供了一个用于做插件的项目buildSrc，通过这个项目可以配置各种自定义的插件，然后供项目中使用。
2 配置buildSrc
buildSrc是一个特殊的文件项目，是专门给gradle做插件项目用的，在AndroidStudio中通过创建一个名为buildSrc的Java或者Android Library的module，然后去除掉setting.gradle中对该项目的配置，就可以正常运行。
include ':app'
include ':buildSrc' // 去掉这一行
2.1 关于buildSrc
由于它是一个插件项目，所以执行顺序会优先于任何子模块，在setting.gradle后执行。整个项目的结构如下图：
screenshot-20210808-183223.png
2.2 注意点
关于插件的编写，可以使用java、kotlin、groovy，看个人习惯，我这里以java为例。这里唯一需要注意的点就是resources文件夹下面的内容，目录结构如下（一个字母都不能错）：
resources/META-INF/gradle-plugins
最后以xxx.properties作为配置文件，把相应的plugin暴露出去，这里指FreeCoderPlugin这个插件，如下：
implementation-class=com.plugin.FreeCoderPlugin
其中com.plugin.FreeCoderPlugin为插件所在的位置的全类名引用方式。文件名xxx.properties中的xxx，为插件暴露出去的ID名，作为在build.gradle文件中的引用方式。
plugins {
id 'com.free.coder'
}
freecoder {
name "zp"
}
把其他两个java文件的完整代码贴上
public class FreeCoderExtension {
public String name = "perry";
public void setName(String name) {
this.name = name;
}
}
注意点：这里用Java编写的时候，对类变量需要增加set方法，否则会提示找不到某个方法，其实，上述代码的另一种写法就是freecoder ({ name "zp"})，setName是其真正调用的方法。
> No signature of method: build_2mmvzdfbi2zeqhulydy698wh5.freecoder()
is applicable for argument types: (build_2mmvzdfbi2zeqhulydy698wh5$_run_closure1)
values: [build_2mmvzdfbi2zeqhulydy698wh5$_run_closure1@1d1c1aa6]
public class FreeCoderPlugin implements Plugin<Project> {
@Override
public void apply(Project project) {
final FreeCoderExtension extension = project.getExtensions()
.create("freecoder", FreeCoderExtension.class);
project.afterEvaluate(innerProject -> System.out.println("extension: " + extension.name));
}
}
这样，当再次在项目的terminal中执行./gradlew时，将打印出extension: zp。到此，一个完整的自定义gradle插件就算是完成了。
上面还有一个问题：就是什么是扩展，其实到这里，我们暂时就可以这样理解，这个扩展就是为了定义一个数据实体以及设置数据属性的入口，至于在哪里会用到，就得看具体这个插件的作用是什么了。
