# Class 文件解析 (上)

# Class 文件本质和内部数据类型

• Class 类的本质

  任何一个 CLass 文件都对应着唯一一个类或接口的定义信息，但反过来说，Class 文件实际上并不一定以磁盘文件的形式存在. Class 文件是以 8 位字节为基础单位的二进制流

• Class 文件格式

  Class 的结构不像 XML 等描述语言，由于它没有任何分隔符号，所以在其中的数据项，无论是字节顺序还是数量，都是被阉割限定的，哪个字节代表什么含义，长度是多少，先后顺序如何，都不允许改变.

  Class 文件格式采用一种类似于 C 语言结构体的方式进行数据存储，这种数据结构中只有两种数据类型 : 无符号数和表

  • 无符号数属于基本的数据类型，以 u1, u2, u4, u8 来分别代表 1 个字节，2 个字节，4 个字节和 8 个字节的无符号数。无符号数可以用来描述数字，索引引用，数量值或按照 UTF-8 编码构成字符串值
  • 表是由多个无符号数或其他表作为数据项构成的复合数据类型，所有表都习惯性地以 “_info” 结尾。表用于描述有层次关系的复合结构的数据，整个 Class 文件本质上就是一张表。由于表没有固定长度，所以通常会在其前面加上个数说明

# Class 文件结构

Class 文件的结构并不是一成不变的，随着 Java 虚拟机的不断发展，总是不可避免地会对 Class 文件结构做出一些调整，但是其基本结构和框架是非常稳定的.

Class 文件的总体结构如下 :

• 魔数
• Class 文件版本
• 常量池
• 访问标志
• 类索引，父类索引，接口索引集合
• 字段表集合
• 方法表集合
• 属性表集合

# Class 文件结构解析

# Magic Number (魔数)

• 每个 Class 文件开头的 4 个字节的无符号整数成为魔数

• 它的唯一作用是确定这个文件是否能被虚拟机接受的有效合法 Class 文件.

• 魔数固定位 0xCAFEBABE . 不会改变

• version (版本号)

  • 紧接着魔数的 4 个字节存储的是 Class 文件的版本号。同样也是 4 个字节。第 5 个和第 6 个字节所代表的含义就是编译的副版本号 minor_version, 而第 7 个和第 8 个字节就是编译的主版本号 major_version
  • 他们共同构成了 class 文件的格式版本号。譬如某个 Class 文件的主版本号为 M, 副版本号为 m, 那么这个 Class 文件的格式版本号就确定为 M.m

  主版本 (十进制)	夫版本 (十进制)	编译器版本
  45	3	1.1
  46	0	1.2
  47	0	1.3
  48	0	1.4
  49	0	1.5
  50	0	1.6
  51	0	1.7
  52	0	1.8
  53	0	1.9
  54	0	1.10
  55	0	1.11

  • Java 的版本是从 45 开始的. JDK1.1 之后的每个 JDK 大版本发布主版本号向上加 1
  • 不同版本的 Java 编译器编译的 Class 文件对应的版本是不一样的。目前，高版本的 Java 虚拟机可以执行由低版本编译器生成的 Class 文件，但是低版本的 Java 虚拟机不能执行由高版本编译器生成的 Class 文件。否则 JVM 会抛出 java.lang.UnsupportedClassVersionError 异常
  • 在实际应用中，由于开发环境和生产环境的不同，可能会导致该问题的发生。因此，需要我们在开发时，特别注意开发编译的 JDK 版本和生产环境中的 JDK 版本是否一致
    • 虚拟机 JDK 版本位 1.k (k>= 2) 时，对应的 class 文件格式版本号的范围为 45.0 - 44 + k.0 (含两端)

# constant_pool (常量池)

