java源码阅读之java.lang.Enum

之所以要研究这个类，因为它是java中所有枚举的父类，本文基于JDK1.9.0的java源码进行展开。

一、类定义：

public abstract class Enum<E extends Enum<E>>
        implements Comparable<E>, Serializable {

可以看到Enum是一个虚基类，并且实现了Comparable接口和序列化接口。Enum类的泛型，必须是继承自Enum的子类。

二、成员常量和取值器：

1、成员常量name，被声明为final类型，意为不可变，同时只提供取值器。

    private final String name;

    public final String name() {
        return name;
    }

2、成员常量ordinal，被声明为final类型，意为不可变，同时只提供取值器。

    private final int ordinal;

    public final int ordinal() {
        return ordinal;
    }

三、构造函数：

构造函数被定义成protected，参数有两个，分别是name和ordinal，和成员常量相呼应。

    protected Enum(String name, int ordinal) {
        this.name = name;
        this.ordinal = ordinal;
    }

四、公开的方法：

1、toString() 方法，返回成员常量name的值。

    public String toString() {
        return name;
    }

2、equals()方法，参数为Object类型，方法内部判断是不是和this指向同一对象。注意这个方法final被修饰，也就是说枚举不可以覆写这个类。

    public final boolean equals(Object other) {
        return this==other;
    }

3、hashCode()方法，委托父类执行，即Object类的hashCode方法执行。注意这个方法final被修饰，也就是说枚举不可以覆写这个类。

    public final int hashCode() {
        return super.hashCode();
    }

4、clone(）方法，直接抛出异常，不支持拷贝。这也符合枚举唯一的特性。值得注意的是，这个方法被定义成protected，也就是只能包内和子类可见，并且不可以覆写。

    protected final Object clone() throws CloneNotSupportedException {
        throw new CloneNotSupportedException();
    }

5、compareTo()方法，有这个方法，一方面是因为Enum类实现了Comparable接口，一方面也符合枚举可以比较的特点。值得注意的是，方法内部可以看出，要求比较的对象必须是相同枚举类型的，否则便会引起ClassCastException异常。对相同类型枚举值，比较的则是它们的成员常量ordinal大小。

    public final int compareTo(E o) {
        Enum<?> other = (Enum<?>)o;
        Enum<E> self = this;
        if (self.getClass() != other.getClass() && // optimization
            self.getDeclaringClass() != other.getDeclaringClass())
            throw new ClassCastException();
        return self.ordinal - other.ordinal;
    }

6、getDeclaringClass()方法，这个方法在compareTo()方法中出现了。

    @SuppressWarnings("unchecked")
    public final Class<E> getDeclaringClass() {
        Class<?> clazz = getClass();
        Class<?> zuper = clazz.getSuperclass();
        return (zuper == Enum.class) ? (Class<E>)clazz : (Class<E>)zuper;
    }

7、valueOf方法，通过参数name来返回枚举值，注意，如果name没有与之对应的枚举，返回的不是null，而是抛出异常。

   public static <T extends Enum<T>> T valueOf(Class<T> enumType,
                                                String name) {
        T result = enumType.
		().get(name);
        if (result != null)
            return result;
        if (name == null)
            throw new NullPointerException("Name is null");
        throw new IllegalArgumentException(
            "No enum constant " + enumType.getCanonicalName() + "." + name);
    }

五、受保护和私有方法：

（1）finallize()方法，这个没什么好说的，臭名昭著以至于被启用。

    @SuppressWarnings("deprecation")
    protected final void finalize() { }

（2）readObject方法。注释信息很重要，就是防治反序列化的，使用private来定义方法，且在方法内部抛出异常。目的就是为了维护枚举值的唯一性。

    /**
     * prevent default deserializatio
     */
    private void readObject(ObjectInputStream in) throws IOException,
        ClassNotFoundException {
        throw new InvalidObjectException("can't deserialize enum");
    }

（3）readObjectNoData()方法，同readObject方法一样，都是为了防止反序列化的。

    private void readObjectNoData() throws ObjectStreamException {
        throw new InvalidObjectException("can't deserialize enum");
    }

六、遗留问题：

getDeclaringClass()方法内部的实现，是什么原理？

java源码阅读之java.lang.Enum

猜你喜欢