ToB企服应用市场:ToB评测及商务社交产业平台

标题: java中的enum-java中特殊的class；通过字节码来分析enum构成 [打印本页]
作者: 科技颠覆者    时间: 2024-8-29 18:54
标题: java中的enum-java中特殊的class；通过字节码来分析enum构成
§1 先思考一个问题

先思考一个问题：我们在enum类里，可以直接利用 values() 或 valueOf(String name) 方法，我们也没有在enum类里定义这两个方法，怎么就能直接利用呢？

 
这里先按下不表。
下面是正文。
§2 enum类及其编译后的字节码

在java编程中，我们常常会定义和利用枚举。
简单的enum类及其字节码概览

一个简单的 enum 类定义如下：
  1. public enum Weekday {
  2.     MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY;
  3. }
复制代码
 
 
Java Enum类型的语法布局尽管和java类的语法不一样，应该说差别比力大。但是经过编译器编译之后产生的是一个class文件。我们反编译该class文件后，可以看到实际上是生成了一个class类，该类继承了 java.lang.Enum，其中包罗了常量和方法。
 
首先，编译 Weekday.java 文件：
javac Weekday.java
经过 javac 编译后得到一个名字为Weekday.class的class字节码文件。然后，利用 javap 命令查看生成的字节码文件源码：
javap -c Weekday.class
生成的字节码文件源码大概会类似于下面的内容（这是经过简化和部分省略的例子）：
  1. Compiled from "Weekday.java"
  2. public final class Weekday extends java.lang.Enum<Weekday> {
  3.   public static final Weekday MONDAY;
  4.   public static final Weekday TUESDAY;
  5.   public static final Weekday WEDNESDAY;
  6.   public static final Weekday THURSDAY;
  7.   public static final Weekday FRIDAY;
  8.   public static final Weekday SATURDAY;
  9.   public static final Weekday SUNDAY;
  10.    
  11.   static {};
  12.   private Weekday();
  13.   public static Weekday[] values();
  14.   public static Weekday valueOf(java.lang.String);
  15. }
复制代码
 
这段字节码文件源码表现了 Weekday 枚举类中的常量以及一些生成的方法，比方 values() 和 valueOf(String) 等。实际的字节码文件源码会更加复杂，其中包含了更多的细节和信息。
以是实际上Enum类型就是以Java类来实现的，没有什么新的特点，只不过java编译器帮我们做了语法的解析和编译。
 
附图：在IDEA Terminal窗口中所执行的命令


 
 
 
功能丰富的enum类 及其字节码详解

我们知道，enum 类型可以包含除了默认的 name() 和 ordinal() 方法之外的扩展信息。我们可以为每个枚举常量添加字段、构造函数、方法等，使得枚举类型更加灵活和功能丰富。
我们看下面的 Weekday枚举。
  1. public enum Weekday {
  2.     MONDAY(1, "星期一"), TUESDAY(2, "星期二"), WEDNESDAY(3, "星期三"), THURSDAY(4, "星期四"), FRIDAY(5, "星期五"), SATURDAY(6, "星期六"), SUNDAY(7, "星期日");
  4.     private final int dayNo;
  5.     private final String name;
  7.     private Weekday(int dayNo, String name) {
  8.         this.dayNo = dayNo;
  9.         this.name = name;
  10.     }
  12.     public static Weekday getEnum(int dayNo) {
  13.         for (Weekday d : values()) {
  14.             if (d.dayNo == dayNo)
  15.                 return d;
  16.         }
  17.         return null;
  18.     }
  19. }
复制代码
 
