阅读 2482

自定义Gradle插件检测函数耗时

前言

上一篇文章讲解了Gralde的入门知识,其中讲到了如何自定义Gralde插件,本文就通过AsmTransfrom来自定义一个简单的Gradle插件,这个Gradle插件它可以统计方法的耗时,并当方法的耗时超过阀值时,通过Log打印在控制台上,然后我们通过Log可以定位到耗时方法的位置,帮助我们找出耗时方法,一个很简单的功能,原理也很简单,这其中需要使用到Asm知识和Transfrom知识,所以本文首先会介绍Asm和Transfrom相关知识点,最后再介绍如何使用Asm和Transform来实现这个Gradle插件,如果你对Asm和Transfrom已经很熟悉了,可以跳过这两节。

源码位置在文末

运行效果

由于这个是本地插件,所以直接在app/build.gradle中apply就行,然后可以通过time扩展配置它(可选):

apply plugin: com.example.plugin.TimeCostPlugin
//函数耗时阀值为200ms,只对应用内的函数做插桩(排除第三方库)
time{
    threshold = 200
    appPackage = 'com.example.plugindemo'
}
复制代码

然后特意定义几个耗时函数:

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState)  {
        super.onCreate(savedInstanceState);

        try {
            method1();
            method2();
            method3();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    private static void method1() throws InterruptedException {
        Thread.sleep(500);
    }

    public void method2() throws InterruptedException {
        Thread.sleep(300);
    }

    void method3() throws InterruptedException {
        Thread.sleep(1000);
    }
}
复制代码

最后编译运行一下,就会在在控制台打印耗时函数的信息出来:

{% asset_img plugin1.png plugin %}
点击方法行号就可以直接定位到耗时函数处。

Asm

官方地址:ASM

官方教程:ASM4-guide(英文版)ASM4-guide(中文版)

Asm是一个通用的Java字节码操作和分析框架, 它提供了一些简单易用的字节码操作方法,可以直接以二进制的形式修改现有类或动态生成类,简单地来说,Asm就是一个字节码操作框架,通过Asm,我们可以凭空生成一个类,或者修改现有的类,Asm相比其他的字节码操作框架如Javasist、AspectJ等的优点就是体积小、性能好、效率高,但它的缺点就是学习成本高,不过现在已经有IntelliJ插件ASM Bytecode Outline可以替我们自动的生成Asm代码,所以对于想要入门Asm的人来说,它还是很简单的,我们只需要简单的学习一下Asm的相关api的含义,在此之前希望你已经对JVM的基础知识:类型描述符、方法描述符、Class文件结构有一定的了解。

Asm中有两类api,一种是基于树模型的tree api,一种是基于访问者模式的visitor api,其中visitor api是Asm最核心和基本的api,所以对于入门者,我们需要知道visitor api的使用,在visitor api中有三个主要的类用于读取、访问和生成class字节码:

  • ClassVisitor: 它是用于访问calss字节码,它里面有很多visitXX方法,每调用一个visitXX方法,就表示你在访问class文件的某个结构,如Method、Field、Annotation等,我们通常会扩展ClassVisitor,利用代理模式,把扩展的ClassVisitor的每一个visitXX方法的调用委托给另外一个ClassVisitor,在委托的前后我们可以添加自己的逻辑从而达到转换修改这个类的class字节码的目的;

  • ClassReader:它用于读取以字节数组形式给出的class字节码,它有一个accept方法,用于接收一个ClassVisitor实例,accept方法内部会调用ClassVisitor的visitXX方法来访问已读取的class文件;

  • ClassWriter:它继承自ClassVisitor,可以以二进制形式生成class字节码,它有一个toByteArray方法,可以把已生成的二进制形式的class字节码转换成字节数组形式返回.

    ClassVisitor、ClassReader、ClassWriter这三个之间一般都是需要组合使用的,下面通过一些实际的例子快速掌握,首先我们需要在build.gradle中引入Asm,如下:

    dependencies {
        //核心api,提供visitor api
        implementation 'org.ow2.asm:asm:7.0'
        //可选,提供了一些基于核心api的预定义类转换器
        implementation 'org.ow2.asm:asm-commons:7.0'
        //可选,提供了一些基于核心api的工具类
        implementation 'org.ow2.asm:asm-util:7.0'
    }
    复制代码

1、读取、访问一个类

读取类之前,首先介绍一下ClassVisitor中的visitXX方法,ClassVisitor的主要结构如下:

public abstract class ClassVisitor {

    //ASM的版本, 版本数值定义在Opcodes接口中,最低为ASM4,目前最新为ASM7
    protected final int api;
  
    //委托的ClassVisitor,可传空
    protected ClassVisitor cv;

    public ClassVisitor(final int api) {
        this(api, null);
    }
  
    public ClassVisitor(final int api, final ClassVisitor cv) {
        //...
        this.api = api;
        this.cv = cv;
    }

    //表示开始访问这个类
    public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
        if (cv != null) {
            cv.visit(version, access, name, signature, superName, interfaces);
        }
    }

    //表示访问这个类的源文件名(如果有的话)
    public void visitSource(String source, String debug) {
        if (cv != null) {
            cv.visitSource(source, debug);
        }
    }

    //表示访问这个类的外部类(如果有的话)
    public void visitOuterClass(String owner, String name, String desc) {
        if (cv != null) {
            cv.visitOuterClass(owner, name, desc);
        }
    }

    //表示访问这个类的注解(如果有的话)
    public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
        if (cv != null) {
            return cv.visitAnnotation(desc, visible);
        }
        return null;
    }

    //表示访问这个类的内部类(如果有的话)
    public void visitInnerClass(String name, String outerName,
            String innerName, int access) {
        if (cv != null) {
            cv.visitInnerClass(name, outerName, innerName, access);
        }
    }

    //表示访问这个类的字段(如果有的话)
    public FieldVisitor visitField(int access, String name, String desc,
            String signature, Object value) {
        if (cv != null) {
            return cv.visitField(access, name, desc, signature, value);
        }
        return null;
    }

    //表示访问这个类的方法(如果有的话)
    public MethodVisitor visitMethod(int access, String name, String desc,
            String signature, String[] exceptions) {
        if (cv != null) {
            return cv.visitMethod(access, name, desc, signature, exceptions);
        }
        return null;
    }

    //表示结束对这个类的访问
    public void visitEnd() {
        if (cv != null) {
            cv.visitEnd();
        }
    }
  
  	//...省略了一些其他visitXX方法
}
复制代码

