深入理解JVM(三)——类加载机制

Java虚拟机把描述类的数据从Class文件加载到内存,并对数据进行校验、转换解析和初始化,最终形成可以被虚拟机直接使用的Java类型,这个过程被称作虚拟机的类加载机制。——《深入理解Java虚拟机》

类加载的时机

一个类型从被加载到虚拟机内存中开始,到卸载出内存为止,它的整个生命周期将会经历加载 (Loading)验证(Verification)准备(Preparation)解析(Resolution)初始化(Initializ ation)使用(Using)卸载(Unloading)七个阶段,其中验证、准备、解析三个部分统称为连接(Linking)。这七个阶段的发生顺序如下图所示。

类加载流程

需要注意的是,在上述7个阶段中,只有加载、验证、准备、初始化和卸载这5个阶段的顺序是确定的,类的加载过程必须按照这种顺序按部就班地开始,并且是互相交叉地混合式进行。解析阶段在某些情况下可以在初始化阶段之后再开始,直接是为了支持Java语言的运行时绑定(也称为动态绑定或晚期绑定)。

那么什么时候会触发这个流程呢?《Java虚拟机规范》中并没有进行强制约束,这点可以交给虚拟机的具体实现来自由把握。不过,规范中严格规定了有且只有以下六种情况必须立即对类进行“初始化”:

  1. 遇到new、getstatic、putstatic或invokestatic这四条字节码指令时,如果类型没有进行过初始 化,则需要先触发其初始化阶段。能够生成这四条指令的典型Java代码场景有:
    • 使用new关键字实例化对象时。
    • 读取或设置一个类型的静态字段(被final修饰、已在编译期把结果放入常量池的静态字段除外)时。
    • 调用一个类型的静态方法时。
  2. 使用java.lang.reflect包的方法对类型进行反射调用的时候,如果类型没有进行过初始化,则需要先触发其初始化。
  3. 当初始化类的时候,如果发现其父类还没有进行过初始化,则需要先触发其父类的初始化。
  4. 当虚拟机启动时,用户需要指定一个要执行的主类(包含main()方法的那个类),虚拟机会先初始化这个主类。
  5. 当使用JDK 7新加入的动态语言支持时,如果一个java.lang.invoke.MethodHandle实例最后的解析结果为REF_getStatic、REF_p utStatic、REF_invokeStatic、REF_newInvokeSpecial四种类型的方法句柄,并且这个方法句柄对应的类没有进行过初始化,则需要先触发其初始化。
  6. 当一个接口中定义了JDK 8新加入的默认方法(被default关键字修饰的接口方法)时,如果有这个接口的实现类发生了初始化,那该接口要在其之前被初始化。

这六种场景中的行为称为对一个类型进行主动引用,那么对应的就存在被动引用了,被动引用时将不会触发初始化过程。例如有三个被动引用的场景:

  1. 通过子类引用父类的静态字段,不会导致子类初始化。
  2. 通过数组定义来引用类,不会触发此类的初始化。
  3. 常量在编译阶段会存入调用类的常量池中,本质上没有直接引用到定义常量的类,因此不会触发定义常量的类的初始化。

类加载的过程

接下来我们详细了解下Java虚拟机中类加载的全过程,即加载、验证、准备、解析和初始化这五个阶段所执行的具体动作。

加载

“加载”(Loading)阶段是整个“类加载”(Class Loading)过程中的第一个阶段。

在加载阶段,Java虚拟机需要完成以下三件事:

  1. 通过一个类的全限定名来获取定义此类的二进制字节流。
  2. 将这个字节流所代表的静态存储结构转化为方法区的运行时数据结构。
  3. 在内存中生成一个代表这个类的 java.lang.Class 对象,作为方法区这个类的各种数据的访问入口。

《Java虚拟机规范》对这三点要求其实是很灵活的,例如第一条规则,它并没有规定二进制字节流必须得从某个Class文件中获取,确切地是说根本没有指明要从哪里获取、如何获取。仅仅这一点就能玩出很多花样,例如:

  • 从Zip包中获取,例如jar包、aar包、war包等。
  • 从网络中获取。
  • 运行时计算生成,这种场景使用的最多就是动态代理,例如我们Android开发者最熟悉的JW大佬的Retrofit,它通过动态代理来生成一个“*$Proxy”的代理类的二进制字节流,通过这个类来真正发起网络请求。
  • 由其他文件生成,典型场景是JSP应用,由JSP文件生成对应的Class文件。
  • 可以从加密文件中获取,这是典型的防Class文件被反编译的保护措施,通过加载时解密Class文件来保障程序运行逻辑不被窥探。
  • … …

