自定义Gradle插件

是什么

Gradle是一个开源的自动化构建工具，可以使用groovy或kotlin来编写Gradle构建脚本，具有高度可定制、更快的编译速度以及功能强大等特性。
Gradle的核心为构建任何东西提供了一个基础架构，但是插件允许构建脚本作者花最少的努力完成任务，允许他们专注于构建什么，而不是如何构建。简单来说可以把Gradle理解为是一个编程框架，我们只要遵循它的设计规则，利用它提供的API可以编写出各种各样的插件；在Gradle中，每一个待编译的工程是一个Project，每一个Project在构建的时候都会包含一系列的Task。一个Android项目的构建大致包含：Kotlin源码编译、Java源码编译、资源编译、JNI编译、Lint检查、混淆、打包、签名等等若干个Task任务。
Gradle也是一个Java或者说JVM应用，这个应用的任务就是去完成构建期的工作，我们在编写Gradle插件的时候其实和编写一个Android应用是非常类似的，只需要遵循Gradle定义的规则以及了解它的一些生命周期即可（就和我们需要了解四大组件的生命周期一样）。
下面是一个Gradle项目的结构：

.
├── CustomPluginSample.iml
├── MyPlugin
│   ├── MyPlugin.iml
│   ├── build.gradle
│   ├── libs
│   └── src
├── app
│   ├── app.iml
│   ├── build
│   ├── build.gradle
│   ├── libs
│   ├── proguard-rules.pro
│   └── src
├── build.gradle
├── gradle
│   └── wrapper
├── gradle.properties
├── gradlew
├── gradlew.bat
├── local.properties
└── settings.gradle

这个项目包含MyPlugin和app以及CustomPluginSample三个Project（看目录下是否有build.gradle文件）
其中CustomPluginSample是Root Project，与其他Project的区别是多了一个settings.gradle文件，带有这个文件的Project表明它是一个Multi Project，这个文件是告诉Gradle项目和子项目是如何构造的，我们来看下这个文件的内容：

include ':app', ':MyPlugin'

内容简单易懂，就是调用include函数把app和MyPlugin包含到项目当中，而build.gradle文件中则是配置当前Project的构建脚本。
很显然，上面提到的两个文件是Gradle约定好的规则，在Gradle启动的时候会对项目目录进行扫描，找到这些文件，那现在第一个问题来了，这些文件是在什么时候被执行的呢？这就需要我们去了解Gradle的生命周期了（是不是和刚学习Android开发的时候很像？）

Gradle工作流程.png

• Initialization
  Gradle支持单个和多个项目构建。在初始化阶段，Gradle确定哪些项目将参与构建，并为每个项目创建一个项目实例。settings.gradle文件就是在这个时期执行的
• Configuration
  在此阶段将配置项目对象，作为构建的一部分的所有项目的构建脚本都被执行。build.gradle文件被解析
• Execution
  Gradle确定要执行的任务的子集，这些任务是在Configuration阶段创建和配置的。子集由传递给gradle命令和当前目录的任务名称参数决定。然后Gradle执行每一个被选择的任务。
  我分别在每个build.gradle以及settings.gradle加了一些log输出的代码：

task MyPluginTask {
    System.println("in project $project.name, build.gradle parsed")
}


gradle.beforeProject {
    System.println("------$project.name: beforeProject------")
}

gradle.taskGraph.whenReady {
    System.println("------$project.name: whenReady------")
}

gradle.buildFinished {
    System.println("------$project.name: buildFinished------")
}

在执行项目后输出日志内容如下:

Executing tasks: [:app:generateDebugSources]

settings.gradle invoke
------settings.gradle: beforeProject------
in project CustomPluginSample, build.gradle parsed
------settings.gradle: beforeProject------
------CustomPluginSample: beforeProject------
in project app, build.gradle parsed
------settings.gradle: whenReady------
------CustomPluginSample: whenReady------
------app: whenReady------
:app:preBuild UP-TO-DATE
...中间省略
:app:processDebugResources UP-TO-DATE
:app:generateDebugSources UP-TO-DATE

BUILD SUCCESSFUL in 0s
13 actionable tasks: 13 up-to-date
------settings.gradle: buildFinished------
------CustomPluginSample: buildFinished------
------app: buildFinished------

很显然，Gradle在解析完settings.gradle后，每解析一个build.gradle文件都会执行一遍上图的流程，而且调用gradle.beforeProject等方法应该是将参数中的闭包添加到一个类似队列的数据结构，每次解析完一个build.gradle文件后就会从这个数据结构中取出这些闭包从头开始执行一次。

为什么

在上面介绍完Gradle是什么之后，我想为什么要写Gradle插件这个问题的答案也就呼之欲出了，前面说到Gradle是一个编程框架，我们利用这个框架提供的API并遵循它制定的规则去实现我们想要的插件，比如构建Android应用的插件，编写自定义插件和编写一个供其他开发人员使用的第三方库的目的是一样的，都是把一些具备基本功能的API进一步封装，为开发人员提供更加方便、可以实现更复杂功能的API。

