枚举类和注解

1. 枚举类

• 类的对象只有有限个，确定的。例如：
  • 星期：Monday(星期一)、…、Sunday(星期天)
  • 季节：Spring(春节)…Winter(冬天)
  • 就职状态：Busy、Free、Vocation、Dimission
• 当需要定义一组常量时，强烈建议使用枚举类。

1.1 枚举类的实现

• JDK1.5之前需要自定义枚举类；
• JDK 1.5 新增的 enum 关键字用于定义枚举类。
  若枚举只有一个对象, 则可以作为一种单例模式的实现方式。

1.2 枚举类的属性

• 枚举类对象的属性不应允许被改动, 所以应该使用 private final 修饰；
  public static final Season SPRING = new Season("春天", "春暖花开");
• 枚举类的使用 private final 修饰的属性应该在构造器中为其赋值;
• 若枚举类显式的定义了带参数的构造器, 则在列出枚举值时也必须对应的传入参数.

1.3 自定义枚举类

• 私有化类的构造器，保证不能在类的外部创建其对象；
• 在类的内部创建枚举类的实例。声明为：public static final；
• 对象如果有实例变量，应该声明为private final，并在构造器中初始化。

package com.feng.enumandAnno;

/**
 * 自定义枚举类
 * @author feng
 * @create 2021-04-16 12:46
 */
class Season {
    //声明实例变量
    private final String SEASONNAME;
    private final String SEASONDESC;

    //私有化类的构造器
    private Season (String seasonName,String seasonDesc) {
        this.SEASONNAME = seasonName;
        this.SEASONDESC = seasonDesc;
    }

    //创建枚举类的实例
    private final static Season SPRING = new Season("春天", "春暖花开");
    private static final Season SUMMER = new Season("夏天", "夏日炎炎");
    private static final Season AUTUMN = new Season("秋天", "秋高气爽");
    private static final Season WINTER = new Season("冬天", "白雪皑皑");
}

1.4 使用enum 定义枚举类

• 使用 enum 定义的枚举类默认继承了 java.lang.Enum类,因此不能再继承其他类;
• 枚举类的构造器只能使用 private 权限修饰符;
• 枚举类的所有实例必须在枚举类中显式列出(, 分隔 ; 结尾)。列出的实例系统会自动添加 public static final 修饰;
• 必须在枚举类的第一行声明枚举类对象.

1.4.1 实现接口的枚举类

• 和普通 Java 类一样，枚举类可以实现一个或多个接口；
• 若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可；
• 若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式,则可以让每个枚举值分别来实现该方法。

2. 注解

2.1 注解的定义

• 从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)；
• Annotation 其实就是代码里的 特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
• Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation的 “name=value” 对中。
• 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
• 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

2.2 常见的Annotation

使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素.

2.2.1 生成文档相关的注解

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

package com.feng.annotation;

/**
 * @author feng
 * @create 2021-04-16 14:57
 * @version 1.0
 * @see java.lang.Math
 */
public class JavadocTest {

    /**
     * 程序的主方法，程序的入口
     * @param args String[] 命令行参数
     */
    public static void main(String[] args) {
    }

    /**
     * 求圆面积的方法
     * @param radius 圆的半径值
     * @return double 圆的面积
     */
    public static double getArea(double radius){
        return Math.PI * radius * radius;
    }
}

2.2.2 在编译时进行格式检测（JDK内置的3个注解）

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

package com.feng.annotation;

/**
 * @author feng
 * @create 2021-04-16 15:07
 */
public class AnnotationTest {

    public static void main(String[] args) {

        @SuppressWarnings("unused")
        int a = 10;
    }

    @Deprecated
    public void print(){
        System.out.println("过时的方法");
    }

    @Override
    public String toString() {
        return "重写的toString方法()";
    }
}

2.2.3 替代配置文件

• Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署;
• spring等框架的相关配置。

2.3 自定义 Annotation

• 定义新的 Annotation 类型使用 @interface 关键字；
• 自定义注解自动继承了java.lang.annotation.Annotation 接口；
• Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String 类型 、Class 类型 、enum 类型 、Annotation 类型 、以上所有类型的 数组。
• 没有成员定义的 Annotation 称为标记，包含成员变量的 Annotation 称为元数据 Annotation。
  自定义注解必须配上注解的信息处理流程才有意义。

2.3.1 JDK 中的元注解

• JDK 的元 Annotation 用于修饰其他 Annotation 定义;
• JDK5.0提供了4个标准的meta-annotation类型，分别是:
  Retention,Target,Documented,Inherited.
• @Retention:只能用于修饰一个 Annotation 定义,用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用
  @Rentention 时必须为该 value 成员变量指定值:
  • RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释;
  • RetentionPolicy.CLASS:在class文件中有效（即class保留），当运行 Java 程序时, JVM不会保留注解,这是默认值;
  • RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行Java程序时,JVM会保留注释。程序可以通过反射获取该注释。
• @Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。
• @Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的;
• 定义为Documented的注解必须设置Retention值为RUNTIME.
• @Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

2.4 利用反射获取注解信息

• JDK 5.0 在 java.lang.reflect 包下新增了AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素;
• 当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取.
• 程序可以调用 AnnotatedElement对象的方法来访问 Annotation 信息

2.5 JDK8 中注解的新特性

• JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER,TYPE_USE;
• 在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方.
  ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

package com.feng.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

/**
 * @author feng
 * @create 2021-04-16 17:56
 */
@MyAnnotation3
public class AnnotationTest1<U> {

    @MyAnnotation2
    private String name;

    public static void main(String[] args) {
        AnnotationTest1<@MyAnnotation3 String> t = null;
        int a = (@MyAnnotation3 int) 2L;
        @MyAnnotation3
        int b = 10;
    }

    public static <@MyAnnotation3 U> void method(U u){
    }


    public static void test(@MyAnnotation3 String arg) throws @MyAnnotation3 Exception {
    }
}

@Target(ElementType.TYPE_USE)
@interface MyAnnotation3{
}