相对于类加载过程的其他阶段,非数组类型的加载阶段(准确地说,是加载阶段中获取类的二进制字节流的动作)是开发人员可控性最强的阶段。加载阶段既可以使用Java虚拟机里内置的引导类加载器来完成,也可以由用户自定义的类加载器去完成,开发人员通过定义自己的类加载器去控制字节 流的获取方式(重写一个类加载器的findClass()或loadClass()方法),实现根据自己的想法来赋予应用程序获取运行代码的动态性。

对于数组类的话,数组类的元素类型本身也需要进行类加载,不过数组类本身并不通过类加载器创建,而是直接由Java虚拟机在内存中动态构造出来。

加载阶段结束后,Java虚拟机外部的二进制字节流就按照虚拟机所设定的格式存储在方法区之中了,然后会在Java堆内存中实例化一个java.lang.Class类的对象, 这个对象将作为程序访问方法区中的类型数据的外部接口,也是我们能够使用反射的主要原理。

验证

验证是连接阶段的第一步,这一阶段的目的是确保Class文件的字节流中包含的信息符合《Java虚拟机规范》的全部约束要求,保证这些信息被当作代码运行后不会危害虚拟机自身的安全。如果虚拟机验证到输入的字节流如不符合Class文件格式的约束,就应当抛出一个java.lang.VerifyError异常或其子类异常,此阶段大致上会完成下面四个阶段的检验动作:文件格式验证元数据验证字节码验证符号引用验证

  • 文件格式验证:验证字节流是否符合Class文件格式的规范,并且能被当前版本的虚拟机处理。
  • 元数据验证:对字节码描述的信息进行语义分析,以保证其描述的信息符合《Java语言规范》的要求。
  • 字节码验证:通过数据流分析和控制流分析,确定程序语义是合法的、符合逻辑的。
  • 符号引用验证:此阶段发生在虚拟机将符号引用转化为直接引用的时候,这个转化动作将在连接的第三阶段——解析阶段中发生。。符号引用验证可以看作是对类自身以外(常量池中的各种符号引用)的各类信息进行匹配性校验,通俗来说就是,该类是否缺少或者被禁止访问它依赖的某些外部 类、方法、字段等资源。

准备

准备阶段是正式为类中定义的变量(即静态变量,被static修饰的变量)分配内存并设置类变量初始值的阶段。这里需要着重强调的是,首先这时候进行内存分配的仅包括类变量,而不包括实例变量,实例变量将会在对象实例化时随着对象一起分配在Java堆中。这里的初始化通常情况下指的是初始化为”0值“,例如int的0值为0,long为0L,boolean为false,引用类型为null等。

1
2
3
4
public static int intValue = 123;   // 初始化为0
public static long longValue = 123L; // 初始化为0L
public static boolean booleanValue = true; // 初始化为false
public static List<Int> value = new ArrayList<>(); // 初始化为null

上面提到在“通常情况”下初始值是零值,那言外之意是相对的会有某些“特殊情况”:如果类字段 的字段属性表中存在ConstantValue属性,那在准备阶段变量值就会被初始化为ConstantValue属性所指定 的初始值,假设上面类变量value的定义修改为:

1
public static final int value = 123;

编译时Javac将会为value生成ConstantValue属性,在准备阶段虚拟机就会根据ConstantValue的设置将value赋值为123。

解析

解析阶段是Java虚拟机将常量池内的符号引用替换为直接引用的过程,符号引用在 上篇文章讲解Class文件格式的时候已经出现过多次,在Class文件中它以CONSTANT_Class_infoCONSTANT_Fieldref_infoCONSTANT_Methodref_info等类型的常量出现,那解析阶段中所说的直接引用与符号引用又有什么关联呢?

  • 符号引用(Symbolic References):符号引用以一组符号来描述所引用的目标,符号可以是任何 形式的字面量,只要使用时能无歧义地定位到目标即可。符号引用与虚拟机实现的内存布局无关,引用的目标并不一定是已经加载到虚拟机内存当中的内容。各种虚拟机实现的内存布局可以各不相同,但是它们能接受的符号引用必须都是一致的,因为符号引用的字面量形式明确定义在《Java虚拟机规 范》的Class文件格式中。
  • 直接引用(Direct References):直接引用是可以直接指向目标的指针、相对偏移量或者是一个能间接定位到目标的句柄。直接引用是和虚拟机实现的内存布局直接相关的,同一个符号引用在不同虚拟机实例上翻译出来的直接引用一般不会相同。如果有了直接引用,那引用的目标必定已经在虚拟机的内存中存在。

