自定义Gradle Plugin

一、编写插件

下面我们用一个示例来介绍如何自定义Gradle插件。该插件的功能非常简单，仅仅是定义了一个Task然后打印一条日志信息。

详细步骤：

第1步：新建一个项目（Project）在新建的空项目中，会自动包含一个主module，即：app。

第2步：创建plugin module创建Android Library module，module名称叫plugin，我们将会用这个Library写Gradle Plugin；

第3步：创建plugin需要的目录结构

首先删除plugin/src目录下的所有文件

• 创建groovy目录

在src/main目录下，创建groovy目录。因为开发Gradle Plugin是用Groovy语言，所以插件的代码需要放到src/main/groovy目录下，然后在该目录下新建一个package，比如com.gc.plugin。

• 创建properties文件

在src/main目录下，依次创建目录resources/META-INF/gradle-plugins。然后我们在resources/META-INF/gradle-plugins目录下再创建一个后缀名为.properties的文件，用来声明插件名称以及对应插件的包名和类名。比如，我们可以创建一个文件名叫com.gc.android.properties的文件。其中com.gc.android就是我们要定义的插件名称。文件里面放置什么内容后面会讲到。

第4步：添加依赖关系

修改plugin/build.gradle文件，添加对gradle、groovy的依赖。

apply plugin : 'groovy'

dependencies {
    implementation gradleApi() //gradle sdk
    implementation localGroovy() //groovy sdk
}

repositories {
    mavenCentral()
}

第5步：实现插件

在src/main/groovy目录的package下新建TestPlugin.groovy类，该类实现Plugin<Project>接口，内容如下：

package com.gc.plugin

import org.gradle.api.Plugin
import org.gradle.api.Project

class TestPlugin implements Plugin<Project>{

    @Override
    void apply(Project project) {
        println("this is a plugin")
    }
}

 TestPlugin实现了Plugin<Project>接口，并重写其apply(Project project)。在apply(Project project)方法里，我们通过project.task创建了一个Task，Task名称叫Myask，该Task比较简单，仅仅是打印了一条信息。

第6步：修改cn.sensorsdata.android.properties文件文件里面的内容只有一行，内容如下：

implementation-class= com.gc.plugin.TestPlugin

等号后面的内容就是我们上面第五步中创建的文件的包名+类名。

至此，一个非常简单的插件就完成了。编译一下这个plugin，可以在plugin/build目录下看到生成的插件jar文件

二、发布插件

我们上面仅仅是编写了一个Gradle插件。如果你想使用你的插件，或者把插件给别人使用，就需要把插件发布出去。一般情况下，按照“把插件发布到哪里”这个条件来区分的话，发布插件可以简单分为两种情况：

• 发布插件到本地仓库
• 发布插件到远程仓库

下面我们介绍一下如何利用mavenDeployer这个插件来发布插件到本地仓库。具体步骤如下：

第1步：引入mavenDeployer插件修改plugin/build.gradle文件，引入mavenDeployer插件，并设置mavenDeployer的详细配置信息，内容如下：

apply plugin: 'groovy'
apply plugin: 'maven'

dependencies {
    implementation gradleApi() //gradle sdk
    implementation localGroovy() //groovy sdk
    implementation 'com.android.tools.build:gradle:4.1.2'
//    implementation group: 'org.javassist', name: 'javassist', version: '3.22.0-GA'

}

repositories {
    jcenter()
}

//uploadArchives是将已经自定义好了插件打包到本地Maven库里面去，
//也可以选择打包到远程服务器中。其中， group和version是我们之后配置插件地址时要用到的。
uploadArchives {
    repositories {
        mavenDeployer {
            //本地仓库路径，放到根目录下repo文件夹
            repository(url:uri('../repo'))
            //groupId 组织名称或公司名
            pom.groupId = 'com.gc'
            //artifactId 项目名或模块名
            pom.artifactId = 'auto.android'
            //插件版本号
            pom.version = '1.0.0'
        }
    }
}

 上面配置中的groupId、artifactId和version属性内容，都是可以自定义的，可以根据企业（或个人）的实际信息进行填写，应用程序引用插件时会使用到这些信息。

其中，groupId为组织名称或公司名称，artifactId为项目名或模块名，version为项目或模块的当前版本号。通过设置repository属性，可以把uri配置在本地目录，这样就可以把maven设置成本地仓库，我们暂时把仓库配置到当前Project根目录下的repo目录。

第2步：编译插件

我们可以在Android Studio IDE右侧Gradle task的面板下看到我们刚才添加的uploadArchives Task，可以通过点击右键执行该任务，也可以在命令行里执行./gradlew uploadArchives来执行

执行完uploadArchives Task之后，在项目的根目录下就会生成一个repo目录，里面就存放着我们已发布到本地仓库的插件

至此，我们已经将之前编写的插件发布到本地maven仓库了

三、使用Gradle Plugin

上面，我们编写了一个插件，并且也把它发布到本地maven仓库了。

那么，一个应用程序应该如何使用我们刚刚发布的插件呢？下面我们就来介绍一下如何使用插件。

首先，修改Project根目录下的build.gradle文件，引入我们要使用插件：

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        google()
        jcenter()
        //引入仓库目录，用来配置本地maven仓库目录，就是我们上面发布到本地仓库的目录，即项目根目录下的repo目录。此处使用的是相对地址，也可以使用绝对地址。
        maven {
            url uri('repo')
        }
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.1.2"
        //引入插件，groupId：artifactId：version，即我们在uploadArchives中填写的相应内容。
        classpath "com.gc:auto.android:1.0.0"

        // 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
}

最后，在应用程序app module的build.gradle文件中添加使用插件。 

plugins {
    id 'com.android.application'
    id 'com.gc.android'
}

其中 ‘com.gc.android’ 就是我们上面在resources/META-INF/gradle-plugins目录下新建.properties文件的文件名。

至此，我们已经完成了使用本地仓库的插件。重新编译应用程序，将会看到如下的输出信息，也就是我们定义的Task里打印的信息

关于发布插件到远程仓库，此处不再详细描述，可以参考其官网文档，链接如下：https://plugins.gradle.org/docs/submit