• 在版本号之后，紧跟着的是常量池的数量，以及若干个常量池表项
• 常量池是 Class 文件中内容最为丰富的区域之一。常量池对于 Class 文件中的字段和方法解析也有着至关重要的作用
• 随着 Java 虚拟机的不断发展，常量池的内容也日渐丰富。可以说，常量池是这个 Class 文件的基石
• 常量池中常量的数量是不固定的，所以在常量池的入口需要放置一项 u2 类型的无符号数，代表常量池容量计数值 (constant_pool_count). 与 Java 种语言习惯不一样的是，这个容量计数是从 1 而不是 0 开始的

由上表可见，Class 文件使用了一个前置的容量计数器 (constant_pool_count) 加若干个连续的数据项 (constant_pool) 的形式来描述常量池内容。我们把这一系列连续常量池数据成为常量池集合

• 常量池表项中，用于存放编译时期生成的各种字面量和符号引用，这部分内容将在类加载后进入方法区的运行时常量池存放
• 常量池主要存放两大类常量 : 字面量 (Literal) 和符号引用 (Symbolic Reference)
• 它包含了 class 文件结构及其子结构中引用的所有字符串常量，类或接口名，字段名和其他常量。常量池中的每一项都具备相同的特征。第 1 个字节作为类型标记，用于该项的格式，这个字称为为 tag_byte

• 由于常量池的数量不固定，时长时短，所以需要放置两个字节来表示常量池容量计数值

• 常量池容量计数值 (u2 类型) : 从 1 开始，表示常量池中有多少项常量。即 constant_pool_count = 1 表示常量池中有 0 个常量项

• 通常我们写代码都是从 0 开始的，但是这里的常量池却是从 1 开始，因为它把第 0 项空出来了。这是为了满足后面某些指向常量池的索引的数据在特定情况下需要表达 “不引用任何一个常量池项目” 的含义，这种情况可用索引值 0 来表示