《Java虚拟机规范》之中并未规定解析阶段发生的具体时间,只要求了在执行anewarray 、checkcast、getfield、getstatic、instanceof、invokedynamic、invokeinterface、invoke-special、 invokestatic、invokevirtual、ldc、ldc_w、ldc2_w、multianewarray、new、putfield和putstatic这17个用于操作符号引用的字节码指令之前,先对它们所使用的符号引用进行解析。所以虚拟机实现可以根据需要来自行判断,到底是在类被加载器加载时就对常量池中的符号引用进行解析,还是等到一个符号引用将要被使用前才去解析它。

解析动作主要针对类或接口、字段、类方法、接口方法、方法类型、方法句柄和调用点限定符这7类符号引用进行,分别对应于常量池的CONSTANT_Class_infoCONSTANT_Fieldref_infoCONSTANT_Methodref_infoCONSTANT_InterfaceMethodref_infoCONSTANT_MethodType_infoCONSTANT_MethodHandle_infoCONSTANT_Dynamic_infoCONSTANT_InvokeDynamic_info 8种常量类型。

1.类或接口的解析

假设当前代码所处的类为D,如果要把一个从未解析过的符号引用N解析为一个类或接口C的直接引用,那虚拟机完成整个解析的过程需要包括以下3个步骤:

  1. 如果C不是一个数组类型,那虚拟机将会把代表N的全限定名传递给D的类加载器去加载这个 类C。在加载过程中,由于元数据验证、字节码验证的需要,又可能触发其他相关类的加载动作,例如加载这个类的父类或实现的接口。
  2. 如果C是一个数组类型,并且数组的元素类型为对象,也就是N的描述符会是类
    似“ [Ljava/lang/Integer”的形式,那将会按照第一点的规则加载数组元素类型。如果N的描述符如前面所假设的形式,需要加载的元素类型就是“java.lang.Integer”,接着由虚拟机生成一个代表该数组维度和元素的数组对象。
  3. 如果上面两步没有出现任何异常,那么C在虚拟机中实际上已经成为一个有效的类或接口了, 但在解析完成前还要进行符号引用验证,确认D是否具备对C的访问权限。如果发现不具备访问权限,将抛出java.lang.IllegalAccessError异常。

2.字段解析

要解析一个未被解析过的字段符号引用,首先将会对字段表内class_index项中索引的CONSTANT_Class_info符号引用进行解析,也就是字段所属的类或接口的符号引用。如果解析成功完成,那把这个字段所属的类或接口用C表示,《Java虚拟机规范》要求按照如下步骤对C进行后续字段的搜索:

  1. 如果C本身就包含了简单名称和字段描述符都与目标相匹配的字段,则返回这个字段的直接引用,查找结束。
  2. 否则,如果在C中实现了接口,将会按照继承关系从下往上递归搜索各个接口和它的父接口, 如果接口中包含了简单名称和字段描述符都与目标相匹配的字段,则返回这个字段的直接引用,查找结束。
  3. 否则,如果C不是java.lang.Object的话,将会按照继承关系从下往上递归搜索其父类,如果在父类中包含了简单名称和字段描述符都与目标相匹配的字段,则返回这个字段的直接引用,查找结束。
  4. 否则,查找失败,抛出java.lang.NoSuchFieldError异常。

如果查找过程成功返回了引用,将会对这个字段进行权限验证,如果发现不具备对字段的访问权限,将抛出java.lang.IllegalAccessError异常。

3.方法解析

方法解析的第一个步骤与字段解析一样,也是需要先解析出方法表的class_index项中索引的方法所属的类或接口的符号引用,如果解析成功,那么我们依然用C表示这个类,接下来虚拟机将会按照如下步骤进行后续的方法搜索:

  1. 由于Class文件格式中类的方法和接口的方法符号引用的常量类型定义是分开的,如果在类的 方法表中发现class_index中索引的C是个接口的话,那就直接抛出java.lang.Incomp atibleClassChangeError 异常。
  2. 如果通过了第一步,在类C中查找是否有简单名称和描述符都与目标相匹配的方法,如果有则 返回这个方法的直接引用,查找结束。
  3. 否则,在类C的父类中递归查找是否有简单名称和描述符都与目标相匹配的方法,如果有则返回这个方法的直接引用,查找结束。
  4. 否则,在类C实现的接口列表及它们的父接口之中递归查找是否有简单名称和描述符都与目标相匹配的方法,如果存在匹配的方法,说明类C是一个抽象类,这时候查找结束,抛出 java.lang.AbstractMethodError异常。
  5. 否则,宣告方法查找失败,抛出java.lang.NoSuchMethodError。

最后,如果查找过程成功返回了直接引用,将会对这个方法进行权限验证,如果发现不具备对此方法的访问权限,将抛出java.lang.IllegalAccessError异常。

4.接口方法解析

接口方法也是需要先解析出接口方法表的class_index项中索引的方法所属的类或接口的符号引用,如果解析成功,依然用C表示这个接口,接下来虚拟机将会按照如下步骤进行后续的接口方法搜索:

  1. 与类的方法解析相反,如果在接口方法表中发现class_index中的索引C是个类而不是接口,那 么就直接抛出java.lang.IncompatibleClassChangeError异常。
  2. 否则,在接口C中查找是否有简单名称和描述符都与目标相匹配的方法,如果有则返回这个方法的直接引用,查找结束。
  3. 否则,在接口C的父接口中递归查找,直到java.lang.Object类(接口方法的查找范围也会包括Object类中的方法)为止,看是否有简单名称和描述符都与目标相匹配的方法,如果有则返回这个方法的直接引用,查找结束。
  4. 否则,宣告方法查找失败,抛出java.lang.NoSuchMethodError异常。

初始化

类的初始化阶段是类加载过程的最后一个步骤。在进行准备阶段时,变量已经赋过一次系统要求的初始零值,而在初始化阶段,则会根据程序员通过程序编码制定的主观计划去初始化类变量和其他资源。更直接的说,初始化阶段就是执行类构造器()方法的过程

  • ()方法是由编译器自动收集类中的所有类变量的赋值动作和静态语句块(static{}块)中的语句合并产生的,编译器收集的顺序是由语句在源文件中出现的顺序决定的,静态语句块中只能访问到定义在静态语句块之前的变量,定义在它之后的变量,在前面的静态语句块可以赋值,但是不能访问。
  • ()方法与类的构造函数(即在虚拟机视角中的实例构造器()方法)不同,它不需要显式地调用父类构造器,Java虚拟机会保证在子类的()方法执行前,父类的()方法已经执行完毕。因此在J ava虚拟机中第一个被执行的 ()方法的类型肯定是java.lang.Object 。
  • 由于父类的()方法先执行,也就意味着父类中定义的静态语句块要优先于子类的变量赋值操作。
  • ()方法对于类或接口来说并不是必需的,如果一个类中没有静态语句块,也没有对变量的赋值操作,那么编译器可以不为这个类生成()方法。
  • 接口中不能使用静态语句块,但仍然有变量初始化的赋值操作,因此接口与类一样都会生成 ()方法。但接口与类不同的是,执行接口的()方法不需要先执行父接口的()方法, 因为只有当父接口中定义的变量被使用时,父接口才会被初始化。此外,接口的实现类在初始化时也 一样不会执行接口的()方法。
  • Java虚拟机必须保证一个类的()方法在多线程环境中被正确地加锁同步,如果多个线程同时去初始化一个类,那么只会有其中一个线程去执行这个类的()方法,其他线程都需要阻塞等待,直到活动线程执行完毕()方法。如果在一个类的()方法中有耗时很长的操作,那就可能造成多个线程阻塞,不过在某个线程执行完()后,其他线程都不会再执行()方法。

类加载器

类加载流程中的“加载”阶段被放在了Java虚拟机外部实现,实现这个阶段的工具称为“类加载器(Class Loader)“

类与类加载器

类加载器虽然只用于实现类的加载动作,但它在Java程序中起到的作用却远超类加载阶段。对于任意一个类,都必须由加载它的类加载器和这个类本身一起共同确立其在Java虚拟机中的唯一性。通俗的讲,就是两个类是否”相等“的一个大前提是这两个类是由同一类加载器加载而来,不同类加载器加载出的Class对象一定不是同一个对象。

这里所指的“相等”,包括代表类的Class对象的equals()方法、isAssignableFrom()方法、isInstance()方法的返回结果,也包括了使用instanceof关键字做对象所属关系判定等各种情况。

双亲委派模型

站在Java虚拟机的角度来看,只存在两种不同的类加载器:一种是启动类加载器(Bootstrap ClassLoader),这个类加载器使用C++语言实现,是虚拟机自身的一部分;另外一种就是其他所有 的类加载器,这些类加载器都由Java语言实现,独立存在于虚拟机外部,并且全都继承自抽象类 java.lang.ClassLoader。

站在Java开发人员的角度来看,类加载器就应当划分得更细致一些。自JDK 1.2以来,Java一直保持着三层类加载器、双亲委派的类加载架构。这三层类加载器如下:

  • 启动类加载器(Bootstrap Class Loader):这个类加载器负责加载存放在\lib目录,或者被-Xbootclasspath参数所指定的路径中存放的,而且是Java虚拟机能够识别的(按照文件名识别,如rt .jar、tools.jar,名字不符合的类库即使放在lib目录中也不会被加载)类库加载到虚拟机的内存中。
  • 扩展类加载器(Extension Class Loader):这个类加载器是在类sun.misc.Launcher$ExtClassLoader中以Java代码的形式实现的。它负责加载\lib\ext目录中,或者被java.ext.dirs系统变量所指定的路径中所有的类库。
  • 应用程序类加载器(Application Class Loader):这个类加载器由sun.misc.Launcher$AppClassLoader来实现。由于应用程序类加载器是ClassLoader类中的getSystemClassLoader()方法的返回值,所以有些场合中也称它为“系统类加载器”。它负责加载用户类路径(ClassPath)上所有的类库,开发者同样可以直接在代码中使用这个类加载器。如果程序中没有自定义过自己的类加载器,一般情况下这个就是程序中默认的类加载器。

这些类加载器之间的协作关系通常情况下如下图所示:

双亲委派模型

这个模型被称为”双亲委派模型(Parents Delegation Model)“。双亲委派模型要求除了顶层的启动类加载器外,其余的类加载器都应有自己的父类加载器。不过这里类加载器之间的父子关系一般不是以继承(Inheritance)的关系来实现的,而是通常使用组合(Composition)关系来复用父加载器的代码。

双亲委派模型的工作过程是:如果一个类加载器收到了类加载的请求,它首先不会自己去尝试加载这个类,而是把这个请求委派给父类加载器去完成,每一个层次的类加载器都是如此,因此所有的加载请求最终都应该传送到最顶层的启动类加载器中,只有当父加载器反馈自己无法完成这个加载请求(它的搜索范围中没有找到所需的类)时,子加载器才会尝试自己去完成加载。

以类java.lang.Object为例,它存放在rt .jar之中,无论哪一个类加载器要加载这个类,最终都是委派给处于模型最顶端的启动类加载器进行加载,因此Object类在程序的各种类加载器环境中都能够保证是同一个类。

双亲委派模型对于保证Java程序的稳定运作极为重要,但它的实现却异常简单,用以实现双亲委派的代码只有短短十余行,全部集中在java.lang.ClassLoader的loadClass()方法之中,如下所示。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
protected Class<?> loadClass(String name, boolean resolve)
throws ClassNotFoundException
{
synchronized (getClassLoadingLock(name)) {
// 首先,检查请求的类是否已经被加载过了
Class<?> c = findLoadedClass(name);
if (c == null) {
long t0 = System.nanoTime();
try {
if (parent != null) {
// 委派父类加载器加载
c = parent.loadClass(name, false);
} else {
// 如果父类加载器为空
// 使用启动类加载器加载
c = findBootstrapClassOrNull(name);
}
} catch (ClassNotFoundException e) {
// 如果父类加载器抛出ClassNotFoundException
// 说明父类加载器无法完成加载请求
}

if (c == null) {
// 在父类加载器无法加载时
// 再调用本身的findClass方法来进行类加载
long t1 = System.nanoTime();
c = findClass(name);

// 统计
PerfCounter.getParentDelegationTime().addTime(t1 - t0);
PerfCounter.getFindClassTime().addElapsedTimeFrom(t1);
PerfCounter.getFindClasses().increment();
}
}
if (resolve) {
resolveClass(c);
}
return c;
}
}

这里要注意的是,实际开发中如果我们需要破坏双亲委派模型,那么我们就需要重写loadClass方法,否则应该重写findClass方法

Android中的类加载器

Android 和传统的 JVM 是一样的,也需要通过 ClassLoader 将目标类加载到内存,类加载器之间也符合双亲委派模型。但是在 Android 中,ClassLoader 的加载细节有略微的差别。

在 Android 虚拟机里是无法直接运行 .class 文件的,Android 会将所有的 .class 文件转换成一个 .dex 文件,并且 Android 将加载 .dex 文件的实现封装在 BaseDexClassLoader 中,而我们一般只使用它的两个子类:PathClassLoaderDexClassLoader

PathClassLoader

PathClassLoader 的源码中只有两个构造函数,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
/**
* @param dexPath 包含.dex文件的jar/apk文件路径
*/
public PathClassLoader(String dexPath, ClassLoader parent) {
super(dexPath, null, null, parent);
}
/**
* @param dexPath 包含.dex文件的jar/apk文件路径
* @param librarySearchPath C/C++ native库的路径
*/
public PathClassLoader(String dexPath, String librarySearchPath, ClassLoader parent) {
super(dexPath, null, librarySearchPath, parent);
}

PathClassLoader继承自BaseDexClassLoader,BaseDexClassLoader中dexPath受到限制,一般只能是已经安装应用的apk路径。不过PathClassLoader情况比较特殊:

  • 在Android 4.4以下版本时,PathClassLoader只能加载已安装到系统中的apk/dex文件。
  • Android 5.0~Android 8.0,PathClassLoader没有限制必须已安装的apk,并且PathClassLoader中optimizedDirectory固定为null,所以无法进行dex2oat操作,最后会直接加载原始dex,达到了禁用dex2oat以实现加载加速的效果。
  • Android 8.1或更高,此时DexClassLoader中optimizedDirectory同样固定传递null,oat输出目录在dex目录/oat/下,此时DexClassLoader与PathClassLoader相同。

当一个 App 被安装到手机后,apk 里面的 class.dex 中的 class 均是通过 PathClassLoader 来加载的,可以通过如下代码验证:

1
2
3
4
5
6
7
8
9
class MainActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val loader = MainActivity::class.java.classLoader
println(loader.toString())
}
}

