最近在研究自定义插件,写个最简单的Demo玩玩,如何简单的实现自定义Plugin,当然这里指的是自定义的。
首先肯定是要参考官网的文档
https://guides.gradle.org/writing-gradle-plugins/
官方文档的内容挺多了,最近还是没有太大时间详细去看,所以这里只拿这一段来操作,自定义plugin
1. 创建自定义Plugin的Module 并 配置gradle
新建一个module并且命名为buildsrc,可以看官网文档的事例
在module的gradle中添加
repositories {
mavenCentral()
}
为了能够写自定义任务,我们需要添加依赖,可以参考官方文档
dependencies {
compile gradleApi()
compile localGroovy()
}
这样就算是配置好了
2. 自定义任务
在java中创建一个类来自定义任务,该类需要继承DefaultTask
public class MyTest extends DefaultTask {
public String str;
@TaskAction
public void say(){
System.out.print(str);
}
}
用@TaskAction注释来标明执行任务时所执行的方法
3. 自定义Plugin
在main文件夹下创建groovy目录(该目录下可以写groovy代码,也可以写java代码)
创建自定义Plugin,我这命名为TestPlugin
public class TestPlugin implements Plugin<Project> {
@Override
public void apply(Project project) {
project.getTasks().create("hello", MyTest.class, new Action<MyTest>() {
@Override
public void execute(MyTest myTest) {
myTest.str = "aaaaaaaaaaaaaaaa";
myTest.say();
myTest.str = "hello";
}
});
}
}
在此创建了一个名为hello的任务,然后映射到我们自定义的任务的类MyTest。
4. 引用插件
我这里因为没有其它模块,所以直接在根目录中引用插件
在原本的gradle文件中加入apply plugin: com.test.plugin.TestPlugin
apply plugin: com.test.plugin.TestPlugin
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.2.1'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
allprojects {
repositories {
google()
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
5.运行结果
我们直接在命令行中运行hello命令查看结果,输入gradlew hello(gradlew是我这台机的,有些是gradle)
可以看到上面我们写的execute回调会在Configure project阶段运行的,而str = "hello"也是在这个阶段设置的,那么我们像其它插件一样写个闭包,看看效果,在gradle中加入
hello{
str = "what"
}
加入闭包设置str 为 what,看看打印的结果
看到最后的结果会是在闭包中设置的内容