• 字面量和符号引用

  常量池主要存放两大变量：字面量 (Literal) 和符号引用 (Symbolic Reference)

  常量	具体的常量
  字面量	文本字符串
  	声明为final的常量名
  符号引用	类和接口的全限定名
  	字段的名称和描述符
  	方法的名称和描述符

  • 全限定名

    com/wong/test/Demo 这个就是类的全限定名，仅仅是吧包名的 “.” 换成了 “/”, 为了使连续的多个全限定名之间不产生混淆，在使用时最后一般会加入一个 “;” 表示全限定名结束.

  • 简单名称

    简单名称是指没有类型和参数修饰的方法或者字段名称，上面例子中的类的 add () 方法和 num 字段的简单名称分别是 add 和 num

  • 描述符

    描述符是用来描述字段的数据类型，方法的参数列表 (包括数量，类型以及顺序) 和返回值。根据描述符规则，基本数据类型 (byte, char, double, float, int, long, short, boolean) 以及代表无返回值的 void 类型都用一个大写字符来表示，而对象类型则用字符 L 加对象的全限定名来表示

    标志符	含义
    B	基本数据类型 byte
    C	基本数据类型 char
    D	基本数据类型 double
    F	基本数据类型 float
    I	基本数据类型 int
    J	基本数据类型 long
    S	基本数据类型 short
    Z	基本数据类型 boolean
    V	代表 void 类型
    L	对象类型，比如 : Ljava/lang/Object;
    [	数组类型，代表一维数组。比如: double[][][] is [[[D

    虚拟机在加载 Class 文件时才会进行动态连接，也就是说 Class 文件不会保存各个方法和字段的最终内存布局信息，因此，这些字段和方法的符号引用不经过转换是无法直接被虚拟机使用的. == 当虚拟机运行时，需要从常量池中获得对应的符号引用，再在类加载过程中的解析阶段将其替换为直接引用，并翻译到具体的内存地址中.

    • 符号引用：符号引用以一组符号来描述所引用的目标，符号可以是任何形式的字面量，只要使用时能无歧义地定位到目标即可. 符号引用与虚拟机实现的内存布局无关，引用的目标并不一定已经加载到了内存中
    • 直接引用：直接引用可以是直接指向目标的指针，相对偏移量或是一个能间接定位到目标的句柄. 直接引用是与虚拟机实现的内存布局相关的，同一个符号引用在不同虚拟机上翻译出来的直接引用一般不会相同。如果有了直接引用，那说明引用的目标必定已经存在于内存之中了.

    标志	常量	描述	细节	长度	细节描述
    1	CONSTANT_utf8_info	UTF-8编码的字符串	tag	u1	值为1
    			length	u2	UTF-8编码的字符串占用的字符数
    			bytes	u1	长度为length的UTF-8编码的字符串
    3	CONSTANT_Integer_info	整型字面量	tag	u1	值为3
    			bytes	u4	按照高位在前存储的int值
    4	CONSTANT_Float_info	浮点型字面量	tag	u1	值为4
    			bytes	u4	按照高位在前存储的float值
    5	CONSTANT_Long_info	长整型字面量	tag	u1	值为5
    			bytes	u8	按照高位在前存储的long值
    6	CONSTANT_Double_info	双精度浮点型字面量	tag	u1	值为6
    			bytes	u8	按照高位在前存储的double值
    7	CONSTANT_Class_info	类或接口的符号引用	tag	u1	值为7
    			index	u2	指向全限定名常量项的索引
    8	CONSTANT_String_info	字符串类型字面量	tag	u1	值为8
    			index	u2	指向字符串字面量的索引
    9	CONSTANT_Fieldref_info	字段的符号引用	tag	u1	值为9
    			index	u2	指向声明字段的类或接口描述符CONSTANT_Class_info的索引项
    			index	u2	指向字段描述符CONSTANT_NameAndType的索引项
    10	CONSTANT_Methodref_info	类中方法的符号引用	tag	u1	值为10
    			index	u2	指向声明方法的类描述符CONSTANT_Class_Info的索引项
    			index	u2	指向名称及类型描述符CONSTANT_NameAndType的索引项
    11	CONSTANT_InterfaceMethodref_info	接口中方法的符号引用	tag	u1	值为11
    			index	u2	指向声明方法的接口描述符CONSTANT_Class_Info的索引项
    			index	u2	指向名称及类型描述符CONSTANT_NameAndType的索引项
    12	CONSTANT_NameAndType_info	字段或方法的符号引用	tag	u1	值为12
    			index	u2	指向该字段或方法名称常量项的索引
    			index	u2	指向该字段或方法描述符常量项的索引
    15	CONSTANT_MethodHandle_info	表示方法句柄	tag	u1	值为15
    			reference_kind	u1	值必须在1-9之间，它决定了方法句柄的类型方法句柄类型的值表示方法句柄的字节码行为
    			reference_index	u2	值必须是对常量池的有效索引
    16	CONSTANT_MethodType_info	标志方法类型	tag	u1	值为16
    			descriptor_index	u2	值必须是对常量池的有效索引，常量池在该索引处的项必须是CONSTANT_Utf8_info结构，表示方法的描述符
    18	CONSTANT_InvokeDynamic_info	表示一个动态方法调用点	tag	u1	值为18
    			bootstrap_method_attr	u2	值必须是对当前Class文件中引导方法表的bootstrap_methods[]数组的有效索引
    			name_and_type_index	u2	值必须是对当前常量池的有效索引，常量池在该索引处的项必须是CONSTANT_NameAndType_Info结构，表示方法名和方法描述符

  • 这 14 种表的共同点是：表开始的第一位是一个 u1 类型的标志位 (tag), 代表当前这个常量项使用的是哪种表结构，即哪种常量类型

  • 常量池列表中，CONSTANT_Utf8_info 常量项是一种使用改进过的 UTF-8 编码格式来储存注入文字字符串，类或者接口的全限定名，字段或者方法的简单名称以及描述符等常量字符串信息

  • 这 14 种常量项结构还有一个特点是，其中 13 个常量项占用的字节固定，只有 CONSTANT_Utf8_info 占用字节不固定，其大小由 length 决定. 因为从常量池存放的内容可知，其存放的是字面量和符号引用，最终这些内容都会是一个字符串，这些字符串的大小是在编写程序时才确定，比如定义一个类，类名可以取长取短，所以在没编译前，大小不固定，编译后，通过 utf-8 编码，就可以知道其长度

  • 常量池：可以理解为 Class 文件之中的资源仓库，它是 Class 文件结构中与其他项目关联最多的数据类型 (后面很多数据类型都会指向此处), 也是占用 Class 文件空间最大的数据项目之一

  • 常量池中为什么要包含这些内容

    Java 代码在进行 javac 编译的时候，并不像 C 和 C++ 那样有 “连接” 这一步骤，而是在虚拟机加载 Class 文件的时候进行动态链接。也就是说，在 Class 文件中不会保存各个方法，字段的最终内存布局信息，因此这些字段，方法的符号引用不经过运行期转换的话无法得到真正的内存入口地址，也就无法直接被虚拟机使用. 当虚拟机运行时，需要从常量池获得对应的符号引用，再在类创建时或运行时解析，翻译到具体的内存地址之中.

# access_flag (访问标识)

• 在常量池后，紧跟着访问标记。该标记使用两个字节标示，用于识别一些类或者接口层次的访问信息，包括 :

  • 这个 Class 是类还是接口
  • 是否定义为 public 类型
  • 是否定义为 abstract 类型
  • 如果是类的话，是否被声明为 final 等

  标志名称	标志值	含义
  ACC_PUBLIC	0x0001	标志位 public 类型
  ACC_FINAL	0x0010	标志被声明为 final, 只有类可以设置
  ACC_SUPER	0x0020	标志允许使用 invokespecial 字节码指令的新语义，JDK1.0.2 之后编译出来的类的这个标志默认为真 (使用增强的方法调用父类方法)
  ACC_INTERFACE	0x0200	标志这是一个接口
  ACC_ABSTRACT	0x0400	是否为 abstract 类型，对于接口或者抽象类来说，此标志值为真，其他类型为假
  ACC_SYNTHTIC	0x1000	标志此类并非由用户代码产生 (即：由编译器产生的类，没有源码对应)
  ACC_ANNOTATION	0x2000	标志这是一个注解
  ACC_ENUM	0x4000	标志这是一个枚举

• 类的访问权限通常为 ACC_开头的常量

• 每一种类型的表示都是通过设置访问标记的 32 位中的特定位来实现的。比如：若是 public final 的类，则该标记为 ACC_PUBLIC | ACC_FINAL

• 使用 ACC_SUPER 可以让类更准确地定位到父类的方法 super.method (), 现代编译器都会设置并且使用这个标记

• 带有 ACC_INTERFACE 标志的 class 文件表示的是接口而不是类，反之则表示的是类而不是接口

  • 如果一个 class 文件被设置了 ACC_INTERFACE 标志，那么同时也得设置 ACC_ABSTRACT 标志。同时它不能再设置 ACC_FINAL, ACC_SUPER 或 ACC_ENUM 标志
  • 如果没有设置 ACC_INTERFACE 标志，那么这个 class 文件可以具有上表中除 ACC_ANNOTATION 外的其他所有标志。当然，ACC_FINAL 和 ACC_ABSTRACT 这类互斥的标志除外。这两个标志不得同时设置

• ACC_SUPER 标志用于确定类或接口里面的 invokespecial 指令使用的是哪一种执行语义. 针对 Java 虚拟机指令集的编译器都应当设置这个标志。对于 Java SE 8 及后续版本来说，无论 class 文件中这个标志的实际值是什么，也不管 class 文件的版本号是多少，Java 虚拟机都认为每个 class 文件均设置了 ACC_SUPER 标志

  • ACC_SUPER 标志是为了向后兼容由旧 Java 编译器所编译器的代码而设计的。目前的 ACC_SUPER 标志在由 JDK 1.0.2 之前的编译器所生成的 access_flags 中是没有确定含义的，如果设置了该标志，那么 Oracle 的 Java 虚拟机实现会将其忽略