下面是javap打印出来的完备的字节码源码：
  1. Compiled from "Weekday.java"
  2. public final class com.sms.service.Weekday extends java.lang.Enum<com.sms.service.Weekday> {
  3.   public static final com.sms.service.Weekday MONDAY;
  4.   public static final com.sms.service.Weekday TUESDAY;
  5.   public static final com.sms.service.Weekday WEDNESDAY;
  6.   public static final com.sms.service.Weekday THURSDAY;
  7.   public static final com.sms.service.Weekday FRIDAY;
  8.   public static final com.sms.service.Weekday SATURDAY;
  9.   public static final com.sms.service.Weekday SUNDAY;
  11.   public static com.sms.service.Weekday[] values();
  12.     Code:
  13.        0: getstatic     #25                 // Field $VALUES:[Lcom/sms/service/Weekday;
  14.        3: invokevirtual #29                 // Method "[Lcom/sms/service/Weekday;".clone:()Ljava/lang/Object;
  15.        6: checkcast     #30                 // class "[Lcom/sms/service/Weekday;"
  16.        9: areturn
  18.   public static com.sms.service.Weekday valueOf(java.lang.String);
  19.     Code:
  20.        0: ldc           #1                  // class com/sms/service/Weekday
  21.        2: aload_0
  22.        3: invokestatic  #34                 // Method java/lang/Enum.valueOf:(Ljava/lang/Class;Ljava/lang/String;)Ljava/lang/Enum;
  23.        6: checkcast     #1                  // class com/sms/service/Weekday
  24.        9: areturn
  26.   public static com.sms.service.Weekday getEnum(int);
  27.     Code:
  28.        0: invokestatic  #52                 // Method values:()[Lcom/sms/service/Weekday;
  29.        3: astore_1
  30.        4: aload_1
  31.        5: arraylength
  32.        6: istore_2
  33.        7: iconst_0
  34.        8: istore_3
  35.        9: iload_3
  36.       10: iload_2
  37.       11: if_icmpge     37
  38.       14: aload_1
  39.       15: iload_3
  40.       16: aaload
  41.       17: astore        4
  42.       19: aload         4
  43.       21: getfield      #44                 // Field dayNo:I
  44.       24: iload_0
  45.       25: if_icmpne     31
  46.       28: aload         4
  47.       30: areturn
  48.       31: iinc          3, 1
  49.       34: goto          9
  50.       37: aconst_null
  51.       38: areturn
  53.   static {};
  54.     Code:
  55.        0: new           #1                  // class com/sms/service/Weekday
  56.        3: dup
  57.        4: ldc           #56                 // String MONDAY
  58.        6: iconst_0
  59.        7: iconst_1
  60.        8: ldc           #57                 // String 星期一
  61.       10: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  62.       13: putstatic     #3                  // Field MONDAY:Lcom/sms/service/Weekday;
  63.       16: new           #1                  // class com/sms/service/Weekday
  64.       19: dup
  65.       20: ldc           #62                 // String TUESDAY
  66.       22: iconst_1
  67.       23: iconst_2
  68.       24: ldc           #63                 // String 星期二
  69.       26: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  70.       29: putstatic     #7                  // Field TUESDAY:Lcom/sms/service/Weekday;
  71.       32: new           #1                  // class com/sms/service/Weekday
  72.       35: dup
  73.       36: ldc           #65                 // String WEDNESDAY
  74.       38: iconst_2
  75.       39: iconst_3
  76.       40: ldc           #66                 // String 星期三
  77.       42: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  78.       45: putstatic     #10                 // Field WEDNESDAY:Lcom/sms/service/Weekday;
  79.       48: new           #1                  // class com/sms/service/Weekday
  80.       51: dup
  81.       52: ldc           #68                 // String THURSDAY
  82.       54: iconst_3
  83.       55: iconst_4
  84.       56: ldc           #69                 // String 星期四
  85.       58: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  86.       61: putstatic     #13                 // Field THURSDAY:Lcom/sms/service/Weekday;
  87.       64: new           #1                  // class com/sms/service/Weekday
  88.       67: dup
  89.       68: ldc           #71                 // String FRIDAY
  90.       70: iconst_4
  91.       71: iconst_5
  92.       72: ldc           #72                 // String 星期五
  93.       74: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  94.       77: putstatic     #16                 // Field FRIDAY:Lcom/sms/service/Weekday;
  95.       80: new           #1                  // class com/sms/service/Weekday
  96.       83: dup
  97.       84: ldc           #74                 // String SATURDAY
  98.       86: iconst_5
  99.       87: bipush        6
  100.       89: ldc           #75                 // String 星期六
  101.       91: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  102.       94: putstatic     #19                 // Field SATURDAY:Lcom/sms/service/Weekday;
  103.       97: new           #1                  // class com/sms/service/Weekday
  104.      100: dup
  105.      101: ldc           #77                 // String SUNDAY
  106.      103: bipush        6
  107.      105: bipush        7
  108.      107: ldc           #78                 // String 星期日
  109.      109: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  110.      112: putstatic     #22                 // Field SUNDAY:Lcom/sms/service/Weekday;
  111.      115: invokestatic  #80                 // Method $values:()[Lcom/sms/service/Weekday;
  112.      118: putstatic     #25                 // Field $VALUES:[Lcom/sms/service/Weekday;
  113.      121: return
  114. }
