Java笔记：枚举类与注解

1. 枚举类的使用

• 枚举类的理解：类的对象只有有限个，确定的，则称此类为枚举类
• 当需要定义一组常量时，强烈建议使用枚举类
• 如果枚举类中只有一个对象，则可以作为单例模式的实现方式

1.1 如何自定义枚举类

class Season {
	// 1.声明 Season 对象的属性：private final 修饰
	private final String seasonName;
	private final String seasonDesc;
	// 2.私有化类的构造器，并给对象属性赋值
	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;
    }
    // 4.其他诉求2：提供 toString()
    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}

1.2 使用关键字enum定义枚举类

public class SeasonTest {
	public static void main(String[] args) {
		System.out.println(Season.SPRING);// 输出：SPRING
		System.out.println(Season.class.getSuperclass());// 输出：class java.lang.Enum
	}
}

enum Season {
	// 提供当前枚举类的多个对象，多个对象之间用 “,” 隔开，末尾对象用 “;” 结束
	SPRING("春天", "春暖花开"),
    SUMMER("夏天", "夏日炎炎"),
    AUTUMN("秋天", "秋高气爽"),
    WINTER("冬天", "冰天雪地");
    // 声明 Season 对象的属性：private final 修饰
    private final String seasonName;
    private final String seasonDesc;
    // 私有化类的构造器，并给对象属性赋值
    Season(String seasonName, String seasonDesc) {
    	this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }
    // 其他诉求：获取枚举类对象的属性
    public String getSeasonName() {
        return seasonName;
    }

	public String getSeasonDesc() {
        return seasonDesc;
    }
}

说明：定义的枚举类默认继承于 java.lang.Enum 类

1.3 Enum 类中的常用方法

• values()：返回枚举类型的对象数组

  Season[] seasons = Season.values();
  System.out.println(Arrays.toString(seasons));// 输出：[SPRING, SUMMER, AUTUMN, WINTER]
  

• valueOf(String str)：将一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的名字，如果不是，会出现 IllegalArgumentException

  Season spring = Season.valueOf("SPRING");
  System.out.println(spring);// 输出：SPRING
  

• toString()：返回当前枚举类对象常量的名称

  String summer = Season.SUMMER.toString();
  System.out.println(summer);// 输出：SUMMER
  

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

接口定义

interface Info {
    void show();
}

情况一：实现接口，在 enum 类中实现抽象方法

enum Season implements Info{
	// 省略其他代码
	@Override
    public void show() {
        System.out.println("这是一个季节");
    }
}

情况二：让枚举类的对象分别实现接口中的抽象方法

enum Season implements Info{
	SPRING("春天", "春暖花开") {
		@Override
        public void show() {
        	System.out.println("spring is coming");
        }
    },
    SUMMER("夏天", "夏日炎炎") {
        @Override
        public void show() {
            System.out.println("summer is coming");
        }
    },
    AUTUMN("秋天", "秋高气爽") {
        @Override
        public void show() {
            System.out.println("autumn is coming");
        }
    },
    WINTER("冬天", "冰天雪地") {
        @Override
        public void show() {
            System.out.println("winter is coming");
        }
    };
    // 省略其他代码
}

调用

Season spring = Season.valueOf("SPRING");
spring.show();

2. 注解的使用

• 从JDK5.0开始，Java增加了对元数据的支持，也就是注解
• 注解其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理
• 通过使用注解，可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息，代码分析工具，开发工具和部署工具可以通过这些补充信息进行验证或者进行部署
• 注解可以像修饰符一样被使用，可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明，这些信息被保存在注解的“name=value”对中

2.1 常见的注解示例

生成文档相关的注解

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

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

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

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

2.2 自定义注解

定义

public @interface MyAnnotation {
    String value() default "hello";// 如果不指定默认值，直接使用 @MyAnnotation 会报错
}

使用

@MyAnnotation(value = "world")
public class MyClass {
}

说明：

• 自定义注解自动继承了 java.lang.annotation.Annotation 接口
• 内部定义成员，通常使用 value 来表示
• 可以指定成员的默认值，使用 default 来定义
• 如果自定义注解没有成员，则该注解起标识作用
• 如果注解有成员，在使用注解时，需要指定成员的值（有默认值的除外）
• 自定义注解必须配上注解的信息处理流程（使用反射）才有意义

2.3 JDK中的元注解

元注解用于修饰其他注解的定义，JDK5.0 提供了四个标准的元注解类型

Retention

• 指明其修饰的注解的生命周期

• 包含成员 RetentionPolicy value()，没有默认值，需要在使用的时候指定

  RetentionPolicy.SOURCE：在源文件中有效，编译期直接丢弃这种策略的注释
  RetentionPolicy.CLASS：在 class 文件中有效，当运行 Java 程序时，JVM 不会保留注释（默认行为）
  RetentionPolicy.RUNTIME：在运行时有效，当运行 Java 程序时，JVM 会保留注释，程序可以通过反射获取该注释

Target

• 用于指定被修饰的注解能用于修饰哪些程序元素

• 包含成员ElementType[] value();，没有没有默认值，需要在使用的时候指定

  TYPE：类、接口、枚举类
  FIELD：属性
  METHOD：方法
  PARAMETER：参数
  CONSTRUCTOR：构造器
  LOCAL_VARIABLE：局部变量
  ANNOTATION_TYPE：注解类型
  PACKAGE：包

Documented

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

Inherited

• 被修饰的注解将具有继承性，如果某个类使用了该元注解修饰的注解，则其子类将自动具有该注解

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

2.4 通过反射来获取注解信息

参考反射笔记 https://blog.csdn.net/Alice_Lee_Lee/article/details/109026563

2.5 JDK8 中注解的新特性

---

2.5.1 可重复注解

在 JDK8 之前如果要重复的使用注解，要如下实现：

public @interface MyAnnotations {
    MyAnnotation[] value();
}

@MyAnnotations({@MyAnnotation(value = "hello"), @MyAnnotation(value = "world")})
public class MyClass {
}

在 JDK8 之后的解决方式：

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

@MyAnnotation(value = "hello")
@MyAnnotation(value = "world")
public class MyClass {
}

注意：MyAnnotation 的 Retention 注解和 Target 注解的成员值要与 MyAnnotations 的一致，Inherited 注解也要同时使用或同时不使用

2.5.2 类型注解

JDK8 以后，关于元注解 @Target 的成员值类型 ElementType 枚举值多了两个：

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

  @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, TYPE_PARAMETER})
  public @interface MyAnnotation {
  	String value() default "hello";
  }
  

  class MyClass<@MyAnnotation T>{
  }
  

• TYPE_USE：表示该注解能写在使用类型的任何语句中

  @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, TYPE_PARAMETER, TYPE_USE})
  public @interface MyAnnotation {
  	String value() default "hello";
  }
  

  class MyClass<@MyAnnotation T>{
  	public void show() throws @MyAnnotation RuntimeException{
  		ArrayList<@MyAnnotation String> strings = new ArrayList<>();
  		int i = (@MyAnnotation int) 10L;
  	}
  }