深入理解Java虚拟机学习之二class文件内容详解

写在前边的话

---

最近在看《深入理解Java虚拟机》这本书，学习Java虚拟机底层实现原理。通过写博客的方式记录自己的学习过程以及对知识的理解。如有总结不正确的地方，欢迎大家指出！

---

作为一名Java程序员都知道我们写完代码之后的源文件在使用javac命令后，会编译出源文件相对应的class文件。而这个class文件是一个二进制的字节码文件。上一篇文章介绍了查看字节码文件的工具，那么本篇文章我们就用字节码查看工具来查看一下class文件中都有哪些内容。我们通过一个简单的例子来一起查看下class文件的内容。

一、首先写一个简单的例子

public class ViewClassFile {
    private static int count = 9;
    public static void main(String[] args) {
        System.out.println(count);
    }
}

这个例子非常简单，只有一个静态成员变量和一个main方法。

二、接下来我们将这个源文件进行编译，生成其相对应的class文件

可以使用javac命令也可以使用idea进行编译。

上图是编译好的字节码文件，我们可以看到一堆16进制的字节。如果你使用IDE去打开，也许看到的是已经被反编译的我们所熟悉的java代码，而这才是纯正的字节码，这也是我们今天需要讲的内容重点。

当任何一个人看到这张图的时候都是一头雾水，我刚开始看的时候也是这样，不过没关系万事开头难，只要我们开始了就是向成功迈了一步！

首先我们先看一张图，这张图就是class文件的存储结构。

三、class文件内容详解

class文件本质是一组以8位字节为基础单位的二进制流，各个数据项紧密连接之间没有任何分隔符。
class文件中是以无符号数和表来保存数据的。
无符号数可以是1个字节，2个字节，4个字节和8个字节来表示。无符号数可以表示数字，索引引用，数量值或者按照UTF-8编码结构的字符串。
表是由多个无符号数或者其他表作为数据项构成的复合数据类型，所有表习惯性的以“_info”结尾。表用于描述有层次关系的复合结构的数据。
整个class文件其实就是一张表。结构如上图所示。

以上内容是摘自深入理解Java虚拟机书中的描述。接下来就根据刚才的例子，一起学习class文件的结构。

- 魔数（magic），占4个字节

从上边的总览图中我们知道前4个字节表示的魔数。对应我们的demo的是0xCAFEBABE。那么魔数是用来干什么的呢？为什么要定义魔数呢？
其实魔数的唯一作用就是用来标识这个文件是否是一个可被虚拟机接受的class文件。
很多的文件存储标准中都是使用魔数来进行身份识别的，譬如图片格式，如gif或者jpeg等在文件头中都存有魔数。
使用魔数而不是扩展名来进行识别主要是基于安全方面的考虑，因为文件扩展名可以随意地改动。
至于Java为什么要用CAFEBABE来作为魔数的值，书中有一段描述：

Class文件的魔数的获得很有“浪漫气息”，值为：0xCAFEBABE（咖啡宝贝？），这个魔数值在Java还称做"Oak"语言的时候（大约是1991年前后）就已经确定下来了。它还有一段很有趣的历史，据Java开发小组最初的关键成员PatrickNaughton所说：“我们一直在寻找一些好玩的、容易记忆的东西，选择0xCAFEBABE是因为它象征着著名咖啡品牌Peet’sCoffee中深受欢迎的Baristas咖啡”，这个魔数似乎也预示着日后"Java"这个商标名称的出现。

- class文件的版本

紧接着魔数的四个字节就是class文件的版本号了。
class文件的版本号总共占4个字节，第5和6个字节表示次版本号（Minor Version）；第7和8个字节表示主版本号（Major Version）。
表示这个class文件只能被大于这个版本号的Java虚拟机执行。
书中关于Java虚拟机的版本号的说明:

Java的版本号是从45开始的，JDK1.1之后的每个JDK大版本发布主版本号向上加1（JDK1.0_{1.1使用了45.0}45.3的版本号） ，高版本的JDK能向下兼容以前版本的Class文件，但不能运行以后版本的Class文件，即使文件格式并未发生任何变化，虚拟机也必须拒绝执行超过其版本号的Class文件。例如，JDK1.1能支持版本号为45.045.0~46.65535的Class文件。现在，最新的JDK版本为1.7，可生成的Class文件主版本号最大值为51.0。

