最近在寫一個私人專案,名字叫做ClassAnalyzer
,ClassAnalyzer
的目的是能讓我們對Java Class
檔案的設計與結構能夠有一個深入的理解。主體框架與基本功能已經完成,還有一些細節功能日後再增加。實際上JDK
已經提供了命令列工具javap
來反編譯Class
檔案,但本篇文章將闡明我實現解析器的思路。
Class檔案
作為類或者介面資訊的載體,每個Class
檔案都完整的定義了一個類。為了使Java
程式可以“編寫一次,處處執行”,Java虛擬機器規範對Class
檔案進行了嚴格的規定。構成Class
檔案的基本資料單位是位元組,這些位元組之間不存在任何分隔符,這使得整個Class
檔案中儲存的內容幾乎全部是程式執行的必要資料,單個位元組無法表示的資料由多個連續的位元組來表示。
根據Java
虛擬機器規範,Class
檔案採用一種類似於C
語言結構體的偽結構來儲存資料,這種偽結構中只有兩種資料型別:無符號數和表。Java
虛擬機器規範定義了u1
、u2
、u4
和u8
來分別表示1
個位元組、2
個位元組、4
個位元組和8
個位元組的無符號數,無符號數可以用來描述數字、索引引用、數量值或者是字串。表是由多個無符號數或者其它表作為資料項構成的複合資料型別,表用於描述有層次關係的複合結構的資料,因此整個Class
檔案本質上就是一張表。在ClassAnalyzer
中u1
、u2
、u4
和u8
分別對應於byte
、short
、int
和long
,Class
檔案被描述為如下Java
類。
public class ClassFile {
public U4 magic; // magic
public U2 minorVersion; // minor_version
public U2 majorVersion; // major_version
public U2 constantPoolCount; // constant_pool_count
public ConstantPoolInfo[] cpInfo; // cp_info
public U2 accessFlags; // access_flags
public U2 thisClass; // this_class
public U2 superClass; // super_class
public U2 interfacesCount; // interfaces_count
public U2[] interfaces; // interfaces
public U2 fieldsCount; // fields_count
public FieldInfo[] fields; // fields
public U2 methodsCount; // methods_count
public MethodInfo[] methods; // methods
public U2 attributesCount; // attributes_count
public BasicAttributeInfo[] attributes; // attributes
}複製程式碼
如何解析
組成Class
檔案的各個資料項中,例如魔數、Class
檔案的版本、訪問標誌、類索引和父類索引等資料項,它們在每個Class
檔案中都佔用固定數量的位元組,在解析時只需要讀取相應數量的位元組。除此之外,需要靈活處理的主要包括4
部分:常量池、欄位表集合、方法表集合和屬性表集合。欄位和方法都可以具備自己的屬性,Class
本身也有相應的屬性,因此,在解析欄位表集合和方法表集合的同時也包含了屬性表的解析。
常量池佔據了Class
檔案很大一部分的資料,用於儲存所有的常量資訊,包括數字和字串常量、類名、介面名、欄位名和方法名等。Java
虛擬機器規範定義了多種常量型別,每一種常量型別都有自己的結構。常量池本身是一個表,在解析時有幾點需要注意。
- 每個常量型別都通過一個
u1
型別的tag
來標識。
- 表頭給出的常量池大小(
constantPoolCount
)比實際大1
,例如,如果constantPoolCount
等於47
,那麼常量池中有46
項常量。 - 常量池的索引範圍從
1
開始,例如,如果constantPoolCount
等於47
,那麼常量池的索引範圍為1~46
。設計者將第0
項空出來的目的是用於表達“不引用任何一個常量池專案”。 CONSTANT_Utf8_info
型常量的結構中包含u1
型別的tag
、u2
型別的length
和由length
個u1
型別組成的bytes
,這length
位元組的連續資料是一個使用MUTF-8
(Modified UTF-8)
編碼的字串。MUTF-8
與UTF-8
並不相容,主要區別有兩點:一是null
字元會被編碼成2
位元組(0xC0
和0x80
);二是補充字元是按照UTF-16
拆分為代理對分別編碼的,相關細節可以看這裡(變種UTF-8)。
屬性表用於描述某些場景專有的資訊,Class
檔案、欄位表和方法表都有相應的屬性表集合。Java
虛擬機器規範定義了多種屬性,ClassAnalyzer
目前實現了對常用屬性的解析。和常量型別的資料項不同,屬性並沒有一個tag
來標識屬性的型別,但是每個屬性都包含有一個u2
型別的attribute_name_index
,attribute_name_index
指向常量池中的一個CONSTANT_Utf8_info
型別的常量,該常量包含著屬性的名稱。在解析屬性時,ClassAnalyzer
正是通過attribute_name_index
指向的常量對應的屬性名稱來得知屬性的型別。
欄位表用於描述類或者介面中宣告的變數,欄位包括類級變數以及例項級變數。欄位表的結構包含一個u2
型別的access_flags
、一個u2
型別的name_index
、一個u2
型別的descriptor_index
、一個u2
型別的attributes_count
和attributes_count
個attribute_info
型別的attributes
。我們已經介紹了屬性表的解析,attributes
的解析方式與屬性表的解析方式一致。
Class
的檔案方法表採用了和欄位表相同的儲存格式,只是access_flags
對應的含義有所不同。方法表包含著一個重要的屬性:Code
屬性。Code
屬性儲存了Java
程式碼編譯成的位元組碼指令,在ClassAnalyzer
中,Code
對應的Java
類如下所示(僅列出了類屬性)。
public class Code extends BasicAttributeInfo {
private short maxStack;
private short maxLocals;
private long codeLength;
private byte[] code;
private short exceptionTableLength;
private ExceptionInfo[] exceptionTable;
private short attributesCount;
private BasicAttributeInfo[] attributes;
...
private class ExceptionInfo {
public short startPc;
public short endPc;
public short handlerPc;
public short catchType;
...
}
}複製程式碼
在Code
屬性中,codeLength
和code
分別用於儲存位元組碼長度和位元組碼指令,每條指令即一個位元組(u1
型別)。在虛擬機器執行時,通過讀取code
中的一個個位元組碼,並將位元組碼翻譯成相應的指令。另外,雖然codeLength
是一個u4
型別的值,但是實際上一個方法不允許超過65535
條位元組碼指令。
程式碼實現
ClassAnalyzer
的原始碼已放在了GitHub上。在ClassAnalyzer
的README中,我以一個類的Class
檔案為例,對該Class
檔案的每個位元組進行了分析,希望對大家的理解有所幫助。