自定义Gradle Plugin

第一步 ：
new 一个 module 出来，选择android library即可

第二步：
将新建的module除了 build.gradle 和 src/main 之外的文件删除

第三步：
修改build.gradle文件为以下内容，点击sync now

plugins {
    id 'groovy'
    id 'maven'
    id 'java'
}

repositories{
    mavenCentral()
}

dependencies {
    implementation fileTree(dir: 'libs',includes: ['*.jar'])

    implementation gradleApi()
    implementation localGroovy()

    implementation 'com.android.tools.build:gradle:4.2.2'
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}

第四步：
在src/main文件下创建groovy文件夹，然后我们去自定义一个plugin类实现Plugin接口，我这里随意创建了一个命名为TimePlugin的类

package com.ym.plugin;

//这里要注意，不要导错包了，不然我们后面部署的时候会有编译异常
import org.gradle.api.Plugin;
import org.gradle.api.Project;

public class TimePlugin implements Plugin {
    //当插件被引用时，此方法会在编译时执行
    @Override
    public void apply(Project project) {
        System.out.println("这是我的个人插件");
    }
}

第五步：
在src/main下面创建resources/META-INF/gradle-plugins文件夹，在此文件夹下创建Time-plugin.properties文件，这里的「Time-plugin」是随意命名的，会在稍后app引用插件的步骤中，使用到此名称，文件中的内容如下，其中com.ym.plugin.TimePlugin是步骤4我们自定义的插件类

implementation-class=com.ym.plugin.TimePlugin

第六步：
对插件进行部署，我们可以部署到远程maven，也可以部署到我们本地，我们这里就简单部署到本地就可以，在build.gradle文件中添加以下代码

plugins {
    id 'groovy'
    id 'maven'
    id 'java'
}

repositories{
    mavenCentral()
}

dependencies {
    implementation fileTree(dir: 'libs',includes: ['*.jar'])

    implementation gradleApi()
    implementation localGroovy()

    implementation 'com.android.tools.build:gradle:4.2.2'
}

//这里是插件部署时需要用的group名称和版本号，自己随意设置
group='lollipop.plugin.timePlugin'
version='1.0.0'

uploadArchives {
    repositories {
        mavenDeployer {
            //插件部署的目录文件夹，这里是和当前项目所在文件夹，和项目平级，仓库名为：asm_repo. 注意这里是../../
            repository(url :uri('../../asm_repo'))
        }
    }
}
java {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}

第七步：
sync后，我们可以在gradle插件中找到对应的task，进行部署即可

部署插件.png

部署后我们可以在对应的文件夹中看到插件仓库 「asm_repo」文件夹

第八步：
插件的使用，首先我们需要在项目的build.gradle加入自定义的插件

plugins {
    id 'com.android.application'
    id 'kotlin-android'

    //这里为resources/META-INF/gradle-plugins目录下创建的文件名
    id 'Time-plugin'
}

其次我们在根目录的build.gradle中添加插件

buildscript {
    repositories {
        //这里需要注意，路径为../asm_repo ，而不是我们刚才部署时，用的../../asm_repo
        //因为根 gradle 和插件的 gradle 的相对层级就是少一级。如果路径不对的话，是会
        //提示异常：Could not resolve all artifacts for configuration ':ckasspath' .
        // Could not find lollipop.plugin.timePlugin:lollipopPlugin:1.0.0 .
        maven {url uri('../asm_repo')}
        google()
        mavenCentral()
    }
    dependencies {
        // 这里的路径为 group名:module名:version版本
        classpath "lollipop.plugin.timePlugin:lollipopPlugin:1.0.0"
    }
}

第八步：
执行./gradlew clean assembledebug命令，我们可以看到在控制台，打印出了以下内容，则说明我们的插件正常运行了

插件引用.png

第九步：
如果我们修改了自定义插件的逻辑，即TimePlugin类apply()方法中的逻辑，那么我们需要删除本地的插件仓库，重新执行下插件本地部署，这一步我们需要先把插件在build.gradle中相关的引用注释掉，因为我们已经把插件本地仓库删除了，如果不注释的话，会编译报错的