使用jclasslib工具查看我们demo的字节码文件，可以查看到的版本信息如图：

由图可以看到，次版本号为0，主版本号为51，该版本号说明这个文件是可以被JDK1.7或以上版本虚拟机执行的Class文件。

- 常量池

紧接着主次版本号之后，就是常量池的入口了。这个常量池可是非常关键的，几乎所有的信息都被保存在常量池中。常量池可以看做是整个class文件的资源仓库，后边的方法表，字段表中的字段名称以及描述，方法名称以及描述等都是保存在常量池中，字段表和方法表中只是保存了指向常量池中的索引值。
由于常量池中的数据个数是不固定的，所以会在常量池的入口会放置一个u2类型的数据，表示常量池容量（也就是常量池中常量的个数）。与Java语言的思维不同的是，这个常量池容量是从1开始的。同样拿我们demo来看，常量池相关信息如图：


由图中可以看出，常量池容量为37，表示常量池中有37个常量，常量的索引值范围是1-37，从图中也可以看出，索引值是从1开始的。关于为什么从1开始，书中有如下描述：

在Class文件格式规范制定之时，设计者将第0项常量空出来是有特殊考虑的，这样做的目的在于满足后面某些指向常量池的索引值的数据在特定情况下需要表达“不引用任何一个常量池项目”的含义，这种情况就可以把索引值置为0来表示。

注意：Class文件结构中只有常量池的容量计数是从1开始，对于其他集合类型，包括接口索引集合、字段表集合、方法表集合等的容量计数都与一般习惯相同，是从0开始的。

常量池中主要保存两大类常量：字面量和符号引用。
字面量比较接近于Java中定义的常量，如字符串常量，或者用final修饰的可确定值的变量。而符号引用则属于编译原理方面的概念，主要包含三大类常量：
类和接口的全限定名
字段的简单名称和描述
方法的简单名称和描述

常量池中每一个常量其实都是一个表结构，共有14中表结构。这14种表都有一个共同的特点，就是表开始的第一位是一个u1类型的标志位（tag，取值见表6-3中标志列），代表当前这个常量属于哪种常量类型。下边这张图就是常量池中的项目类型。
注意：常量池中并不是会全部出现14种项目，而是编译器在编译时，根据实际源代码编译出来的。

上图中，每一个项目其实都是一张表，每个项目的表结构又是不相同的。具体的表结构参照下图：


现在以我们的demo为例，我们一起看一下常量池中的内容。
用jclasslib工具打开我们的class文件，点开常量池列表，我们看到第一项是CONSTANT_Methodref_info型常量。

查看上图中可以知道，CONSTANT_Methodref_info型常量的结构如下

再看我们的demo中，CONSTANT_Methodref_info型常量的第一个索引值是cp_info #6，表示的是指向常量池中的第六个常量。继续跟进，发现指向的是CONSTANT_Class_info类型的常量，那我们得继续查看CONSTANT_Class_info类型的常量的结构

从图中可以看出，这个常量中也是有一个索引，这个索引指向全限定名常量项的索引。那么在jclasslib中，发现CONSTANT_Class_info类型的常量的index值是cp_info #30，那继续跟进，发现指向的是CONSTANT_Utf8_info类型的常量。

从图中可以看出，这个类型的常量其实就是一个字符串，并不会再去指向别的常量了。再进入jclasslib界面，发现CONSTANT_Utf8_info类型的常量值是：java/lang/Object.

以上就是常量池常量项的分析方法。现在来总结下，我们的demo中常量池中第一个常量项所表示的含义：
其实就是描述的Java.lang.Object类中init方法的信息。其中类的全限定名是java.lang.Object，方法名是：init，方法的参数是（），方法的返回值是V。

大家也可以试着分析一下其他的常量项。以上就是常量池相关的内容

- 访问标志

