[Java] 如何理解 class 文件中字段的 descriptor？

金銀銅鐵
20 阅读4分钟

背景

在日常开发过程中，我们有时候需要查看 class\text{class} 文件的内容。如果我们对 class\text{class} 文件的结构有基本的了解，那么就会事半功倍。由于这个话题很大，而且我自己的水平也有限，所以每次只写一个很小的主题。本文的主题是理解 class\text{class} 文件中字段的 descriptor\text{descriptor}。

要点

  • 字段的 descriptor\text{descriptor} 体现了字段的类型信息，但是泛型中的类型信息不会记录在其中（例如 List<Integer> 中的 Integer 不会记录在 descriptor\text{descriptor} 里）
  • 字段的 descriptor\text{descriptor} 共有三种情况
    • 8\text{8} 个基本类型
    • （除了数组外的）引用类型
    • 数组

示例值

基本类型

字段在 java\text{java} 代码中的类型字段的 descriptor\text{descriptor}
intI
doubleD
longJ

引用类型

字段在 java\text{java} 代码中的类型字段的 descriptor\text{descriptor}
java.lang.ObjectLjava/lang/Object;
java.lang.BooleanLjava/lang/Boolean;
java.util.ListLjava/util/List;

数组

字段在 java\text{java} 代码中的类型字段的 descriptor\text{descriptor}
int[][I
java.lang.Boolean[][Ljava/lang/Boolean;
java.lang.Boolean[][][[Ljava/lang/Boolean;
java.lang.Boolean[][][][[[Ljava/lang/Boolean;

正文

示例代码

请将以下代码保存为 Main.java\text{Main.java}

import java.util.List;
import java.util.Map;

public class Main {
  // base type examples
  byte f1;
  char f2;
  double f3;
  float f4;
  int f5;
  long f6;
  short f7;
  boolean f8;

  // array examples
  int[] f9;
  double[][] f10;
  long[][][][] f11;
  
  // class type examples
  Boolean f12;
  Long f13;
  Object f14;
  List<Integer> f15;
  Map<String, List<Long>> f16;
  List<?> f17;
  Void f18;
  
  // more array examples
  Boolean[] f19;
  Integer[][][] f20;
}

编译

使用以下命令可以编译 Main.java\text{Main.java}

javac Main.java

编译之后，执行 tree . 会看到当前目录下多了一个 Main.class\text{Main.class} 文件 ⬇️

.
├── Main.class
└── Main.java

1 directory, 2 files

查看 class\text{class} 文件的内容

使用以下命令可以查看 Main.class\text{Main.class} 文件的详细内容

javap -v -p Main

完整的结果有点长，我把本文关心的部分复制到的下方 ⬇️ （与本文无关的内容用 ... 表示）

...
public class Main
   ...
{
  byte f1;
    descriptor: B
    flags: (0x0000)

  char f2;
    descriptor: C
    flags: (0x0000)

  double f3;
    descriptor: D
    flags: (0x0000)

  float f4;
    descriptor: F
    flags: (0x0000)

  int f5;
    descriptor: I
    flags: (0x0000)

  long f6;
    descriptor: J
    flags: (0x0000)

  short f7;
    descriptor: S
    flags: (0x0000)

  boolean f8;
    descriptor: Z
    flags: (0x0000)

  int[] f9;
    descriptor: [I
    flags: (0x0000)

  double[][] f10;
    descriptor: [[D
    flags: (0x0000)

  long[][][][] f11;
    descriptor: [[[[J
    flags: (0x0000)

  java.lang.Boolean f12;
    descriptor: Ljava/lang/Boolean;
    flags: (0x0000)

  java.lang.Long f13;
    descriptor: Ljava/lang/Long;
    flags: (0x0000)

  java.lang.Object f14;
    descriptor: Ljava/lang/Object;
    flags: (0x0000)

  java.util.List<java.lang.Integer> f15;
    descriptor: Ljava/util/List;
    flags: (0x0000)
    Signature: #40                          // Ljava/util/List<Ljava/lang/Integer;>;

  java.util.Map<java.lang.String, java.util.List<java.lang.Long>> f16;
    descriptor: Ljava/util/Map;
    flags: (0x0000)
    Signature: #43                          // Ljava/util/Map<Ljava/lang/String;Ljava/util/List<Ljava/lang/Long;>;>;

  java.util.List<?> f17;
    descriptor: Ljava/util/List;
    flags: (0x0000)
    Signature: #45                          // Ljava/util/List<*>;

  java.lang.Void f18;
    descriptor: Ljava/lang/Void;
    flags: (0x0000)

  java.lang.Boolean[] f19;
    descriptor: [Ljava/lang/Boolean;
    flags: (0x0000)

  java.lang.Integer[][][] f20;
    descriptor: [[[Ljava/lang/Integer;
    flags: (0x0000)

  public Main();
    ...
}
...

观察后，会发现 Main.java\text{Main.java} 中的 2020 个字段在上面的结果中都出现了。每个字段都有对应的 descriptor\text{descriptor} 和 flags\text{flags}，有的字段还有 Signature\text{Signature}。本文只关心 descriptor\text{descriptor} 部分。

理解 descriptor\text{descriptor}

The Java® Virtual Machine Specification 中的 4.5. Fields 小节详细介绍了 class\text{class} 文件中 field_info\text{field\_info} 的结构，它的开头是这样的 ⬇️

image.png

descriptor\text{descriptor}，字面意思是描述符，字段的类型信息保存在其中。在 The Java® Virtual Machine Specification 中的 4.3.2. Field Descriptors 小节 有关于字段的 descriptor\text{descriptor} 的描述

image.png

从中可以看到

FieldDescriptor\text{FieldDescriptor} 中的内容是 FieldType\text{FieldType}。

FieldType\text{FieldType} 中是以下三种内容之一

  1. BaseType\text{BaseType}
  2. ClassType\text{ClassType}
  3. ArrayType\text{ArrayType}

1. BaseType\text{BaseType} 分类

BaseType\text{BaseType} 中一共有 8\text{8} 种情况，对应 8\text{8} 种基本类型。 4.3.2. Field Descriptors 小节 中提供了如下的表格 （表格的名称是 Table 4.3-A. Interpretation of field descriptors），表格中的 B, C, D, F, I, J, S, Z\text{B, C, D, F, I, J, S, Z} 对应 BaseType\text{BaseType} 分类下的 8\text{8} 种情况

FieldType termType
Bbyte
Cchar
Ddouble
Ffloat
Iint
Jlong
L ClassName ;Named class or interface type
Sshort
Zboolean
[ ComponentTypeArray of given component type

我们看一下 Main.java\text{Main.java} 中属于 BaseType\text{BaseType} 分类的字段在 Main.class\text{Main.class} 文件中的 descriptor\text{descriptor} ⬇️

image.png

2. ClassType\text{ClassType} 分类

ClassType\text{ClassType} 分类下，对应的内容由以下三部分组成

我们来看几个例子 ⬇️

全限定类名➡️ ClassName\text{ClassName}➡️ L ClassName\text{ClassName} ;
java.lang.Objectjava/lang/ObjectLjava/lang/Object;
java.lang.Booleanjava/lang/BooleanLjava/lang/Boolean;
java.util.Listjava/util/ListLjava/util/List;

我们看一下 Main.java\text{Main.java} 中属于 ClassType\text{ClassType} 分类的字段在 Main.class\text{Main.class} 文件中的 descriptor\text{descriptor} ⬇️ image.png

3. ArrayType\text{ArrayType} 分类

ArrayType\text{ArrayType} 分类下，对应的内容由以下三部分组成

  • [
  • ComponentType\text{ComponentType} （它的内容是 $\text{FieldType}，所以这里出现了递归的情况）

我们来看几个例子 ⬇️

java\text{java} 代码中的类型➡️ ComponentType\text{ComponentType}➡️ [ ComponentType\text{ComponentType} 
int[]I[I
java.lang.Boolean[]Ljava/lang/Boolean;[Ljava/lang/Boolean;
java.lang.Boolean[][][Ljava/lang/Boolean;
(这里用到了上一行最后一列的结果)		[[Ljava/lang/Boolean;
java.lang.Boolean[][][][[Ljava/lang/Boolean;
(这里用到了上一行最后一列的结果)		[[[Ljava/lang/Boolean;

我们看一下 Main.java\text{Main.java} 中属于 ArrayType\text{ArrayType} 分类的字段在 Main.class\text{Main.class} 文件中的 descriptor\text{descriptor} ⬇️

image.png

image.png

至此，相信您已经了解了 class\text{class} 文件中字段的 descriptor\text{descriptor} 的格式。

参考资料

The Java® Virtual Machine Specification 中的

avatar
文章
阅读
粉丝