打印结果如下:

打印结果

DexClassLoader

对比 PathClassLoader 在Android 4.4以下只能加载已经安装应用的 dex 或 apk 文件,DexClassLoader 则没有此限制,可以从 SD 卡上加载包含 class.dex 的 .jar 和 .apk 文件,这也是插件化和热修复的基础,在不需要安装应用的情况下,完成需要使用的 dex 的加载。

DexClassLoader 的源码里面只有一个构造方法,代码如下:

1
2
3
4
5
6
7
8
/**
* @param dexPath 包含 class.dex 的 apk、jar 文件路径 ,多个路径用文件分隔符(默认是“:”)分隔
* @param optimizedDirectory 用来缓存优化的 dex 文件的路径,即从 apk 或 jar 文件中提取出来的 dex 文件。该路径不可以为空,且应该是应用私有的,有读写权限的路径。
*/
public DexClassLoader(String dexPath, String optimizedDirectory,
String librarySearchPath, ClassLoader parent) {
super(dexPath, null, librarySearchPath, parent);
}

接下来我们尝试使用DexClassLoader来自定义一个类加载器实现热修复。

类加载器实践案例

自定义类加载器

我们尝试使用自己的类加载器来加载本地磁盘上的类文件。

首先创建一个测试类,并将其复制到磁盘的某一处,这里我创建了一个Test类,编译后将其复制到”~/Downloads”目录下。

