自定义gradle插件笔记(配合ASM学习)

先写一个简单的插件跑起来

1. groovy创建插件
  • 工程中新建一个java lib类型的module,我起名testgradle,src→main下的java目录删掉,然后新建新的目录,包名,如图:
    1. MyPlugin:每一个自定义的Plugin都需要实现Plugin接口,除了给Project编写Plugin之外,也能为其他Gradle类编写Plugin。该接口定义了一个apply()方法,在该方法中,可以操作Project,比如向其中加入Task,定义额外的Property等。
    2. test-gradle.properties:这个文件名字随便起,就是apply plugin 后面的名称,里面把你的Myplugin全包名带上:
  • 修改module的build.gradle,本地没有maven可以自己百度装一个哈,不难。比如我的是:

plugins {
    id 'java-library'
}

apply plugin: 'java-library'
apply plugin: 'groovy'
apply plugin: 'maven'

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

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation gradleApi()
    implementation localGroovy()
    implementation 'com.android.tools.build:transform-api:1.5.0'
    implementation 'com.android.tools.build:gradle:3.0.1'
}

uploadArchives{
    repositories.mavenDeployer{
        // 本地仓库路径
        repository(url:"file:///Users/shihchieh_ma/.m2/repository/")
        // 唯一标识
        pom.groupId = "shihchieh.ma.demo"
        // 项目名称
        pom.artifactId = "testgradle"
        // 版本号
        pom.version = "1.0.0"
    }
}

  • 传本地maven上,旁边gradle点击或者命令行都行
    1
    2
  • 使用

    1. 修改根目录的build.gradle,就是uploadArchives中的groupId:artifactId:version组合:
// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        mavenLocal()
        google()
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.2.0"
        classpath "shihchieh.ma.demo:testgradle:1.0.0"
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        mavenLocal()
        google()
        mavenCentral()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}   
  1. 然后随便一个module中引用这个插件就行,我没再新建别的,就放app module中了:
  2. rebuild或者make下都行,就能看到了:

Gadle Plugin 配合ASM正式开始

  • 定一个简单的目标,我想在一个Activity的oncreate中用asm插入一个Toast。

    正常代码:

    编译后:

先简单说下大概步骤和可能遇到的问题:
步骤思路:

  1. 目标比较简单,通过遍历文件夹就可以找到MainActivity的class文件。
  2. 对比有Toast和没有Toast的class文件的ASMified生成的代码差异,找到对应有Toast的拷贝到自己对应实现的MethodVisitor的visitInsn方法中。
  3. 插件发布到本地验证测试,对应的build的transforms目录下jar包和class文件是否有内容,以及运行功能是否正产如预期。

可能遇到的问题:

  1. 插件每次修改后提交到本地maven仓库后,sync一下代码,然后clean,然后在rebuild下,不然有时候会报一些错误影响判断。
  2. Android Studio里的ASM Bytecode Viewer插件我这里用反正是有问题的,只能在class文件右键点着看,在java文件中右键直接用这个插件有问题,如下图。我新建了俩文件用beyond compare对着看的,如果谁有啥更好的工具或插件求告知。。。我这样写感觉效率太低了,也没找着啥好用的工具,不过这个插件我在IDEA上试了下就是好的,感觉可以在IDEA上写代码然后用这个插件,我还没试直接用IDEA写插件。
  3. 遍历目录和jar包后要有拷出操作,通俗的说就是在实现的transform这个方法里,要有内容产出,产物传递吧,不然app是跑不起来的。会出现如下错误:
Unable to instantiate appComponentFactory
    java.lang.ClassNotFoundException: Didn't find class "androidx.core.app.CoreComponentFactory" on path: DexPathList[[zip file "/data/app/~~81QZSgXA9N_0MNnG9dfHDg==/com.example.as_c_demo-B8o2lngQ5IM_LEQpSLsP9w==/base.apk"],nativeLibraryDirectories=[/data/app/~~81QZSgXA9N_0MNnG9dfHDg==/com.example.as_c_demo-B8o2lngQ5IM_LEQpSLsP9w==/lib/arm64, /data/app/~~81QZSgXA9N_0MNnG9dfHDg==/com.example.as_c_demo-B8o2lngQ5IM_LEQpSLsP9w==/base.apk!/lib/arm64-v8a, /system/lib64, /system/system_ext/lib64]]

核心代码实现:

jar包并没有做内容上的修改,所以直接看遍历目录以及修改的相关逻辑了:

  1. transform中获取对应的Collection directoryInputs = transformInput.getDirectoryInputs();
  2. 遍历逻辑
  3. ASM插入

总结

我这边也才看ASM一阵子,这个是结合gradle plugin写的demo,做做笔记,感觉比aop功能更强大,灵活性更高,并且配合插件开发,可以组装出无侵入类型的sdk,比如埋点SDK使用这种开发方式应该就能轻松做到,提供的SDK对于集成方来说可以说能做到非常友好。后续继续深入学习一下,另外有空了我在找找有没有啥提高效率的插件或工具,这种文件比较的方式效率太低了。


20210621 20:46 update

AdviceAdapter


大概意思是说能在方法和构造函数先于或后于或之间中插入代码。在每个超类构造函数调用后被调用,对象在正确初始化之前不能使用。之间插入的需求应该比较小,没想到什么情况需要插入到中间,所以尝试了在最先和最后插入的尝试。

  1. 目标在onCreate中最先和最后记录时间戳。以记录这个onCreate执行所需要的时间。基于之前的代码进行修改。
  2. MyAdviceAdapter实现很简单,直接上代码
  3. CLASS_PAGE_TIME_RECORD
  4. 对应的HockActivityCore:

    这个session只是一直普通的bean,里面变量记录下时间戳。

  5. 打包提交本地maven测试,一如以前操作,查看生成的class:
  6. 打完收工

你可能感兴趣的:(自定义gradle插件笔记(配合ASM学习))