可以看到,ClassVisitor的所有visitXX方法都把逻辑委托给另外一个ClassVisitor的visitorXX方法,我们知道,当一个类被加载进JVM中时,它的class的大概结构如下:

{% asset_img plugin2.png plugin %}

所以把class文件结构和ClassVisitor中的方法做对比,可以发现,ClassVisitor中除了visitEnd方法,其他visitXX方法的访问都对应class文件的某个结构,如字段、方法、属性等,每个visitXX方法的参数都表示字段、方法、属性等的相关信息,例如:access表示修饰符、signature表示泛型、desc表示描述符、name表示名字或全权限定名,我们还注意到有些visitXX方法会返回一个XXVisitor类实例,这些XXVisitor类里面又会有类似的visitXX方法,这表示外部可以继续调用返回的XXVisitor实例的visitXX方法,从而继续访问相应结构中的子结构,这个后面再解释。

知道了ClassVisitor中方法的作用后,我们自定义一个类,使用ClassReaderClassVisitor把这个类的信息读取、打印出来,首先自定义一个名为OuterClass的类,如下:

@Deprecated
public class OuterClass{

    private int mData = 1;

    public OuterClass(int data){
        this.mData = data;
    }

    public int getData(){
        return mData;
    }

    class InnerClass{ }
}
复制代码

OuterClass类有注解、字段、方法、内部类,然后再自定义一个名为PrintClassVisitor的类扩展自ClassVisitor,如下:

public class PrintClassVisitor extends ClassVisitor implements Opcodes {

    public ClassPrinter() {
        super(ASM7);
    }

    @Override
    public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
        System.out.println(name + " extends " + superName + "{");
    }

    @Override
    public void visitSource(String source, String debug) {
        System.out.println(" source name = " + source);
    }

    @Override
    public void visitOuterClass(String owner, String name, String descriptor) {
        System.out.println(" outer class = " + name);
    }

    @Override
    public AnnotationVisitor visitAnnotation(String descriptor, boolean visible) {
        System.out.println(" annotation = " + descriptor);
        return null;
    }

    @Override
    public void visitInnerClass(String name, String outerName, String innerName, int access) {
        System.out.println(" inner class = " + name);
    }

    @Override
    public FieldVisitor visitField(int access, String name, String descriptor, String signature, Object value) {
        System.out.println(" field = "  + name);
        return null;
    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) {
        System.out.println(" method = " + name);
        return null;
    }

    @Override
    public void visitEnd() {
        System.out.println("}");
    }
}
复制代码

其中Opcodes接口中定义了很多常量,ASM7就是来自Opcodes,在每个visitXX方法把类的相关信息打印出来,最后使用ClassReader读取OuterClass的class字节码,在accept方法中传入ClassVisitor实例,完成对OuterClass的访问,如下:

public static void main(String[] args) throws IOException {
  //创建ClassVisitor实例
  ClassPrinter printClassVisitor = new ClassPrinter();
  //从构造传入OuterClass的全权限定名,ClassReader会读取OuterClass字节码为字节数组
  ClassReader classReader = new ClassReader(OuterClass.class.getName());
  //在ClassReader的accept传入ClassVisitor实例,开启访问,第二个参数表示访问模式,先不用管,传入0
  classReader.accept(printClassVisitor, 0);
}

运行输出:
com/example/plugindemo/OuterClass extends java/lang/Object{
 source name = OuterClass.java
 annotation = Ljava/lang/Deprecated;
 inner class = com/example/plugindemo/OuterClass$InnerClass
 field = mData
 method = <init>
 method = getData
}
复制代码

ClassReader的构造除了可以接受类的全限定名,还可以接受class文件的输入流,最终都是把class字节码读取到内存中,变成字节数组,ClassReader的accept方法会利用内存偏移量解析构造中读取到的class字节码的字节数组,把class字节码的结构信息从字节数组中解析出来,然后调用传入的ClassVisitor实例的visitorXX方法来访问解析出来的结构信息,而且从运行输出的结果可以看出,accept方法中对于ClassVisitor的visitorXX方法的调用会有一定的顺序,以visit方法开头,以visitEnd方法结束,中间穿插调用其他的visitXX方法,其大概顺序如下:

visit 
[visitSource] 
[visitOuterClass] 
[visitAnnotation]
[visitInnerClass | visitField | visitMethod]
visitEnd

//其中[]表示可选,|表示平级
复制代码

2、生成一个类

前面知道了ClassReader可以用来读取一个类,ClassVisitor可以用来访问一个类,而ClassWirter它可以凭空生成一个类,接下来我们来生成一个名为Person的接口,该接口结构如下:

public interface Person {
    String NAME = "rain9155";
    int getAge();
}
复制代码

使用ClassWriter生成Person接口的代码如下:

import static org.objectweb.asm.Opcodes.*;

public class Main {

