2021-01-08 Android 插桩<1> （自定义Gradle 插件 + ASM）

1.自定义Gladle 插件

首先自定义一个Gladle插件，在项目中新建一个lib model，将其中多余文件删除并将model中的gradle修改，如下图

WechatIMG772.jpeg

下面为gradle文件代码

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

repositories {
    mavenCentral()
    jcenter()
}

dependencies {
    //gradle sdk
    implementation gradleApi()
    //groovy sdk
    implementation localGroovy()
    // AMS插桩依赖
    implementation 'com.android.tools.build:gradle:4.0.2'
}

接下来在main目录下新建groovy路径，并创建TestPlugin.groovy文件，注意：TestPlugin.groovy文件必须写全后缀也就是必须写.groovy，否则引入插件时会提示找不到TestPlugin，新建完成后的目录如下：

WechatIMG773.jpeg

继续新建resources目录=》resources->META-INF->gradle-plugins在这个目录下创建. properties文件，这个. properties 文件的文件名就是之后在项目中引入插件的名称，例如我创建了test-plugin.properties文件，之后我在项目中引入插件就使用 apply plugin:test-plugin 的方式引用，创建完成后的目录如下：

WechatIMG774.jpeg

接下来编写TestPlugin.groovy文件

//注意得手动引入包名
package com.androidtv.test_plugin

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

class TestPlugin implements Plugin {
    @Override
    void apply(Project project) {
        //编译时就会执行
        System.out.println("================")
        System.out.println("this is test plugin")
        System.out.println("================")
    }
}

在test-plugin.properties中加入一下代码

//如果找不到TestPlugin，看看是不是TestPlugin中没有引入报名
implementation-class=com.androidtv.test_plugin.TestPlugin

到这里，自定义的gradle插件就差不多完成了，接下来打包使用，在gradle文件中加入：

//group和version在后面使用自定义插件的时候会用到
group = 'com.test.plugin'
version = '1.0.0'
uploadArchives {
    repositories {
        mavenDeployer {
            //提交到远程服务器：
            // repository(url: "http://www.xxx.com/repos") {
            //    authentication(userName: "admin", password: "admin")
            // }
            //本地的Maven地址设置为当前model目录
            repository(url: uri('../test-plugin'))
        }
    }
}

添加完成之后，在右边的Gradle菜单中会出现uploadArchives的命令

WechatIMG775.jpeg

点击uploadArchives就可以打包生成对应的插件

WechatIMG776.jpeg

接下来使用生成的这个插件，在项目的跟目录的gradle文件中引入插件

buildscript {
    ext.kotlin_version = "1.3.72"
    repositories {
        google()
        jcenter()
        maven {//本地Maven仓库地址
            url uri('test-plugin')
        }
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.0.1"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
          
        //引入插件，格式为-->group:module:version
        classpath 'com.test.plugin:test-plugin:1.0.0'
    }
}

在对应的项目中使用插件，如在app项目下引入插件，在app的gradle中引入

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
//插件名就是前面定义的test-plugin.properties文件名，这里就是test-plugin
apply plugin: 'test-plugin'

引入后在运行app，在build中就可以看到对应的输出信息

WechatIMG777.jpeg

到这里，自定义gradle插件就完成了，关于AMS代码插桩，下篇讲解。