第10章 枚举类和注解

1.枚举类的使用

枚举类的实现：

在JDK1.5之前需要自定义枚举类

在JDK1.5之后新增了enum关键字用于定义枚举类

枚举类的属性：

枚举类对象的属性不应允许被改动，所以应该使用private final进行修饰。（若枚举只有一个对象，则可以作为一种单例模式的实现方式，即private final 类名 instance = new 类名（））

枚举类使用private final修饰的属性，应该在构造器中为其赋值。

若枚举类显示的定义了带参数的构造器，则在列出枚举值时也必须对应的传入参数。

枚举类的使用：

枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类。

当需要定义一组常量时，强烈建议使用枚举类。

如果枚举类中只有一个对象，则可以作为单例模式的实现方式。直接通过private final进行修饰

package Program;

/**
 * 一、枚举类的使用
 * 枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类。
 * 当需要定义一组常量时，强烈建议使用枚举类。
 * 如果枚举类中只有一个对象，则可以作为单例模式的实现方式。直接通过private final进行修饰
 *
 * 二、如何定义枚举类
 * 方式一：jdk5.0之前，自定义枚举类
 * 方式二：jdk5.0时，可以使用enum关键字定义枚举类(说明，该枚举类继承于java.lang.Enum类)
 *
 * 三、Enum类中的常用方法
 * values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
 * valueOf(String str)：可以把一个字符串转为对应的枚举类对象。要求字符
 *                      串必须是枚举类对象的“名字”。如不是，会有运行时
 *                      异常：IllegalArgumentException。
 * toString()：返回当前枚举类对象常量的名称
 *
 * @author banana
 * @create 2023-04-25 19:45
 */
public class Program1 {

    public static void main(String[] args) {
        System.out.println(Season.AUTUMN);
        System.out.println(Season1.SPRING);

        //1. values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
        Season1[] values = Season1.values();
        for(int i = 0; i < values.length; i ++) System.out.println(values[i]);

        //2. valueOf(String objname)：返回枚举类中对象名是objName的对象
        // 如没有该对象，会有运行时异常：IllegalArgumentException。
        Season1 winter = Season1.valueOf("WINTER");
        System.out.println(winter);


        //3. toString()：返回当前枚举类对象常量的名称(不重写的情况下)
        System.out.println(Season1.SPRING);
    }


}


//方式一、自动以枚举类
class Season{
    //1.声明Season对象的属性:private final修饰
    private final String seasonName;
    private final String seasonDesc;


    // 2.私有化类的构造器,并给对象属性赋值
    /*
        原因：因为枚举类中的对象的个数是确定的，如果构造器不私有化
            那么对象可以在类的外部直接通过new创建。

         这与单例模式的原因也差不多类似，不允许在外部通过new的方式
         来创建对象，使得保持对象的唯一性。
    */
    private Season(String seasonName, String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    //3. 提供当前枚举类的多个对象： 通过public static final的进行修饰
    public static final Season SPRING = new Season("春天","春暖花开");
    public static final Season SUMMER = new Season("夏天","夏日炎炎");
    public static final Season AUTUMN = new Season("秋天","秋高气爽");
    public static final Season WINTER = new Season("冬天","冰天雪地");


    //4. 其他诉求1：获取枚举类的属性

    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }


    //5. 其他诉求2：提供tostring方法

    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}


//方法二、使用enum关键字来定义枚举类
//对上面进行重写
enum Season1{
    //1. 提供当前枚举类的对象，多个对象之间用逗号隔开,末尾对象用：结束
    SPRING("春天","春暖花开"),
    SUMMER("夏天","夏日炎炎"),
    AUTUMN("秋天","秋高气爽"),
    WINTER("冬天","冰天雪地");

    //2.声明Season对象的属性:private final修饰
    private final String seasonName;
    private final String seasonDesc;

    // 3.私有化类的构造器,并给对象属性赋值
    private Season1(String seasonName, String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    //4. 其他诉求1：获取枚举类的属性

    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }


    //5. 其他诉求2：提供tostring方法

//    @Override
//    public String toString() {
//        return "Season{" +
//                "seasonName='" + seasonName + '\'' +
//                ", seasonDesc='" + seasonDesc + '\'' +
//                '}';
//    }

}

使用enum关键字定义的枚举类实现接口

package Program;

/**
 * 使用enum关键字定义的枚举类实现接口
 *  情况一: 实现接口，在enum类中实现抽象方法
 *  情况二: 让枚举类的对象分别实现接口中的抽象方法
 *
 * @author banana
 * @create 2023-04-25 21:17
 */
public class Program2 {
    public static void main(String[] args) {
        //通过对象去调用重写的方法
        Season2 spring = Season2.valueOf("SPRING");
        spring.show();
    }
}

interface Info{
    void show();
}

enum Season2 implements Info{

    //情况二： 让枚举类的对象分别实现接口中的抽象方法
    SPRING("春天","春暖花开"){
        @Override
        public void show() {
            System.out.println("这是一个春天！");
        }
    },
    SUMMER("夏天","夏日炎炎"){
        @Override
        public void show() {
            System.out.println("这是一个夏天！");
        }
    },
    AUTUMN("秋天","秋高气爽"){
        @Override
        public void show() {
            System.out.println("这是一个秋天！");
        }
    },
    WINTER("冬天","冰天雪地"){
        @Override
        public void show() {
            System.out.println("这是一个冬天！");
        }
    };