  public static void main(String[] args){
    //创建一个ClassWriter,构造传入修改类的行为模式,传0就行
    ClassWriter classWriter = new ClassWriter(0);
    //生成类的头部
    classWriter.visit(V1_7, ACC_PUBLIC + ACC_ABSTRACT + ACC_INTERFACE, "com/example/plugindemo/Person", null, "java/lang/Object", null);
    //生成文件名
    classWriter.visitSource("Person.java", null);
    //生成名为NAME,值为rain9155的字段
    FieldVisitor fileVisitor = classWriter.visitField(ACC_PUBLIC + ACC_FINAL + ACC_STATIC, "NAME", "Ljava/lang/String;", null, "rain9155");
    fileVisitor.visitEnd();
		//生成名为getAge,返回值为int的方法
    MethodVisitor methodVisitor = classWriter.visitMethod(ACC_PUBLIC + ACC_ABSTRACT, "getAge", "()I", null, null);
    methodVisitor.visitEnd();
		//生成类完毕
    classWriter.visitEnd();
    //生成的类可以通过toByteArray方法以字节数组形式返回
    byte[] bytes = classWriter.toByteArray();
  }
复制代码

ClassWirter继承自ClassVisitor,它扩展了ClassVisitor的visitorXX方法,使得它具有生成class字节码的能力,最终toByteArray方法返回的字节数组可以通过ClassLoader动态加载为一个Class对象,由于我这里生成的是一个接口,所以getAge方法没有方法体,所以visitMethod方法返回的MethodVisitor只是简单的调用了visitEnd就完成了getAge方法头的生成,如果需要生成getAge方法的内部逻辑,例如:

int getAge(){
  return 1;
}
复制代码

那么在调用MethodVisitor的visitEnd方法之前,还需要调用MethodVisitor的其他visitXX方法来生成方法的内部逻辑,MethodVisitor的visitXX方法就是在模拟的JVM的字节码指令,例如入栈、出栈等,对于visitField方法返回的FieldVisitor和visitAnnotation方法返回的AnnotationVisitor的含义和MethodVisitor类似。

可以看到使用ClassWirter生成一个简单的接口的代码量就如此繁琐,如果这是一个类,并且类中的方法有方法体,代码会更加的复杂,所幸的是我们可以通过ASM Bytecode Outline插件来完成这繁琐的过程,首先你要在你的AS或IntelliJ IDE中安装这个插件,然后在你想要查看的Asm代码的类右键 -> Show Bytecode outline,就会在侧边窗口中显示这个类的字节码(Bytecode)和Asm代码(ASMified),点击ASMified栏目就会显示这个类的Asm码,例如下图就是Person接口的通过插件生成的Asm代码:

{% asset_img plugin3.png plugin %}
可以看到,使用ClassWriter来生成Person接口。

3、转换一个类

ClassReader可以用来读取一个类,ClassVisitor可以用来访问一个类,ClassWirter可以生成一个类,所以当把它们三个组合在一起时,我们可以把class字节码通过ClassReader读取,把读取到的class字节码通过扩展的ClassVisitor转换,转换后,再通过ClassWirter重新生成这个类,就可以达到转换一个类的目的,下面我们把前面的OuterClass类的注解通过转换移除掉,首先自定义一个ClassVisitor,如下:

public class RemoveAnnotationClassVisitor extends ClassVisitor implements Opcodes {

    public RemoveAnnotationClassVisitor(ClassVisitor classVisitor) {
        super(ASM7, classVisitor);
    }

    @Override
    public AnnotationVisitor visitAnnotation(String descriptor, boolean visible) {
      //返回null
      return null;
    }
}
复制代码

这里我只重写了ClassVisitor的visitAnnotation方法,在visitAnnotation方法中返回null,这样调用者就无法使用返回的AnnotationVisitor生成类的注解,然后使用这个RemoveAnnotationClassVisitor,如下:

public static void main(String[] args) throws IOException {
  	//读取OuterClass类的字节码到ClassReader
		ClassReader classReader = new ClassReader(OuterClass.class.getName());
  	//定义用于生成类的ClassWriter
  	ClassWriter classWriter = new ClassWriter(0);
    //把ClassWriter传进RemoveAnnotationClassVisitor的构造中
  	RemoveAnnotationClassVisitor removeAnnotationClassVisitor = new RemoveAnnotationClassVisitor(classWriter);
    //在ClassReader的accept方法中传入RemoveAnnotationClassVisitor实例,开启访问
 	  classReader.accept(removeAnnotationClassVisitor, 0);
    //最终使用ClassWriter的toByteArray方法返回转换后的OuterClass类的字节数组
  	byte[] bytes = classWriter.toByteArray();
}
复制代码

上面这段代码只是把前面所讲的读取、访问、生成一个类的知识结合在一起,ClassVisitor的构造可以传进一个ClassVisitor,从而代理传进的ClassVisitor,而ClassWriter是继承自ClassVisitor的,所以RemoveAnnotationClassVisitor代理了ClassWriter,RemoveAnnotationClassVisitor把OuterClass转换完后就交给了ClassWriter,最终我们可以通过ClassWriter的toByteArray方法返回转换后的OuterClass类的字节数组。

上面是只有简单的一个ClassVisitor进行转换的代码,如果我们把它扩展,我们还可以定义RemoveMethodClassVisitor、AddFieldClassVisitor等多个具有不同功能的ClassVisitor,然后把所有的ClassVisitor串成一条转换链,把ClassReader想象成头,ClassWriter想象成尾,中间是一系列的ClassVisitor,ClassReader把读取到的class字节码经过一系列的ClassVisitor转换后到达ClassWriter,最终被ClassWriter生成新的class,这个过程如图:

{% asset_img plugin4.png plugin %}
Asm的入门知识就讲解到这里,如果想要了解更多关于Asm的知识请查阅开头给出的官方教程,下面我们来学习Transform相关知识。

Transform

官网:Transform

Transform是android gradle api中的一部分,它可以在android项目的.class文件编译为.dex文件之前,得到所有的.class文件,然后我们可以在Transform中对所有的.class文件进行处理,所以Transform提供了一种可以让我们得到android项目的字节码的能力,如图红色标志的位置为Transform的作用点:

{% asset_img plugin5.png plugin %}
上图就是android打包流程的一部分,而android的打包流程是交给android gradle plugin完成的,所以如果我们想要自定义Transform,必须要注入到android gradle plugin中才能产生效果,而plugin的执行单元是Task,但Transform并不是Task,那么Transform是怎么被执行的呢?android gradle plugin会为每一个Transform创建对应的TransformTask,由相应的TransformTask执行相应的Transform。

接下来我们来介绍Transform,首先我们需要在build.gradle中引入Transform,如下:

dependencies {
   	//引用android gradle api, 里面包含transform api
    implementation 'com.android.tools.build:gradle:4.0.0'
}
复制代码

因为transform api是android gradle api的一部分,所以我们引入android gradle api就行,自定义一个名为MyTransform的Transform,如下:

public class MyTransform extends Transform {

    @Override
    public String getName() {
        //用来生成TransformTask的名称
        return "MyTransform";
    }

    @Override
    public Set<QualifiedContent.ContentType> getInputTypes() {
        //输入类型
        return TransformManager.CONTENT_CLASS;
    }

    @Override
    public Set<? super QualifiedContent.Scope> getScopes() {
        //输入的作用域
        return TransformManager.SCOPE_FULL_PROJECT;
    }
  
   @Override
    public boolean isIncremental() {
        //是否开启增量编译
        return false;
    }
  