复制代码
View Code 
由字节码可见，javac为这个class生成了7个Weekday类型的公共静态常量MODAY、TUESDAY、...、SUNDAY，它们在这个class的static代码块中得到初始化。
static代码块的大抵逻辑是：
1. 创建类型为Weekday的实例 new Weekday("MONDAY", 0, 1, "星期一")，赋值给静态变量MONDAY。见下方字节码片段。
  1. 0: new           #1                  // class com/sms/service/Weekday
  2. 3: dup
  3. 4: ldc           #56                 // String MONDAY
  4. 6: iconst_0
  5. 7: iconst_1
  6. 8: ldc           #57                 // String 星期一
  7. 10: invokespecial #59                 // Method "<init>":(Ljava/lang/String;IILjava/lang/String;)V
  8. 13: putstatic     #3                  // Field MONDAY:Lcom/sms/service/Weekday;
复制代码
View Code2. 同第一步，依次创建实例、给静态变量TUESDAY、...、SUNDAY赋值。
3. 调用静态方法 values()。
4. 给静态变量 $VALUES 赋值。
 
§3 java.lang.Enum类先容

javadoc及类声明
/*
This is the common base class of all Java language enumeration types. More information about enums, including descriptions of the implicitly declared methods synthesized by the compiler, can be found in section 8.9 of The Java™ Language Specification.
Note that when using an enumeration type as the type of a set or as the type of the keys in a map, specialized and efficient set and map implementations are available.
Since: 1.5
See Also: Class.getEnumConstants(), java.util.EnumSet, java.util.EnumMap
*/
public abstract class Enum
     implements Comparable, Serializable {
 
Enum类的成员

 
从中我们get到：
① Enum是所有Java枚举类型的公共基类。
② Enum是一个抽象类，我们不能new一个Enum实例。
Enum的默认受保护构造器Enum(String, int)，第一个参数是我们定义的枚举常量的名称，对应的field是Enum#name，第二个参数指的是枚举的顺序，对应的field是Enum#ordinal。
Enum定义了valueOf方法，用以根据枚举常量的name来获取枚举常量。
 
枚举虽然是class，但是并不支持继承
这大概也佐证了enum是一种特殊的class。
不过，枚举支持实现接口。我们项目中，几乎所有enum都实现了EnumAbility这个interface。这表现了java对面向接口编程理论的最强盛的支持。
 
§4 回到文章开头的问题

回到文章开头的问题。为什么我们在创建的enum类里可以直接访问 values() 或 valueOf(String) 方法呢？
从上面的字节码源码可以看出来，这2个方法是 java编译器 给加上的。换句话说，在 Java 中，所有的枚举类型都是继承自 java.lang.Enum 类。Java编译器在编译Enum 类时，会生成一些方法，其中包罗 values() 和 valueOf(String name) 方法。由于这些方法是在编译时由编译器自动生成并添加到枚举类中的，以是，我们在任何枚举类中都可以直接利用这两个方法，而无需显式地在枚举类中定义它们。
就像我们在model类上添加 lombok工具的 @Data 注解，就可以利用这个model对象的getter和setter。
就像我们在枚举类上添加 enumgen工具的 @GetByEnum 注解，就可以利用 getBeanByCode(code)。
 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4