1
2
3
4
5
class Test {
fun testPrint() {
println("This class is load from custom class loader.")
}
}

接下来,创建一个DiskClassLoader继承自ClassLoader,重写其findClass方法,如下所示。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
* 加载本地磁盘中的class文件
*/
class DiskClassLoader(private val filePath: String) : ClassLoader() {

override fun findClass(name: String?): Class<*> {
val newPath = "$filePath$name.class"
var classBytes: ByteArray? = null
val path: Path
try {
path = Paths.get(URI(newPath))
classBytes = Files.readAllBytes(path)
} catch (e: URISyntaxException) {
e.printStackTrace()
} catch (e: IOException) {
e.printStackTrace()
}
// 创建Class对象
return defineClass(name, classBytes, 0, classBytes?.size ?: 0)
}
}

接下来尝试使用这个类加载器:

1
2
3
4
5
6
7
8
9
10
11
12
val loader = DiskClassLoader("file:///User/sukaidev/Downloads/")
try {
val c = loader.loadClass("Test")
if (c != null) {
// 反射创建对象
val obj = c.newInstance()
// 反射调用testPrint()方法
c.getDeclaredMethod("testPrint").invoke(obj)
}
} catch (e: Exception) {
e.printStackTrace()
}

运行结果如下:

运行结果