    @Override
    public void transform(TransformInvocation transformInvocation){
        //在这里处理class文件
    }
}
复制代码

Transform是一个抽象类,所以它会强制要求我们实现几个方法,还要重写transform方法,下面分别讲解这几个方法的含义:

1、getName方法

前面讲过android gradle plugin会为每一个Transform创建一个对应的TransformTask,而创建的TransformTask的名称一般的格式为transformXX1WithXX2ForXX3,其中XX1是inputType类型,XX2的值就是getName方法的返回值,而XX3的值就是当前构建环境的Build Variants,例如Debug、Release等,所以如果你自定义的的Transform名为MyTransform,Build Variants为Debug,inputType为Class文件,那么该Transform对应的Task名为transformClassesWithMyTransformForDebug。

2、getInputTypes和getScopes方法

getInputTypes方法和getScopes方法都返回一个Set集合,其中集合的元素类型分别为ContentType接口和Scope枚举,在Transform中,ContentType表示Transform输入的类型Scope表示Transform输入的作用域,Transform从ContentType和Scope这两个维度来过滤Transform的输入,某个输入只有同时满足了getInputTypes方法返回的ContentType集合和getScopes方法返回的Scope集合,才会被Transform消费。

在Transform中,主要有两种类型的输入,它们分别为CLASSES和RESOURCES,以实现了ContentType接口的枚举DefaultContentType表示,各枚举含义如下:

DefaultContentType含义
CLASSES表示在jar或文件夹中的.class文件
RESOURCES表示标准的java源文件

同理,在Transform中,输入的作用域也以枚举Scope表示,主要有PROJECT、SUB_PROJECTS、EXTERNAL_LIBRARIES、TESTED_CODE、PROVIDED_ONLY这五种作用域,各枚举含义如下:

Scope含义
PROJECT只处理当前项目
SUB_PROJECTS只处理当前项目的子项目
EXTERNAL_LIBRARIES只处理当前项目的外部依赖库
TESTED_CODE只处理当前项目构建环境的测试代码
PROVIDED_ONLY只处理当前项目使用provided-only依赖的库

ContentType和Scope都可以分别进行组合,已Set集合的形式返回,在TransformManager类中定义了一些我们常用的组合,我们可以直接使用,如MyTransform的ContentType为CONTENT_CLASS, Scope为SCOPE_FULL_PROJECT,定义如下:

public class TransformManager extends FilterableStreamCollection {
  
      public static final Set<ContentType> CONTENT_CLASS = ImmutableSet.of(CLASSES);
  		
      public static final Set<ScopeType> SCOPE_FULL_PROJECT = ImmutableSet.of(Scope.PROJECT, Scope.SUB_PROJECTS, Scope.EXTERNAL_LIBRARIES);
  
  	 //...还有其他很多组合
}
复制代码

可以看到CONTENT_CLASS由CLASSES组成,SCOPE_FULL_PROJECT由PROJECT、SUB_PROJECTS、EXTERNAL_LIBRARIES组成,所以MyTransform只会处理来自当前项目(包括子项目)和外部依赖库的.class文件输入。

3、isIncremental方法

isIncremental方法的返回值表示当前Transform是否支持增量编译,返回true表示支持,其实在Gradle中只有Task才有增量编译这一说,Transform最终会被TransformTask执行,所以Transform是依赖Task来实现增量编译的,Gradle Task通过检测它的输入与输出来实现增量编译:当检测到输入有文件changed时,Gradle判定本次编译为增量编译,Task内部根据changed文件做增量输出,即只对changed文件产生输出;当检测到输入与上一次输入没有发生任何changed时,Gradle判定本次编译UP-TO-DATA,可以跳过执行;当检测到输出被deleted时,Gradle判定本次编译为全量编译,会触发该Task的全量输出,即对所有输入文件产生输出。

当Transform被判定为增量编译后,在transform方法中就可以根据输入文件的**Status**来处理每个输入的文件产生增量输出,Status也是一个枚举,各枚举含义如下:

Status含义
NOTCHANGED该文件自上次构建以来没有发生变化
ADDED该文件为新增文件
CHANGED该文件自上次构建以来发生变化(被修改)
REMOVED该文件已被删除

开启增量编译可以大大的提高Gradle的构建速度。

注意:如果你的isIncremental方法返回true,那么自定义的Transform的transform方法中必须提供对增量编译的支持,即根据Status来对输入的文件作出处理,否则增量编译是不生效的,这在后面的插件实现中可以看到如何提供对增量编译的支持。

4、transform方法

transform方法就是Transform中处理输入的地方,TransformTask执行时就是执行Transform的transform方法,transform方法的参数是TransfromInvocation,它包含的当前Transform的输入和输出信息,可以使用TransfromInvocation的getInputs方法来获取Transform的输入,使用TransformInvocation的getOutputProvider方法来生成Transform的输出,还可以通过TransfromInvocation的isIncremental方法的返回值判断本次transform是否是增量编译。

TransfromInvocation的getInputs方法返回一个元素类型为TransformInput的集合,其中TransformInput可以获取两种类型的输入,如下:

public interface TransformInput {
  	//getJarInputs方法返回JarInput集合
    Collection<JarInput> getJarInputs();
  
  	//getDirectoryInputs方法返回DirectoryInput集合
    Collection<DirectoryInput> getDirectoryInputs();
}
复制代码

两种类型的输入又抽象为JarInputDirectoryInput,JarInput代表输入为.Jar文件,DirectoryInput代表输入为文件夹类型,JarInput有一个getStatus方法来获取该jar文件的Status,而DirectoryInputgetChangedFiles方法来获取一个Map<File, Status>集合,所以可以遍历这个Map集合,然后根据File对应的Status来对File进行增量处理。

TransfromInvocation的getOutputProvider方法返回一个TransformOutputProvider,它可以用来创建Transform的输出位置,如下:

public interface TransformOutputProvider {
    //删除所有输出
    void deleteAll() throws IOException;

    //根据参数给的name、ContentType、Scope、Format来创建输出位置
    File getContentLocation(
            @NonNull String name,
            @NonNull Set<QualifiedContent.ContentType> types,
            @NonNull Set<? super QualifiedContent.Scope> scopes,
            @NonNull Format format);
}

复制代码

调用getContentLocation方法就可以创建一个输出位置并返回该位置代表的File实例,如果存在就直接返回,通过getContentLocation方法创建的输出位置一般位于**/app/build/intermediates/transforms/build variants/transform名称/目录下,其中build variants**就是当前的构建环境如debug、release等,Transform名称就是getName方法的返回值,例如在debug构建下MyTransform的输出位置就是/app/build/intermediates/transforms/debug/MyTransform/目录下,该目录下都是Transform输出的jar文件或文件夹,名称是以0、1、2、...递增的命名形式命名,调用deleteAll方法就可以把getContentLocation方法创建的输出位置下的所有文件删除掉。

所以如果不支持增量编译的话,transform方法里面一般会这样写:

 public void transform(TransformInvocation transformInvocation) throws IOException {
        //通过TransformInvocation的getInputs方法获取所有输入,是一个集合,TransformInput代表一个输入
        Collection<TransformInput> transformInputs = transformInvocation.getInputs();

        //通过TransformInvocation的getOutputProvider方法获取输出的提供者,通过TransformOutputProvider可以创建Transform的输出
        TransformOutputProvider outputProvider = transformInvocation.getOutputProvider();

        //遍历所有的输入,每一个输入里面包含jar和directory两种输入类型的文件集合
        for(TransformInput transformInput : transformInputs){
            Collection<JarInput> jarInputs = transformInput.getJarInputs();
            //遍历,处理jar文件
            for(JarInput jarInput : jarInputs){
                File dest = outputProvider.getContentLocation(
                        jarInput.getName(),
                        jarInput.getContentTypes(),
                        jarInput.getScopes(),
                        Format.JAR
                );
                //这里只是简单的把jar文件复制到输出位置
                FileUtils.copyFile(jarInput.getFile(), dest);
            }

            Collection<DirectoryInput> directoryInputs = transformInput.getDirectoryInputs();
            //遍历,处理文件夹
            for(DirectoryInput directoryInput : directoryInputs){
                File dest = outputProvider.getContentLocation(
                        directoryInput.getName(),
                        directoryInput.getContentTypes(),
                        directoryInput.getScopes(),
                        Format.DIRECTORY
                );
                //这里只是简单的把文件夹中的所有文件递归地复制到输出位置
                FileUtils.copyDirectory(directoryInput.getFile(), dest);
            }
        }
    }
复制代码

就是获取到输入,遍历输入中的所有JarInput和DirectoryInput,然后把相应的输入简单地重定向到输出位置中,在这过程中,我们还可以获取jar文件和文件夹中的class文件,对class文件进行修改后再进行重定向到输出,这就达到了在编译期间修改字节码的目的,这也是后面插件实现的核心。

每一个Transform的输出会作为下一个Transform的输入,这些Transform会被串行执行,如下:

{% asset_img plugin6.png plugin %}
现在对于Asm和Transform都有了一个大概的了解,就可以动手实现函数耗时检测插件。

插件实现

检测函数耗时很简单,只需要在每个方法的开头和结尾增加耗时检测的代码逻辑即可,例如:

protected void onCreate(Bundle savedInstanceState) {
  long startTime = System.currentTimeMillis();//start
  
  super.onCreate(savedInstanceState);
  
  long endTime = System.currentTimeMillis();//end
  long costTime = endTime - startTime;
  if(costTime > 100){
    StackTraceElement thisMethodStack = (new Exception()).getStackTrace()[0];//获得当前方法的StackTraceElement
    Log.e("TimeCost", String.format(
      "===> %s.%s(%s:%s)方法耗时 %d ms",
      thisMethodStack.getClassName(), //类的全限定名称
      thisMethodStack.getMethodName(),//方法名
      thisMethodStack.getFileName(),  //类文件名称
      thisMethodStack.getLineNumber(),//行号
      costTime                        //方法耗时
    	)
    );
  }
}
复制代码

我们不可能手动的替应用内的每个方法的开头结尾加上上述代码,应用内的方法太多了,所以我们需要Gradle插件替我们完成这重复的过程,在项目编译的过程中,通过Transform拿到项目中每个类的字节码,然后使用Asm对每个类的的每个方法的开头结尾增加上述函数耗时检测的字节码,如果你不知道自定义一个Gradle插件的步骤,请移步上一篇文章,我把Gradle插件的实现代码放在buildSrc目录下,整个项目的目录结构如下:

{% asset_img plugin7.png plugin %}
有关Plugin和Transform实现的代码放在com.example.plugin下,有关Asm实现的代码放在com.example.asm下。

1、自定义Plugin

自定义Plugin对应代码如下:

public class TimeCostPlugin implements Plugin<Project> {

    //当函数运行时间大于threshold阀值时判定为耗时函数,单位ms
    public static long sThreshold = 100L;
    //当package有值时,只打印package包内的耗时函数
    public static String sPackage = "";

    @Override
    public void apply(Project project) {
        try {
            //通过project实例注册一个名为time的扩展
            Time time = project.getExtensions().create("time", Time.class);
            //在project构建完成后获取time扩展中的赋值情况
            project.afterEvaluate(project1 -> {
                if(time.getThreshold() >= 0){
                    sThreshold = time.getThreshold();
                }
                if(time.getAppPackage().length() > 0){
                    sPackage = time.getAppPackage();
                }
            });
            //通过project实例获取android gradle plugin中的名为android的扩展实例
            AppExtension appExtension = (AppExtension) project.getExtensions().getByName("android");
            //调用android的扩展实例即appExtension的registerTransform方法往android gradle plugin中注册我们自定义的Transform
            appExtension.registerTransform(new TimeCostTransform());
        }catch (UnknownDomainObjectException e){
            e.printStackTrace();
        }
    }

    /**
     * 扩展对应的bean类
     */
    static class Time{

        private long mThreshold = -1;
        private String mPackage = "";

        public Time(){}

        public long getThreshold() {
            return mThreshold;
        }

        public void setThreshold(long threshold) {
            this.mThreshold = threshold;
        }

        public String getAppPackage() {
            return mPackage;
        }

        public void setAppPackage(String p) {
            this.mPackage = p;
        }
    }
}
复制代码

TimeCostPlugin做了两件事:

1、定义了一个名为time的扩展,扩展对应的bean类为Time类,通过这个扩展我们可以在build.gradle中配置我们的插件,在这里我定义了函数耗时阀值threshold和通过package过滤打印的函数,然后我们在app/build.gradle中就可以这样使用:

apply plugin: com.example.plugin.TimeCostPlugin
//函数耗时阀值为200ms,只对应用内的函数做插桩(排除第三方库)
time{
    threshold = 200
    filter = 'com.example.plugindemo'
}
复制代码

扩展属性的赋值情况要在project构建完毕后才能获取,所以注册了project的afterEvaluate回调,在里面获取time扩展属性的赋值情况。

2、把我们自定义的Transform注入到android gradle plugin中去,android gradle plugin的名为android的扩展对应的bean类为AppExtension类,AppExtension中有一个元素类型为Transform的List集合,我们调用registerTransform方法就是把TimeCostTransform放入到这个集合中,这个Transform集合会在android gradle plugin中被使用,android gradle plugin也注册了project的afterEvaluate回调,在回调中它会为每个Transform生成TransformTask.

2、自定义Transform

自定义Transform对应部分代码如下:

public class TimeCostTransform extends Transform {

