Java 枚举对象获取Class对象

背景

       在写状态机框架的时候，在状态枚举类型上面加了注解，当通过 getClass() 得到 Class 对象得到注解时，有些情况得不到注解。发现是自己对 Java 枚举了解不够导致，特记录一下。

定义一个方法 getStateDescField(S s) ：从注解@StateConfig指定的字段名称，获取传入 s 对应的字段值。

public static <S> Object getStateDescField(S s) {
        Class clazz = s.getClass();
        if (!clazz.isAnnotationPresent(StateConfig.class)) {
            return null;
        }
        StateConfig stateConfig = (StateConfig) clazz.getAnnotation(StateConfig.class);
        String descField = stateConfig.descField();
        try {
            Field field = clazz.getDeclaredField(descField);
            field.setAccessible(true);
            return field.get(s);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

  入参 S 传入枚举对象，看一下我们使用的一个状态枚举：

@StateConfig(descField = "desc")
public enum OrderStatusEnum {
    CLOSED(-10, "订单关闭"),
    INIT(10, "订单生成"){
        @Override
        public boolean cancelable(Integer openTicketNode) {
            return true;
        }
    },
    PRE_CHECK(15,"待平台预审"){
        @Override
        public boolean cancelable(Integer openTicketNode) {
            return true;
        }
    },
    WAITTING_TO_CHECK(20, "待机构审批"){
        @Override
        public boolean cancelable(Integer openTicketNode) {
            return true;
        }
    },

    WAITTING_TO_LOAN(70, "待机构放款"){
        @Override
        public boolean cancelable(Integer openTicketNode) {
            return true;
        }
    },

    LOANED(80, "已放款");

    private Integer code;
    private String desc;

    OrderStatusEnum(Integer code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    public boolean cancelable(Integer openTicketNode){
        return false;
    }

}

       最后发现，只有 CLOSED 和 LOANED 两个枚举值成功读出了 desc 描述字段值，其余状态枚举读出的都是 null 。很明显，读不出 desc 字段的枚举值INIT、PRE_CHECK 等都重写了方法 cancelable (Integer openTicketNode)，应该就是这里导致出现的问题。

Debug

debug 代码发现，CLOSED 枚举进入 getStateDescField(S s) 方法，得到的 Class 对象是OrderStatusEnum：

但是 INIT 枚举值执行 getStateDescField(S s) 方法，得到的 Class 对象是OrderStatusEnum中的内部类 OrderStatusEnum$1：

而 OrderStatusEnum$1 上是没有 @StateConfig 的，所以返回了 null。

结论：

       这就是为什么推荐 枚举类型获取Class对象时，推荐使用 getDeclaringClass() 方法【java.lang.Enum】的原因了:

    /**
     * Returns the Class object corresponding to this enum constant's
     * enum type.  Two enum constants e1 and  e2 are of the
     * same enum type if and only if
     *   e1.getDeclaringClass() == e2.getDeclaringClass().
     * (The value returned by this method may differ from the one returned
     * by the {@link Object#getClass} method for enum constants with
     * constant-specific class bodies.)
     *
     * @return the Class object corresponding to this enum constant's
     *     enum type
     */
    @SuppressWarnings("unchecked")
    public final Class<E> getDeclaringClass() {
        Class<?> clazz = getClass();
        Class<?> zuper = clazz.getSuperclass();
        return (zuper == Enum.class) ? (Class<E>)clazz : (Class<E>)zuper;
    }

       getDeclaringClass() 会先判断上一级 zuper 是不是 Enum.class。我们通过代码测试，可以知道 CLOSED 和 INIT 对应 getClass()和getSuperclass()方法的结果：

    public static void main(String[] args) {
        System.out.println(OrderStatusEnum.CLOSED.getClass());
        System.out.println(OrderStatusEnum.CLOSED.getClass().getSuperclass());
        System.out.println(OrderStatusEnum.INIT.getClass());
        System.out.println(OrderStatusEnum.INIT.getClass().getSuperclass());
        System.out.println(OrderStatusEnum.INIT.getClass().getSuperclass().getSuperclass());
    }

输出结果：

class OrderStatusEnum
class java.lang.Enum
class OrderStatusEnum$1
class OrderStatusEnum
class java.lang.Enum

      可以看到，实现了方法的枚举值INIT需要调用两次 getSuperclass() 方法才能得到 java.lang.Enum 的Class对象，调用一次 getSuperclass() 方法刚好可以得到OrderStatusEnum的Class 对象。而 CLOSED 枚举值直接getClass()就得到OrderStatusEnum的Class 对象。所以 getDeclaringClass() 方法能确保 INIT 和CLOSED 获取到的都是 OrderStatusEnum的Class 对象。

       另外我们通过命令编译 javac OrderStatusEnum.java，确实可以看到 INIT、PRE_CHECK、WAITTING_TO_CHECK、WAITTING_TO_LOAN 被编译成了四个内部类：

使用 javap -c 命令可以看到 OrderStatusEnum 继承了 Enum 类：

       INIT 等继承覆盖了 OrderStatusEnum 中的 cancelable 方法，而且上面 INIT.getClass().getSuperClass 为 OrderStatusEnum ，所以 INIT 对应的 OrderStatusEnum$1 应该继承了 OrderStatusEnum，但是一时不知道怎么反编译 OrderStatusEnum$1查看验证，麻烦有知道的告诉一下哈～