类加载器成功加载了路径为”User/sukaidev/Downloads/Test.class”的文件。

热修复实践

创建项目

先来创建一个创建 Android 项目,名字随意,项目结构如下:

项目结构

ISay.java 是一个接口,内部只定义了一个方法 saySomething。

1
2
3
4
5
package com.sukaidev.dexclassloaderhotfix

interface ISay {
fun saySomething(): String
}

SayException.java 实现了 ISay 接口,但是在 saySomething 方法中,打印“Oops! Something went wrong.”来模拟一个线上的 bug。

1
2
3
4
5
6
7
package com.sukaidev.dexclassloaderhotfix

class SayException : ISay {
override fun saySomething(): String {
return "Oops! Something went wrong."
}
}

最后在 MainActivity.java 中,当点击 Button 的时候,将 saySomething 返回的内容通过 Toast 显示在屏幕上。

1
2
3
4
5
6
7
8
9
10
11
12
package com.sukaidev.dexclassloaderhotfix

class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val say: ISay = SayException()
findViewById<AppCompatButton>(R.id.btn).setOnClickListener {
Toast.makeText(this, say.saySomething(), Toast.LENGTH_SHORT).show()
}
}
}

点击按钮模拟线上报错,效果如下。

接下来尝试对其进行热修复。