    private static final String TAG = TimeCostTransform.class.getSimpleName();//类名

    @Override
    public String getName() {
        return TAG;
    }

    @Override
    public Set<QualifiedContent.ContentType> getInputTypes() {
        return TransformManager.CONTENT_CLASS;
    }

    @Override
    public Set<? super QualifiedContent.Scope> getScopes() {
        return TransformManager.SCOPE_FULL_PROJECT;
    }

    @Override
    public boolean isIncremental() {
        return true;
    }

    @Override
    public void transform(TransformInvocation transformInvocation) throws IOException {
        System.out.println("transform(), ---------------------------start------------------------------");

        Collection<TransformInput> transformInputs = transformInvocation.getInputs();
        TransformOutputProvider outputProvider = transformInvocation.getOutputProvider();
      
        //通过TransformInvocation的isIncremental方法判断本次Transform任务是否是增量,如果Transform的isIncremental方法返回false,TransformInvocation的isIncremental方法永远返回false
        boolean isIncremental = transformInvocation.isIncremental();

        System.out.println("transform(), isIncremental = " + isIncremental);

        //如果不是增量,就删除之前所有产生的输出,重头来过
        if(!isIncremental){
            outputProvider.deleteAll();
        }

        //遍历所有的输入,每一个输入里面包含jar和directory两种输入类型的文件集合
        for(TransformInput transformInput : transformInputs){
            Collection<JarInput> jarInputs = transformInput.getJarInputs();
            //遍历所有的jar文件输入
            for(JarInput jarInput : jarInputs){
                //判断本次Transform任务是否增量
                if(isIncremental){
                    //增量处理Jar文件
                    handleJarIncremental(jarInput, outputProvider);
                }else {
                    //非增量处理Jar文件
                    handleJar(jarInput, outputProvider);
                }
            }

            Collection<DirectoryInput> directoryInputs = transformInput.getDirectoryInputs();
            //遍历所有的directory文件输入
            for(DirectoryInput directoryInput : directoryInputs){
                //判断本次Transform任务是否增量
                if(isIncremental){
                    //增量处理目录文件
                    handleDirectoryIncremental(directoryInput, outputProvider);
                }else {
                    //非增量处理目录文件
                    handleDirectory(directoryInput, outputProvider);
                }
            }
        }

        System.out.println("transform(), ---------------------------end------------------------------");
    }

  //... 
}
复制代码

根据前面Transform的讲解,TimeCostTransform中每个方法的含义应该是比较好理解的了,其中最重要的就是transform方法,由于我在isIncremental方法返回了true表示TimeCostTransform支持增量编译,所以就需要在transform方法中需要根据是否是增量编译分别做出全量处理和增量处理,由于jar文件的处理和directory文件的处理雷同,下面就以jar文件的处理为例讲解,对于directory文件的处理可以查看文末源码链接:

1、handleJar方法,全量处理jar文件输入,产生新的输出:

private void handleJar(JarInput jarInput, TransformOutputProvider outputProvider) throws IOException {
  //获取输入的jar文件
  File srcJar = jarInput.getFile();
  //使用TransformOutputProvider的getContentLocation方法根据输入构造输出位置
  File destJar = outputProvider.getContentLocation(
    jarInput.getName(),
    jarInput.getContentTypes(),
    jarInput.getScopes(),
    Format.JAR
  );
  //遍历srcJar的所有内容, 在遍历的过程中把srcJar中的内容一条一条地复制到destJar
  //如果发现这个内容条目是class文件,就把它通过asm修改后再复制到destJar中
  foreachJarWithTransform(srcJar, destJar);
}
复制代码

handleJar方法中确定输入输出然后调用foreachJarWithTransform方法,如下:

private void foreachJarWithTransform(File srcJar, File destJar) throws IOException {
  try(
    JarFile srcJarFile = new JarFile(srcJar);
    JarOutputStream destJarFileOs = new JarOutputStream(new FileOutputStream(destJar))
  ){
    Enumeration<JarEntry> enumeration = srcJarFile.entries();
    //遍历srcJar中的每一条条目
    while (enumeration.hasMoreElements()){
      JarEntry entry = enumeration.nextElement();
      try(
        //获取每一条条目的输入流
        InputStream entryIs = srcJarFile.getInputStream(entry)
      ){
        destJarFileOs.putNextEntry(new JarEntry(entry.getName()));
        if(entry.getName().endsWith(".class")){//如果是class文件
          //通过asm修改源class文件
          ClassReader classReader = new ClassReader(entryIs);
          ClassWriter classWriter = new ClassWriter(0);
          TimeCostClassVisitor timeCostClassVisitor = new TimeCostClassVisitor(classWriter);
          classReader.accept(timeCostClassVisitor, ClassReader.EXPAND_FRAMES);
          //然后把修改后的class文件复制到destJar中
          destJarFileOs.write(classWriter.toByteArray());
        }else {//如果不是class文件
          //原封不动地复制到destJar中
          destJarFileOs.write(IOUtils.toByteArray(entryIs));
        }
        destJarFileOs.closeEntry();
      }
    }
  }
}
复制代码

由于该输入是jar文件,而jar文件本质是一个zip文件,所以foreachJarWithTransform中就像在解压这个jar文件,然后遍历解压后的jar文件中的所有文件,通过后缀名判断该文件是否是.class文件,如果是.class文件就通过asm处理后输出,如果不是就是原封不动地复制到输出中去,逻辑还是很简单的,关于asm的处理在后面再讲。

2、handleJarIncremental方法, 增量处理jar文件输入, 可能产生新的输出:

private void handleJarIncremental(JarInput jarInput, TransformOutputProvider outputProvider) throws IOException {
  //获取输入文件的状态
  Status status = jarInput.getStatus();
  //根据文件的Status做出不同的操作
  switch (status){
    case ADDED:
    case CHANGED:
      handleJar(jarInput, outputProvider);
      break;
    case REMOVED:
      //删除所有输出
      outputProvider.deleteAll();
      break;
    case NOTCHANGED:
      //do nothing
      break;
    default:
  }
}
复制代码

理解了前面handleJar方法的全量处理,那么handleJarIncremental方法中的增量处理就很好理解了,其实就是根据输入的jar文件的Status来做出不同处理,对于ADDED和CHANGED都判定为changed文件,只对changed文件做处理,所以直接调用handleJar方法处理就行,对于REMOVED表示输入被删除了,那么就删除对应的输出,对于NOTCHANGED表示输入没有变化,不做处理,跳过。

3、asm处理class文件

前面transform方法中当判定为某个文件为class文件后就使用asm处理class文件,如下:

if(entry.getName().endsWith(".class")){//如果是class文件
  //通过asm修改源class文件
  ClassReader classReader = new ClassReader(entryIs);
  ClassWriter classWriter = new ClassWriter(0);
  TimeCostClassVisitor timeCostClassVisitor = new TimeCostClassVisitor(classWriter);
  classReader.accept(timeCostClassVisitor, ClassReader.EXPAND_FRAMES);
  //然后把修改后的class文件复制到destJar中
  destJarFileOs.write(classWriter.toByteArray());
}
复制代码

根据前面asm的讲解,这是使用asm转换一个类的步骤,首先使用ClassReader读取这个class文件,然后调用ClassReader的accept方法使用TimeCostClassVisitor开启对class文件的访问,最终通过ClassWriter的toByteArray方法获取转换后的class字节流,所以对class文件修改的逻辑都在TimeCostClassVisitor中,如下:

public class TimeCostClassVisitor extends ClassVisitor implements Opcodes {