紧接着常量池之后是类的访问标志（access_flags）。
这个标志用于识别一些类或者接口层次的访问信息，包括：这个Class是类还是接口；是否定义为public类型；是否定义为abstract类型；如果是类的话，是否被声明为final等。
具体的标志位以及标志含义如下图：

以我们的demo为例，ViewClassFile是一个普通Java类，不是接口、枚举或者注解，被public关键字修饰但没有被声明为final和abstract，并且它使用了JDK1.2之后的编译器进行编译，因此它的ACC_PUBLIC、ACC_SUPER标志应当为真，而ACC_FINAL、ACC_INTERFACE、ACC_ABSTRACT、ACC_SYNTHETIC、ACC_ANNOTATION、ACC_ENUM这6个标志应当为假，因此它的access_flags的值应为：0x0001|0x0020=0x0021。我们用jclasslib工具查看它的access_flags的值也是0x0021。

- 类索引，父类索引和接口索引集合

紧接着之后，就是类索引（this_class），父类索引（super_class）和接口索引集合（interfaces）了。
这部分的思维导图结构如下：

通过demo看一下类索引和父类索引查找全限定名的过程。由于demo没有实现任何接口，所以接口计数为0.

到此，终于明白了Java虚拟机是通过这三部分来确定一个类的继承关系的。

- 字段表集合

接下来就是字段表集合（field_info）。用于描述接口或者类中定义的变量。字段包括类级别的和实例级别的，但不包含声明在方法内部的局部变量。
字段表结构如下图：

其中，各个字段含义如下：

• access_flag：u2类型数据，可以设置的标志值如图
  
• name_index和description_index：对常量池中的引用，分别代表字段的简单名称和描述符。描述符其实就是字段或者方法的数据类型，以及方法的参数列表信息，以及返回值信息等。关于全限定名，简单名称以及描述符信息，书中有如下描述：