    private final String seasonName;
    private final String seasonDesc;

    private Season2(String seasonName, String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }


    //情况一：实现接口，在enum类中实现抽象方法
    //调用：
    //Season2 spring = Season2.valueOf("SPRING");
    //spring.show();
    //结果： System.out.println("这是一个季节！");
//    @Override
//    public void show() {
//        System.out.println("这是一个季节！");
//    }
}

2.注解类的使用

（1）注解（Annotation）概述

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加 载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员 可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代 码分析工具、开发工具和部署工具可以通过这些补充信息进行验证 或者进行部署。

Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方 法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 对中。

在JavaSE中，注解的使用目的比较简单，例如标记过时的功能， 忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如 用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗 代码和XML配置等。

未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以 上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的 Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上 可以说：框架 = 注解 + 反射 + 设计模式。

（2）常见的Annotation实例

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

示例二： 在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings: 抑制编译器警告

 实例三： 跟踪代码依赖性，实现替代配置文件功能

（3）自定义Annotation

定义新的 Annotation 类型使用 @interface 关键字

自定义注解自动继承了java.lang.annotation.Annotation接口

Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其 方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能 是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、 以上所有类型的数组。

可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始 值可使用 default 关键字

如果只有一个参数成员，建议使用参数名为value

如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认 值。格式是“参数名 = 参数值” ，如果只有一个参数成员，且名称为value， 可以省略“value=”

没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation

注意：自定义注解必须配上注解的信息处理流程（使用放射的方式）才有意义,。

自定义注解通常都会指明两个元注解：Retention、Target

package Program;

/**
 *  如何自定义注解
 *  参照@SupperessWarnings定义
 *  ① 注解声明为@interface类型
 *  ② 内部定义成员，通常使用value表示
 *  ③ 可以指定成员变量，使用default定义默认值
 *  ④ 如果自定义注解没有成员，表明是一个标识作用
 *
 *  如果注解有成员，在使用注解时，需要指明成员的值
 *
 * @author banana
 * @create 2023-04-25 22:18
 */

public @interface MyAnnotation {

    String value() default "hello";
}

//使用
@MyAnnotation
public class A(){
    
}

（4）JDK中的元注解

元注解：对现有的注解进行解释说明的注解。

JDK5.0提供了4个标准的meta-annotation类型,分别是：

Retention

@Retention:只能用于修饰一个Annotation定义，用于指定该Annotation的生命周期。

public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}


在@Rentention中包含了一个RetentionPolicay类型的成员变量，其实一个枚举类：
public enum RetentionPolicy{
	SOURCE,
	CLASS,
	RUNTIME;
}

@Rentention 时必须为该 value 成员变量指定值:
RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释。即在文件编译的时候，执行完javac.exe,生成class字节码文件的时候，将该注解抛弃。

RetentionPolicy.CLASS:在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM不会保留注解。 这是默认值。该文件会保留在class文件中，当我们通过java.exe去执行的时候，它就不会再保留了，即不会加载到内存中了。

RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。即加载到内存中了，可以通过放射的方式来获取。

Target

@Target ：用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于
修饰哪些程序元素。

@Target 也包含一个名为 value 的成员变量。
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

其类型为ElementType，也是一个枚举类型：
public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,		//用于描述类、接口（包括注解类型）或enum声明

    /** 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

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被
javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
定义为Documented的注解必须设置Retention值为RUNTIME。

Inherited

@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被
@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以
继承父类类级别的注解
实际应用中，使用较少

（5）利用反射获取注解信息（在反射部分涉及）

（6）JDK8中注解的新特性

1.可重复的注解

//对于在类上添加两个相同的注解会报错
@MyAnnotation("abc")
@MyAnnotation("hello")
public class AnnotationTest {
}


我们在jdk 1.8 之前可以这样解决
定义一个存放@MyAnnotation注解数组的注解
public @interface MyAnnotations {
    MyAnnotation[] value();
}

这样就可以在一个类上添加多个相同的注解
@MyAnnotations({@MyAnnotation("hello"), @MyAnnotation("abc")})
public class AnnotationTest {
}



在jdk 1.8之后

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

@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "hello";
}

使用@Repeatable注解的时候，相当于把这两个注解绑在一起使用，需要指定相同的注解。

这样也可以实现在一个类上添加多个相同的注解
@MyAnnotation("hello")
@MyAnnotation("abc")
public class AnnotationTest {
}

2.可用于类型的注解

（1）ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。


@Target({ElementType.TYPE_PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String value() default "hello";
}


class abc<@MyAnnotation  T>{    
}



（2）ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

@Target({ElementType.TYPE_PARAMETER,ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String value() default "hello";
}

class abc<@MyAnnotation  T>{
    public void show() throws @MyAnnotation RuntimeException{
        ArrayList<@MyAnnotation String> list = new ArrayList<>();
        int num = (@MyAnnotation int) 10L;
    }
}