    private String mPackage;//包名
    private String mCurClassName;//当前访问的类的全限定名
    private boolean isExcludeOtherPackage;//是否排除不属于package的类

    public TimeCostClassVisitor(ClassVisitor classVisitor) {
        super(ASM7, classVisitor);
        mPackage = TimeCostPlugin.sPackage;
        if(mPackage.length() > 0){
            mPackage = mPackage.replace(".", "/");
        }
        isExcludeOtherPackage = mPackage.length() > 0;
    }

    @Override
    public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
        super.visit(version, access, name, signature, superName, interfaces);
        mCurClassName = name;
    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) {
        MethodVisitor methodVisitor = super.visitMethod(access, name, descriptor, signature, exceptions);
        if(isExcludeOtherPackage){
           //如果该方法对应的类在package中就处理
            if(mCurClassName.startsWith(mPackage) && !"<init>".equals(name)){
                return new TimeCostMethodVisitor(methodVisitor, access, descriptor);
            }
        }else {
            if(!"<init>".equals(name)){
                return new TimeCostMethodVisitor(methodVisitor, access, descriptor);
            }
        }
        return methodVisitor;
    }
}
复制代码

TimeCostClassVisitor继承自ClassVisitor,因为我们只需要修改class文件中的方法,所以只重写了ClassVisitor的visit方法和visitMethod方法,其中visit方法中获取了当前访问的类的全限定名,它在visitMethod方法中与TimeCostPlugin扩展获取的package包名结合判定这个类的方法是否需要被过滤掉,如果这个类不属于package中的类,那么就不对这个类的class文件的方法做修改,跳过,如果这个类属于package中的类,就返回TimeCostMethodVisitor,在TimeCostMethodVisitor中修改class文件的方法,所以对于class文件中方法的修改的逻辑都在TimeCostMethodVisitor中,如下:

class TimeCostMethodVisitor extends LocalVariablesSorter implements Opcodes {

  //局部变量
  int startTime, endTime, costTime, thisMethodStack;

  public TimeCostMethodVisitor(MethodVisitor methodVisitor, int access, String desc) {
    super(ASM7, access, desc, methodVisitor);
  }

  @Override
  public void visitCode() {
    super.visitCode();
    //...方法开头
    //long startTime = System.currentTimeMillis();
  }

  @Override
  public void visitInsn(int opcode) {
    if(opcode == RETURN){
      //...方法结尾
      //long endTime = System.currentTimeMillis();
      //long costTime = endTime - startTime;
      //if(costTime > 100){
      //  StackTraceElement thisMethodStack = (new Exception()).getStackTrace()[0];//获得当前方法的StackTraceElement
     //   Log.e("TimeCost", String.format(
     //     "===> %s.%s(%s:%s)方法耗时 %d ms",
     //     thisMethodStack.getClassName(), //类的全限定名称
     //     thisMethodStack.getMethodName(),//方法名
     //     thisMethodStack.getFileName(),  //类文件名称
     //     thisMethodStack.getLineNumber(),//行号
     //     costTime                        //方法耗时
     //   )
     //       );
     //}
    }
    super.visitInsn(opcode);
  }
}
复制代码

我们需要做的就是在方法前后插入函数耗时检测逻辑的代码,而visitCode方法是开始生成方法字节码的时候调用,即方法开始时调用,而visitInsn方法在访问RETURN指令时就是表示访问到方法的return语句,即方法正常结束时调用,所以我们只需要在上述地方加入函数耗时检测逻辑的asm代码即可,asm会自动的替我们把asm代码转换为字节码,这样最终生成的方法字节码就会包含我们的函数耗时检测逻辑的字节码,TimeCostMethodVisitor继承自LocalVariablesSorter,而LocalVariablesSorter继承自MethodVisitor,LocalVariablesSorter扩展了MethodVisitor,使得我们很方便的在MethodVisitor的visitXX方法中通过asm代码使用局部变量,如:startTime、 endTime、 costTime、thisMethodStack。

那么我们可以通过前面介绍的ASM插件生成函数耗时检测的asm代码,如下:

{% asset_img plugin8.png plugin %}
由于生成的asm代码篇幅太长截图不完全,去除onCreate方法头、结尾和super.onCreate(savedInstanceState)这句代码的asm代码,剩下的就属于函数耗时检测逻辑的asm代码,我做了一些精简,把一些无用的visitLabel、visitLineNumber去掉,然后把它复制到TimeCostMethodVisitor中,如下:

class TimeCostMethodVisitor extends LocalVariablesSorter implements Opcodes {

    //局部变量
    int startTime, endTime, costTime, thisMethodStack;

    public TimeCostMethodVisitor(MethodVisitor methodVisitor, int access, String desc) {
        super(ASM7, access, desc, methodVisitor);
    }

