Java基础（十）——枚举与注解 Craftsman

一、枚举

1、介绍

　　枚举类：类的对象只有有限个，确定的。当需要定义一组常量时，强烈建议使用枚举类。如果枚举类中只有一个对象，则可以作为单例模式的实现。
　　使用 enum 定义的枚举类默认继承了 java.lang.Enum类，因此不能再继承其他类。

2、枚举的实现

　　代码示例：方式一，JDK 5.0 之前，自定义枚举类

public class SeasonEnum {

    // 枚举当前类的多个对象
    public static final SeasonEnum SPRING = new SeasonEnum("01", "春天");
    public static final SeasonEnum SUMMER = new SeasonEnum("02", "夏天");
    public static final SeasonEnum AUTUMN = new SeasonEnum("03", "秋天");
    public static final SeasonEnum WINTER = new SeasonEnum("04", "冬天");

    private SeasonEnum(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    private final String code;
    private final String desc;

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }
}

　　代码示例：方式二，JDK 5.0，可以使用 enum 关键字定义枚举

public enum SeasonEnum {

    // 枚举当前类的多个对象
    SPRING("01", "春天"),
    SUMMER("02", "夏天"),
    AUTUMN("03", "秋天"),
    WINTER("04", "冬天");

    public static final Map<String, SeasonEnum> map = new HashMap<>();

    static {
        for (SeasonEnum e : values()) {
            map.put(e.code, e);
        }
    }

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

    private final String code;
    private final String desc;

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

}

3、枚举实现接口

public enum SeasonEnum implements Info {

    // 枚举当前类的多个对象
    SPRING("01", "春天") {
        @Override
        public void show() {
            System.out.println("春暖花开");
        }
    },
    SUMMER("02", "夏天") {
        @Override
        public void show() {
            System.out.println("夏日炎炎");
        }
    },
    AUTUMN("03", "秋天"),
    WINTER("04", "冬天");

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

    private final String code;
    private final String desc;

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

    public void show() {
        System.out.println("我的天气");
    }

}

interface Info {
    void show();
}

4、API

　　values()方法：返回所有的枚举类型的对象。
　　valueOf(String str)：检查该字符串是不是枚举类对象的"名字"。如不是，会有运行时异常：IllegalArgumentException。
　　toString()：返回当前枚举类对象常量的名称。

二、注解

1、介绍

　　从 JDK 5.0 开始，Java 增加了对元数据（MetaData）的支持，也就是Annotation（注解）。
　　Annotation 其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过使用 Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
　　一定程度上，可以说：框架 = 注解 + 反射 + 设计模式。

2、示例

　　示例一、生成文档相关

　　@author：标明开发该类模块的作者，多个作者之间使用,分割。
　　@version：标明该类模块的版本。
　　@see：参考转向，也就是相关主题。
　　@since：从哪个版本开始增加的。
　　@param：对方法中某参数的说明，如果没有参数就不能写。
　　@return：对方法返回值的说明，如果方法的返回值类型是void就不能写。
　　@exception：对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写。

　　示例二、在编译时进行格式检查（JDK内置的三个基本注解）

　　@Override：限定重写父类方法，该注解只能用于方法。
　　@Deprecated：用于表示所修饰的元素（类，方法等）已过时。通常是因为所修饰的结构危险或存在更好的选择。
　　@SuppressWarnings：抑制编译器警告。

3、自定义注解

　　代码示例：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD})
public @interface MyAnnotation {
    String value() default "baidu";
}

@MyAnnotation()
public class Person {
}
    
public class Main {
    public static void main(String[] args) {
        // 通过反射获取Person类的注解
        Class<Person> clazz = Person.class;
        MyAnnotation annotation = clazz.getAnnotation(MyAnnotation.class);

        // 获取注解的值
        String value = annotation.value();
        System.out.println(value); // baidu(输出了默认值)
    }
}

4、元注解

　　JDK 的元注解用于修饰其他注解定义。除了上面自定义注解用到的两个，JDK5.0提供了4个标准的元注解，分别是：@Documented、@Inherited、@Retention、@Target。
　　@Retention：用于指定注解的生命周期，它包含一个RetentionPolicy枚举类型的成员变量。
　　源码示例：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}
    
public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

　　源码中的英文注释写的很清楚，下面翻译一下：
　　RetentionPolicy.SOURCE：在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释。
　　RetentionPolicy.CLASS：在class文件中有效（即class保留），当运行 Java 程序时，JVM不会保留注解。这是默认值。
　　RetentionPolicy.RUNTIME：在运行时有效（即运行时保留），当运行 Java 程序时，JVM 会保留注释。只有声明为RUNTIME生命周期的注解，才可以通过反射获取该注释。
　　@Target：用于指定注解能用于修饰哪些程序元素，它包含一个ElementType枚举类型的成员变量。
　　源码示例：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    ElementType[] value();
}

public enum ElementType {
    // 用于修饰类、接口，或者enum声明
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,
    
    // 用于修饰域
    /** Field declaration (includes enum constants) */
    FIELD,
    
    // 用于修饰方法
    /** Method declaration */
    METHOD,
    
    // 用于修饰参数
    /** Formal parameter declaration */
    PARAMETER,
    
    // 用于修饰构造器
    /** Constructor declaration */
    CONSTRUCTOR,
    
    // 用于修饰局部变量
    /** Local variable declaration */
    LOCAL_VARIABLE,
    
    // 用于修饰注解
    /** Annotation type declaration */
    ANNOTATION_TYPE,
    
    // 用于修饰包
    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

　　@Documented：用于指定被该注解修饰的类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。定义为Documented的注解必须设置Retention值为RUNTIME。
　　@Inherited：被它修饰的注解将具有继承性。如果某个类使用了被@Inherited 修饰的注解，则其子类将自动具有该注解。

三、JDK8的新特性

1、介绍

　　Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。

2、可重复注解

　　代码示例：方式一，JDK8之前

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotation {
    String value() default "baidu";
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

//@MyAnnotation("xiaoming")
//@MyAnnotation("xiaohong")
@MyAnnotations({@MyAnnotation("xiaoming"), @MyAnnotation("xiaohong")})
public class Person {
    private int age;

    public void say() {
    }
}

　　代码示例：方式二，JDK8之后

// 注：MyAnnotation的Target和Retention等元注解须与MyAnnotations相同
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotation {
    String value() default "baidu";
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

@MyAnnotation("xiaoming")
@MyAnnotation("xiaohong")
public class Person {
    private int age;

    public void say() {
    }
}

3、类型注解

　　在Java 8之前，注解只能在声明的地方使用。Java8开始，注解可以应用在任何地方。
　　ElementType.TYPE_PARAMETER：表示该注解能写在类型变量的声明语句中（如：泛型声明）。
　　ElementType.TYPE_USE：表示该注解能写在使用类型的任何语句中。
　　代码示例：TYPE_PARAMETER

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.TYPE_PARAMETER})
public @interface MyAnnotation {
    String value() default "baidu";
}

@MyAnnotation
public class Person<@MyAnnotation T> {
    private T age;

    public void say() throws RuntimeException {
        List<String> list = new ArrayList<>();

        int num = (int) 10L;
    }
}

　　代码示例：TYPE_USE

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
public @interface MyAnnotation {
    String value() default "baidu";
}

@MyAnnotation
public class Person<@MyAnnotation T> {
    private T age;

    public void say() throws @MyAnnotation RuntimeException {
        List<@MyAnnotation String> list = new ArrayList<>();

        int num = (@MyAnnotation int) 10L;
    }
}