现在需要解释一下“简单名称”、“描述符”以及前面出现过多次的“全限定名”这三种特殊字符串的概念。全限定名和简单名称很好理解，以代码清单61中的代码为例，“org/fenixsoft/clazz/TestClass"是这个类的全限定名，仅仅是把类全名中的“.”替换成了“/”而已，为了使连续的多个全限定名之间不产生混淆，在使用时最后一般会加入一个“；”表示全限定名结束。简单名称是指没有类型和参数修饰的方法或者字段名称，这个类中的inc()方法和m字段的简单名称分别是"inc"和"m”。相对于全限定名和简单名称来说，方法和字段的描述符就要复杂一些。描述符的作用是用来描述字段的数据类型、方法的参数列表（包括数量、类型以及顺序）和返回值。根据描述符规则，基本数据类型（byte、char、double、float、int、long、short、boolean）以及代表无返回值的void类型都用一个大写字符来表示，而对象类型则用字符L加对象的全限定名来表示，详见表610。对于数组类型，每一维度将使用一个前置的”[“字符来描述，如一个定义为"java.lang.String[][]“类型的二维数组，将被记录为：”[[Ljava/lang/String；”，一个整型数组"int[]“将被记录为”[I"。用描述符来描述方法时，按照先参数列表，后返回值的顺序描述，参数列表按照参数的严格顺序放在一组小括号“()”之内。如方法voidinc()的描述符为"()V"，方法java.lang.StringtoString()的描述符为"()Ljava/lang/String；"，方法intindexOf（char[]source,intsourceOffset,intsourceCount,char[]target,inttargetOffset,inttargetCount,intfromIndex）的描述符为"（[CII[CIII）I"。

字段表都包含的固定数据项目到descriptor_index为止就结束了，不过在descriptor_index之后跟随着一个属性表集合用于存储一些额外的信息，字段都可以在属性表中描述零至多项的额外信息。对于本例中的字段m，它的属性表计数器为0，也就是没有需要额外描述的信息，但是，如果将字段m的声明改为"finalstaticintm=123；"，那就可能会存在一项名称为ConstantValue的属性，其值指向常量123。

现在再来看下我们的demo的字段表集合。

表示的是，这个类有一个名为count的字段，字段的类型是int，访问标志是private static。

- 方法表集合

字段表之后就是方法表了。方法表与字段表的结构是一模一样的。只是访问标志少了volatile关键字和transient关键字，因为这两个关键字不能修饰方法。下图是方法的访问标志。

方法与字段的区别是，方法是由方法体的，而字段没有。那么如果使用上边字段表的结构，我们的方法体保存在哪里呢？
其实，我们的方法被编译成字节码指令后，保存在方法表的attribute表中。详细请看属性表集合。
以我们的demo来看下，方法表中的信息

表示的含义是：这个类有一个方法，方法名是main，方法的返回值是void，参数一个String[]，这个方法的方法体保存在code属性中。

- 属性表集合

属性表（attribute_info）在前面的讲解之中已经出现过数次，在Class文件、字段表、方法表都可以携带自己的属性表集合，以用于描述某些场景专有的信息。

虚拟机预定义出许多属性


对于每个属性，它的名称需要从常量池中引用一个CONSTANT_Utf8_info类型的常量来表示，而属性值的结构则是完全自定义的，只需要通过一个u4的长度属性去说明属性值所占用的位数即可。一个符合规则的属性表应该满足如下结构。

常用的属性列表：

1.Code属性

Java程序方法体中的代码经过Javac编译器处理后，最终变为字节码指令存储在Code属性内。Code属性出现在方法表的属性集合之中，但并非所有的方法表都必须存在这个属性，譬如接口或者抽象类中的方法就不存在Code属性，如果方法表有Code属性存在，那么他的结构如下图所示

attribute_name_index是一项指向CONSTANT_Utf8_info型常量的索引，常量值固定为"Code"，它代表了该属性的属性名称。
attribute_length指示了属性值的长度，由于属性名称索引与属性长度一共为6字节，所以属性值的长度固定为整个属性表长度减去6个字节。

max_stack代表了操作数栈（OperandStacks）深度的最大值。在方法执行的任意时刻，操作数栈都不会超过这个深度。虚拟机运行的时候需要根据这个值来分配栈帧（StackFrame）中的操作栈深度。

max_locals代表了局部变量表所需的存储空间。max_locals代表了局部变量表所需的存储空间。在这里，max_locals的单位是Slot,Slot是虚拟机为局部变量分配内存所使用的最小单位。对于byte、char、float、int、short、boolean和returnAddress等长度不超过32位的数据类型，每个局部变量占用1个Slot，而double和long这两种64位的数据类型则需要两个Slot来存放。方法参数（包括实例方法中的隐藏参数"this"）、显式异常处理器的参数（ExceptionHandlerParameter，就是trycatch语句中catch块所定义的异常）、方法体中定义的局部变量都需要使用局部变量表来存放。另外，并不是在方法中用到了多少个局部变量，就把这些局部变量所占Slot之和作为max_locals的值，原因是局部变量表中的Slot可以重用，当代码执行超出一个局部变量的作用域时，这个局部变量所占的Slot可以被其他局部变量所使用，Javac编译器会根据变量的作用域来分配Slot给各个变量使用，然后计算出max_locals的大小。

code_length和code用来存储Java源程序编译后生成的字节码指令。code_length代表字节码长度，code是用于存储字节码指令的一系列字节流。既然叫字节码指令，那么每个指令就是一个u1类型的单字节，当虚拟机读取到code中的一个字节码时，就可以对应找出这个字节码代表的是什么指令，并且可以知道这条指令后面是否需要跟随参数，以及参数应当如何理解。我们知道一个u1数据类型的取值范围为0x00_{0xFF，对应十进制的0}255，也就是一共可以表达256条指令，目前，Java虚拟机规范已经定义了其中约200条编码值对应的指令含义，具体的编码与指令之间的对应关系可查“虚拟机字节码指令表”。

关于code_length，有一件值得注意的事情，虽然它是一个u4类型的长度值，理论上最大值可以达到2321，但是虚拟机规范中明确限制了一个方法不允许超过65535条字节码指令，即它实际只使用了u2的长度，如果超过这个限制，Javac编译器也会拒绝编译。

Code属性是Class文件中非常重要的一个属性。如果把一个Java程序中的信息分为代码（Code，方法体里面的Java代码）和元数据（Metadata，包括类、字段、方法定义及其他信息）两部分，那么在整个Class文件中，Code属性用于描述代码，所有的其他数据项目都用于描述元数据。了解Code属性是学习后面关于字节码执行引擎内容的必要基础，能直接阅读字节码也是工作中分析Java代码语义问题的必要工具和基本技能。接下来我们还是以上边的demo为例分析一下Java虚拟机是如何使用这个属性的。

用jclasslib工具打开class文件，我们以main方法为例。

我们看到，main方法的字节码指令总共有四条：
getstatic #2:查看字节码指令表发现，这条指令的含义是获取指定类的静态域并将其压入操作数栈的栈顶。后边的#2就是getstatic指令的参数，表示的是获取的哪个类的什么静态域。在我们的demo中就是获取java/lang/System类的out这个静态域，并且这个静态域的类型是java/io/PrintStream。获取到这个静态域之后，并将其压入操作数栈的栈顶。
getstatic #3：这个条字节码指令与上一条是一样的，只不过这条指令获取的是ViewClassFile类中的count这个静态域，并将count静态域压入栈顶。
invokevirtual #4：查看虚拟机指令表发现invokevirtual这条指令的含义是调用实例方法。后边跟了#4这个参数，这个参数指向的常量池中的第四项常量结构，第四项常量结构发现是CONSTANT_Mehodref_info。所以这个参数就定义了调用哪个类的哪个方法。再看我们的demo中就是调用java/io/PrintStream这个实例对象的println（i）方法。这个println方法有个int类型的参数，就是虚拟机在执行这条指令的时候，会将操作数栈栈顶的count的值作为println的参数输出。
return：就是退出这个main方法。

这段字节码虽然很短，但是至少可以看出它的执行过程中的数据交换、方法调用等操作都是基于栈（操作栈）的。

2.Exceptions属性

这里的Exceptions属性是在方法表中与Code属性平级的一项属性。Exceptions属性的作用是列举出方法中可能抛出的受查异常（CheckedExcepitons），也就是方法描述时在throws关键字后面列举的异常。它的结构如图：

Exceptions属性中的number_of_exceptions项表示方法可能抛出的受查异常的个数，每一种受查异常使用一个exception_index_table项表示，exception_index_table是一个指向常量池中CONSTANT_Class_info型常量的索引，代表了该受查异常的类型。

3.LineNumberTable属性

LineNumberTable属性用于描述Java源码行号与字节码行号（字节码的偏移量）之间的对应关系。它并不是运行时必需的属性，但默认会生成到Class文件之中，可以在Javac中分别使用g:none或g:lines选项来取消或要求生成这项信息。如果选择不生成LineNumberTable属性，对程序运行产生的最主要的影响就是当抛出异常时，堆栈中将不会显示出错的行号，并且在调试程序的时候，也无法按照源码行来设置断点。
LineNumberTable属性的结构如图：

line_number_table是一个数量为line_number_table_length、类型为line_number_info的集合，line_number_info表包括了start_pc和line_number两个u2类型的数据项，前者是字节码行号，后者是Java源码行号。

4.LocalVariableTable属性

LocalVariableTable属性用于描述栈帧中局部变量表中的变量与Java源码中定义的变量之间的关系，它也不是运行时必需的属性，但默认会生成到Class文件之中，可以在Javac中分别使用g:none或g:vars选项来取消或要求生成这项信息。如果没有生成这项属性，最大的影响就是当其他人引用这个方法时，所有的参数名称都将会丢失，IDE将会使用诸如arg0、arg1之类的占位符代替原有的参数名，这对程序运行没有影响，但是会对代码编写带来较大不便，而且在调试期间无法根据参数名称从上下文中获得参数值。

表结构如图：

其中，local_variable_info项目代表了一个栈帧与源码中的局部变量的关联。local_variable_info的表结构如图：

start_pc和length属性分别代表了这个局部变量的生命周期开始的字节码偏移量及其作用范围覆盖的长度，两者结合起来就是这个局部变量在字节码之中的作用域范围。

name_index和descriptor_index都是指向常量池中CONSTANT_Utf8_info型常量的索引，分别代表了局部变量的名称以及这个局部变量的描述符。index是这个局部变量在栈帧局部变量表中Slot的位置。当这个变量数据类型是64位类型时（double和long），它占用的Slot为index和index+1两个。顺便提一下，在JDK1.5引入泛型之后，LocalVariableTable属性增加了一个“姐妹属性”：LocalVariableTypeTable，这个新增的属性结构与LocalVariableTable非常相似，仅仅是把记录的字段描述符的descriptor_index替换成了字段的特征签名（Signature），对于非泛型类型来说，描述符和特征签名能描述的信息是基本一致的，但是泛型引入之后，由于描述符中泛型的参数化类型被擦除掉[3]，描述符就不能准确地描述泛型类型了，因此出现了LocalVariableTypeTable。

5.SourceFile属性

SourceFile属性用于记录生成这个Class文件的源码文件名称。这个属性也是可选的，可以分别使用Javac的g:none或g:source选项来关闭或要求生成这项信息。在Java中，对于大多数的类来说，类名和文件名是一致的，但是有一些特殊情况（如内部类）例外。如果不生成这项属性，当抛出异常时，堆栈中将不会显示出错代码所属的文件名。这个属性是一个定长的属性，其结构如图：

sourcefile_index数据项是指向常量池中CONSTANT_Utf8_info型常量的索引，常量值是源码文件的文件名。

6.ConstantValue属性

ConstantValue属性的作用是通知虚拟机自动为静态变量赋值。只有被static关键字修饰的变量（类变量）才可以使用这项属性。类似"intx=123"和"staticintx=123"这样的变量定义在Java程序中是非常常见的事情，但虚拟机对这两种变量赋值的方式和时刻都有所不同。对于非static类型的变量（也就是实例变量）的赋值是在实例构造器＜init＞方法中进行的；而对于类变量，则有两种方式可以选择：在类构造器＜clinit＞方法中或者使用ConstantValue属性。目前SunJavac编译器的选择是：如果同时使用final和static来修饰一个变量（按照习惯，这里称“常量”更贴切），并且这个变量的数据类型是基本类型或者java.lang.String的话，就生成ConstantValue属性来进行初始化，如果这个变量没有被final修饰，或者并非基本类型及字符串，则将会选择在＜clinit＞方法中进行初始化。
ConstantValue属性的结构如图：

从数据结构中可以看出，ConstantValue属性是一个定长属性，它的attribute_length数据项值必须固定为2。constantvalue_index数据项代表了常量池中一个字面量常量的引用，根据字段类型的不同，字面量可以是CONSTANT_Long_info、CONSTANT_Float_info、CONSTANT_Double_info、CONSTANT_Integer_info、CONSTANT_String_info常量中的一种。

7.InnerClasses属性

InnerClasses属性用于记录内部类与宿主类之间的关联。如果一个类中定义了内部类，那编译器将会为它以及它所包含的内部类生成InnerClasses属性。该属性的结构如图：

数据项number_of_classes代表需要记录多少个内部类信息，每一个内部类的信息都由一个inner_classes_info表进行描述。inner_classes_info表的结构如图：

inner_class_info_index和outer_class_info_index都是指向常量池中CONSTANT_Class_info型常量的索引，分别代表了内部类和宿主类的符号引用。

inner_name_index是指向常量池中CONSTANT_Utf8_info型常量的索引，代表这个内部类的名称，如果是匿名内部类，那么这项值为0。

inner_class_access_flags是内部类的访问标志，类似于类的access_flags。inner_class_access_flags的取值如图：

本篇文章只分析上边的几个属性，其余属性大家可以自行查资料。

四、总结

到此为止，class文件组织结构以及解析已经完成了。如果大家能自己体验一遍，肯定会有不一样的收获的。希望大家读了这篇文章能对class文件结构有进一步认识。这样以后我们也能看懂字节码文件了。了解class文件的结构对后面进一步了解虚拟机执行引擎非常重要，所以这是基础并重要的一步。