    @Override
    public void visitCode() {
        super.visitCode();
        //long startTime = System.currentTimeMillis();
        mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
        startTime = newLocal(Type.LONG_TYPE);
        mv.visitVarInsn(LSTORE, startTime);
    }

    @Override
    public void visitInsn(int opcode) {
        if(opcode == RETURN){
            //long endTime = System.currentTimeMillis();
            mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
            endTime = newLocal(Type.LONG_TYPE);
            mv.visitVarInsn(LSTORE, endTime);

            //long costTime = endTime - startTime;
            mv.visitVarInsn(LLOAD, endTime);
            mv.visitVarInsn(LLOAD, startTime);
            mv.visitInsn(LSUB);
            costTime = newLocal(Type.LONG_TYPE);
            mv.visitVarInsn(LSTORE, costTime);

            //判断costTime是否大于sThreshold
            mv.visitVarInsn(LLOAD, costTime);
            mv.visitLdcInsn(new Long(TimeCostPlugin.sThreshold));//阀值由TimeCostPlugin的扩展属性threshold控制
            mv.visitInsn(LCMP);

            //if costTime <= sThreshold,就跳到end标记处,否则继续往下执行
            Label end = new Label();
            mv.visitJumpInsn(IFLE, end);

            //StackTraceElement thisMethodStack = (new Exception()).getStackTrace()[0]
            mv.visitTypeInsn(NEW, "java/lang/Exception");
            mv.visitInsn(DUP);
            mv.visitMethodInsn(INVOKESPECIAL, "java/lang/Exception", "<init>", "()V", false);
            mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/Exception", "getStackTrace", "()[Ljava/lang/StackTraceElement;", false);
            mv.visitInsn(ICONST_0);
            mv.visitInsn(AALOAD);
            thisMethodStack = newLocal(Type.getType(StackTraceElement.class));
            mv.visitVarInsn(ASTORE, thisMethodStack);

            //Log.e("rain", String.format("===> %s.%s(%s:%s)方法耗时 %d ms", thisMethodStack.getClassName(), thisMethodStack.getMethodName(),thisMethodStack.getFileName(),thisMethodStack.getLineNumber(),costTime));
            mv.visitLdcInsn("TimeCost");
            mv.visitLdcInsn("===> %s.%s(%s:%s)\u65b9\u6cd5\u8017\u65f6 %d ms");
            mv.visitInsn(ICONST_5);
            mv.visitTypeInsn(ANEWARRAY, "java/lang/Object");
            mv.visitInsn(DUP);
            mv.visitInsn(ICONST_0);
            mv.visitVarInsn(ALOAD, thisMethodStack);
            mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StackTraceElement", "getClassName", "()Ljava/lang/String;", false);
            mv.visitInsn(AASTORE);
            mv.visitInsn(DUP);
            mv.visitInsn(ICONST_1);
            mv.visitVarInsn(ALOAD, thisMethodStack);
            mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StackTraceElement", "getMethodName", "()Ljava/lang/String;", false);
            mv.visitInsn(AASTORE);
            mv.visitInsn(DUP);
            mv.visitInsn(ICONST_2);
            mv.visitVarInsn(ALOAD, thisMethodStack);
            mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StackTraceElement", "getFileName", "()Ljava/lang/String;", false);
            mv.visitInsn(AASTORE);
            mv.visitInsn(DUP);
            mv.visitInsn(ICONST_3);
            mv.visitVarInsn(ALOAD, thisMethodStack);
            mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StackTraceElement", "getLineNumber", "()I", false);
            mv.visitMethodInsn(INVOKESTATIC, "java/lang/Integer", "valueOf", "(I)Ljava/lang/Integer;", false);
            mv.visitInsn(AASTORE);
            mv.visitInsn(DUP);
            mv.visitInsn(ICONST_4);
            mv.visitVarInsn(LLOAD, costTime);
            mv.visitMethodInsn(INVOKESTATIC, "java/lang/Long", "valueOf", "(J)Ljava/lang/Long;", false);
            mv.visitInsn(AASTORE);
            mv.visitMethodInsn(INVOKESTATIC, "java/lang/String", "format", "(Ljava/lang/String;[Ljava/lang/Object;)Ljava/lang/String;", false);
            mv.visitMethodInsn(INVOKESTATIC, "android/util/Log", "e", "(Ljava/lang/String;Ljava/lang/String;)I", false);
            mv.visitInsn(POP);

            //end标记处,即方法的末尾
            mv.visitLabel(end);
        }
        super.visitInsn(opcode);
    }
}
复制代码

上面每一句注释都表示了注释下面asm代码的含义,对于局部变量使用了LocalVariablesSorter的newLocal方法生成,其实如果你仔细观察生成的asm代码,它们还是很有规律的,使用MethodVisitor的visitXX方法生成方法字节码时它们的调用顺序如下(忽略注解注释):

[visitCode]
[visitLabel | visitLineNumber | visitFrame | visitXXInsn | visitLocalVariable | visitTryCatchBlock]
[visitMax]
visitEnd

//其中[]表示可选,|表示平级
复制代码

与ClassVisitor类似,但以visitCode开头,表示开始生成方法体字节码,中间调用visitLabel、visitXXInsn等生成方法体字节码,然后以一个visitMax结尾,最终一定要调用一个visitEnd结束,如果这个方法没有方法体,那么调用一个visitEnd就行。

到这里这个函数耗时检测插件就完成了,使用方法就和平时使用gradle插件一样。

结语

这个gradle插件还是很简陋,还可以继续扩展它,例如耗时阀值支持ns、发现耗时函数时把函数的调用栈打印出来等,不过本文的目的还是主要学习自定义个gradle插件的过程,还有asm和transform知识, 其实android gradle api从3.6开始很多apk打包时用到的内置transform基本都变成了直接使用Task来实现,如DesugarTransform -> DesugarTask, MergeClassesTransform -> MergeClassesTask等,可能是为了提高构建效率,这也说明了transform本质是依赖task来完成的,它并不是一个新东西,它只是android gradle api提供给外部,方便外部操作字节码的工具,同时android gradle api中也有很多apk构建时用的的插件,如AppPluginLibrayPlugin等,我们编写gradle插件时也可以选择一个作为参考。

以上就是本文的全部内容!

本文源码地址

参考资料:

Android Gradle Plugin打包Apk过程中的Transform API

一起玩转Android项目中的字节码

一文读懂 AOP

Android Gradle Plugin 主要流程分析

文章分类
Android
文章标签