自定义Gradle插件

  最近在学习字节码插桩技术，利用字节码插桩技术，我们可以在编译时期对字节码进行修改，达到完成一些特殊需求，比如埋点(可以声明一个BaseActivity，在onCreate和onDestory中进行埋点)；统计函数执行时间；热修复，ButterKnief、Dagger等也用到了字节码插桩技术。
  在Android中要使用字节码插桩技术需要完成三步：

• 自定义Gradle插件 :自定义插件，重写apply方法，注册自定义Transform
• Transform Api使用：自定义Ttransform，在transform方法中实现处理逻辑
• Asm的使用： 在transform中使用Asm插入字节码
    本文是实现第一步，自定义Gradle。
    实现自定义Gradle插件主要有三种方式：
  1.在build.gradle中定义，直接在module的build.gradle中实现，缺点：只能在本项目中使用，不好复用。
  2.buildSrc中使用。这种方式需要在项目中新建一个model命名为buildSrc，这个目录就用来存放自定义插件，缺点：只能在本项目中使用，不好复用。
  3.独立Module中使用。这种方式就是完全独立开发一个Module，并且可以上传至maven库，可以随便用。
  由于三种方式实现都差不多，前两种局限性比较大，所以本文只对第三种进行记录。
  1、新建Android Module选择Android Library类型即可
    除去src/main和build.gradle其余文件都删除，并清除build.gradle内容，将以下内容填入build.gradle，并同步gradle

apply plugin: 'groovy'

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

2、新建groovy文件，实现插件逻辑
  在src/main目录下新建groovy目录，在groovy目录下新建com.example.clean目录（名字自取即可）,在该目录下新建CleanPlugin.groovy文件，文件有一个绿色的G标记，表示系统识别为groovy文件，可以导入gradle api。如果没有出现绿色标志，可以将文件名改为小写试试。

新建插件文件

  这个cleanplugin.groovy就是我们要实现插件的主要逻辑，我们需要声明一个类来实现Plugin接口，在apply中实现主要逻辑。

package com.example.clean
import org.gradle.api.Plugin
import org.gradle.api.Project;

class cleanplugin implements Plugin {
    @Override
    void apply(Project project) {
        println("clean plugin")
    }
}

  注意记得导入包目录，否则会导致找不到插件实现类
3、声明插件
  在src/main目录下新建resource目录，接着新建META-INF目录，继续新建gradle-plugins目录，再新建com.example.firstplugin.properties文件(名字自取)，注意文件名即为到时候其他项目中引用的插件名，在该文件中写入如下内容

//插件实现类
implementation-class=com.example.clean.cleanplugin

4、将插件上传至maven库
  在插件的build.gradle文件中添加插件groupid、version等参数和上传maven地址

apply plugin: 'maven-publish'
publishing {
    publications {
        mavenJava(MavenPublication) {

            //其他项目使用插件时的方式：classpath 'com.example.clean:firstplug:1.0.0'
            //三个参数
            groupId 'com.example.clean'
            artifactId 'firstplug'
            version '1.0.0'

            from components.java

        }
    }
}

publishing {
    repositories {
        maven {
            // maven地址，可以是本地地址也可以是远程地址
            url uri('C:/Android/repos')
        }
    }
}

最终build.gradle文件内容如下：

apply plugin: 'groovy'
apply plugin: 'maven-publish'

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

publishing {
    publications {
        mavenJava(MavenPublication) {

            //其他项目使用插件时的方式：classpath 'com.example.clean:firstplug:1.0.0'
            //三个参数
            groupId 'com.example.clean'
            artifactId 'firstplug'
            version '1.0.0'

            from components.java

        }
    }
}

publishing {
    repositories {
        maven {
            // maven地址，可以是本地地址也可以是远程地址
            url uri('C:/Android/repos')
        }
    }
}

  同步gradle，在右侧的gradle目录中，找到clean下的publish任务，并运行publish，将插件上传至maven库。

运行publish任务，上传插件至maven库

  运行成功后，在本地的repos目录下可以找到上传的插件

本地maven库的插件

5、引用插件
  在项目的根build.gradle文件中，添加插件引用和maven库地址，最终build.gradle文件内容如下：

buildscript {
   
   repositories {
       google()
       jcenter()
       maven {//local maven repo path
           url uri('C:/Android/repos')
       }
   }
   dependencies {
       classpath 'com.android.tools.build:gradle:3.6.1'
       classpath 'com.example.clean:firstplug:1.0.0'
       

       // NOTE: Do not place your application dependencies here; they belong
       // in the individual module build.gradle files
   }
}

同步gradle，在app module的build.gradle文件中添加插件，如下：

//原文件的android插件
apply plugin: 'com.android.application'
//添加自定义插件，插件名即为com.example.firstplugin.properties文件名
apply plugin: 'com.example.firstplugin'

自定义插件名即为com.example.firstplugin.properties文件名，同步build.gradle，运行app下的bulid任务

插件运行成功

出现"clean plugin"，即自定义插件中apply方法中输出的日志，表示插件运行成功。