怎么做

创建一个名为MyPlugin的Module，在MyPlugin/src/main/resources/META-INF/gradle-plugins/目录下创建一个名为org.example.greeting.properties的文件:

implementation-class=org.example.greeting.GreetingPlugin

这个文件是为了让Gradle知道哪些类实现了Plugin这个接口，而这个文件除了扩展名.properties以外的名字将作为这个插件的唯一标识即ID。

接下来我们看看GreetingPlugin的内容：

public class GreetingPlugin implements Plugin {

    @Override
    public void apply(Project project) {
        project.getPlugins().apply(SecondPlugin.class); //1

        GreetingPluginExtension extension = project.getExtensions().create("greeting", GreetingPluginExtension.class);//2

        project.getTasks().create("hello", Greeting.class, (task) -> {//3
            task.setMessage("Hello");
            task.setRecipient("World");
            task.doLast(task1 -> {
                System.out.println("task message: " + task.getMessage() + ", recipient: " + task.getRecipient());
                System.out.println("extension title: " + extension.title + ", message: " + extension.message);
            });
        });

    }
}

• 标注1处apply了另一个插件SecondPlugin，这个类的apply方法将会被调用；
• 标注2处创建了一个名称为greeting的extension，对应的类是GreetingPluginExtension：

```
public class GreetingPluginExtension {
    String title = "default";
    String message = "default";
}
```
创建的这个**extension**是什么东西呢？看一下**build.gradle**文件的这句代码可能你就了解了：

```
greeting {
    title = 'modify'
    message = 'modify'
}
```
我们在使用很多第三方**Gradle**插件的时候经常会碰到这样的代码，用户可以在这个闭包里面对其属性进行一些配置，这些配置就能够被插件获取到（有一个恶心的地方就是如果没有文档的话用户压根就不知道怎么去配置）。

• 标注3处则创建了一个名为hello的Task，对应的类为Greeting：

  public class Greeting extends DefaultTask {
  
      private String message = "default";
      private String recipient = "default";
  
      public String getMessage() { return message; }
      public void setMessage(String message) { this.message = message; }
  
      public String getRecipient() { return recipient; }
      public void setRecipient(String recipient) { this.recipient = recipient; }
  
      @TaskAction
      void sayGreeting() {
          System.out.printf("%s, %s!\n", getMessage(), getRecipient());
      }
  
      @TaskAction
      void secondAction() {
          System.out.println("this is second action");
      }
  }
  

Task在Gradle是一个很重要的类，上文提到插件就是负责定义各种Task然后按照一定顺序执行最终完成整个构建流程，Gradle提供了丰富的API来让我们对这些Task添加额外的行为，以及建立它们之间的依赖关系。

Task的几种执行结果

当Gradle执行一个任务的时候，它可以在控制台中用不同的结果标记任务。这些标签是基于任务是否有操作要执行，是否应该执行这些操作，是否执行了这些操作，以及这些操作是否做了任何更改。

(no label) or EXECUTED

任务执行它所有的Actions

• 任务有actions且Gradle确定它们应该作为构建的一部分来执行
• 任务没有actions和依赖任务，或者所有依赖的任务已经被执行完毕

UP-TO-DATE

任务的输出没有改变

• 任务有输入和输出，如果它们没有改变
• 任务没有actions，但是任务已经告知Gradle它没有改变它的输出
• 任务没有任何actions和依赖任务，但它所有的依赖任务都是up-to-date, skipped或者from cache结果
• 任务没有actions和依赖任务

FROM-CACHE

任务的输出可以从上一次执行缓存中找到（已开启构建缓存）

SKIPPED

任务不执行它的actions

• 任务被显示的排除在命令行之外
• 任务调用了onlyif方法，只有在这个方法返回true的时候任务的actions才会被执行

NO-SOURCE

任务不需要执行它的actions，任务有输入和输出，但是没有sources

更详细的内容参考https://docs.gradle.org/4.10-rc-2/userguide/more_about_tasks.html

现在我们已经创建了一个简单的Plugin，要怎么去应用它呢？官方文档的教程里面是让我们上传到仓库中，然后通过唯一ID去引入我们的自定义插件，但是这样对于我们只是写一个简单的demo来说太麻烦了，所以我找到一个简单的方法可以让我们比较方便的在本地去调试我们的自定义插件。
首先将项目编译完成，可以在GreetingPlugin/build/libs目录下找到编译出来的jar包，将其拷贝到任意目录（我这里将它拷贝到GreetingPlugin/libs目录），然后在项目跟目录的build.gradle加入如下代码：

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath fileTree(include: ['*.jar'], dir: 'GreetingPlugin/libs/')
        classpath files('GreetingPlugin/libs/GreetingPlugin.jar')
    }
}

然后在需要引入插件的build.gradle文件加入下面的代码即可

apply plugin: GreetingPlugin