创建热修复补丁

新建一个Java module用于制作热修复补丁,新建ISay和SayHotFix两个类,注意包名必须保持与上面一致。

1
2
3
4
5
package com.sukaidev.dexclassloaderhotfix

interface ISay {
fun saySomething(): String
}

SayHotFix 实现 ISay 接口,并在 saySomething 中返回了新的结果,用来模拟 bug 修复后的结果。

1
2
3
4
5
6
7
package com.sukaidev.dexclassloaderhotfix

class SayHotFix : ISay {
override fun saySomething(): String {
return "Everything is OK."
}
}

接下来只需要build一下项目,就会在模块的build/libs目录下生成jar包。

build生成jar包

这个hotfix.jar就是我们需要的补丁包了,但是光有jar包是不行的,DexClassLoader只能加载.dex类型的包,因此接下来通过dx工具将生成的hotfix.jar优化为dex文件。

dx工具可以在Android Sdk目录下的build-tools目录中找到各版本的dx程序,例如我的电脑可以在版本号为30.0.3的build-tools中找到:

dx工具

使用命令优化jar包:

dx –dex –output=hotfix_dex.jar hotfix.jar

这样我们就拿到了最终需要的补丁包hotfix_dex.jar

加载补丁包

正常来讲我们的补丁包是通过后端下发,然后客户端使用DexClassLoader来加载的,这里为了方便模拟,直接通过adb命令push到sdk卡中:

adb push hotfix_dex.jar /storage/emulated/0/

接着修改 MainActivity 中的逻辑,使用DexClassLoader加载HotFix patch中的 SayHotFix类,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class MainActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
var say: ISay
findViewById<AppCompatButton>(R.id.btn).setOnClickListener {
val jarFile =
File(Environment.getExternalStorageDirectory().path + File.separator + "hotfix_dex.jar")

if (!jarFile.exists()) {
say = SayException()
Toast.makeText(this, say.saySomething(), Toast.LENGTH_SHORT).show()
return@setOnClickListener
}

val dexClassLoader =
DexClassLoader(jarFile.absolutePath, filesDir.absolutePath, null, classLoader)
try {
val clazz = dexClassLoader.loadClass("com.sukaidev.dexclassloaderhotfix.SayHotFix")
val iSay: ISay = clazz.newInstance() as ISay
Toast.makeText(this, iSay.saySomething(), Toast.LENGTH_SHORT).show()
} catch (e: Exception) {
e.printStackTrace()
}
}
}

注意这里需求读取SD卡上的补丁包,API 23以上需要动态申请权限。运行后效果如下:

参考