2021最新Java枚举类和注解

2022-09-04 21:10:56

枚举类
背景

类的对象只有有限个：
    性别
    星期
    季节
    线程状态
当需要定义一组常量时，强烈建议使用枚举类。
如果枚举类中只有一个对象，则可以作为单例模式的实现方式。

自定义枚举类

import org.junit.Test;

public class EnumTest {
  @Test
  public void test() {
      Season season = Season.SPRING;
      System.out.println(season);  // Season{name='Spring', desc='Warm.'}
  }
}

// 自定义枚举类
class Season {
  // 1. 声明private final的属性
  private final String name;
  private final String desc;

  // 2. private构造器
  private Season(String name, String desc) {
      this.name = name;
      this.desc = desc;
  }

  // 3. 提供当前枚举类的多个public static final对象
  public static final Season SPRING = new Season("Spring", "Warm.");
  public static final Season SUMMER = new Season("Summer", "Hot.");
  public static final Season AUTUMN = new Season("Autumn", "Cool.");
  public static final Season WINTER = new Season("Winter", "Cold.");

  // 4. 获取属性等其他需求
  public String getName() {
      return name;
  }

  public String getDesc() {
      return desc;
  }

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

使用enum关键字

默认继承自java.lang.Enum类。

import org.junit.Test;

public class EnumTest {
  @Test
  public void test1() {
      System.out.println(Season1.class.getSuperclass());  // class java.lang.Enum

      System.out.println(Season1.SPRING);  // SPRING
      System.out.println(Season1.SPRING.getName() + Season1.SPRING.getDesc());  // SpringWarm.
  }
}

// enum关键字
enum Season1 {
  // 1. 提供当前枚举类的对象，使用逗号隔开，末尾对象使用分号结束
  SPRING("Spring", "Warm."),
  SUMMER("Summer", "Hot."),
  AUTUMN("Autumn", "Cool."),
  WINTER("Winter", "Cold.");

  // 2. 声明private final的属性
  private final String name;
  private final String desc;

  // 3. private构造器
  private Season1(String name, String desc) {
      this.name = name;
      this.desc = desc;
  }

  // 4. 其他需求(不重写toString()方法)
  public String getName() {
      return name;
  }

  public String getDesc() {
      return desc;
  }
}

Enum类常用方法

values()：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
valueOf(String str)：可以把一个字符串转为对应的枚举类对象，要求字符串必须是枚举类对象的名字；如不是，会有运行时异常:IllegalArgumentException。
toString()：返回当前枚举类对象常量的名称。

Season1[] values = Season1.values();
System.out.println(Arrays.toString(values));  // [SPRING, SUMMER, AUTUMN, WINTER]

// Season1 season1 = Season1.valueOf("1");  // java.lang.IllegalArgumentException
Season1 season1 = Season1.valueOf("SUMMER");
System.out.println(season1);  // SUMMER

使用enum关键字实现接口

方法一：实现接口，在enum类中实现抽象方法。
方法二：让枚举类对象分别实现接口中的抽象方法。

注解

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

Annotation示例

生成文档注解：

/**
 * @author abc
 * @version 1.0
 */
import org.junit.Test;

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

在编译时进行格式检查：
    @Override：限定重写父类方法，该注解只能用于方法。
    @Deprecated：用于表示所修饰的元素(类、方法等)已过时，通常是因为所修饰的结构危险或存在更好的选择。
    @SuppressWarnings：抑制编译器警告。
跟踪代码依赖性，实现替代配置文件的功能。
    Servlet3.0提供了注解，使得不再需要在web.xml文件中进行Servlet的部署。
    Spring框架中关于事务的管理。

自定义注解

定义新的Annotation类型使用@interface关键字。
自定义注解自动继承了java.lang.annotation.Annotation接口。
Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型以上所有类型的数组。
可以在定义Annotation的成员变量时为其指定初始值，指定成员变量的初始值可使用default关键字。
如果只有一个参数成员，建议使用参数名为value如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名=参数值”，如果只有一个参数成员，且名称为value,可以省略“value=”。
没有成员定义的Annotation称为标记(例如@Override);包含成员变量的Annotation称为元数据Annotation。

// 1. 声明为@interface
public @interface MyAnnotation {
    // 2. 定义内部成员，通常使用value表示
    // 3. 可以使用default关键字指定内部成员默认值
    String value() default "hello";

    // 4. 如果注解没有默认值，表明是标识作用
}

@MyAnnotation
class Person {
    @MyAnnotation("hi")
    public void show() {
        System.out.println("Test.");
    }
}

JDK中的元注解

元注解是对现有注解进行解释说明的注解，JDK5.0提供了4个标准的meta-annotation类型，分别是：

Retention
Target
Documented
Inherited

Retention

@Retention只能用于修饰一个Annotation定义，用于指定该Annotation的生命周期，@Rentention包含一个RetentionPolicy类型的成员变量，使用@Rentention时必须为该value成员变量指定值：

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

参考@SuppressWarnings的源代码：

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

Target

用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些程序元素。@Target中包含一个数组ElementType[] value()，其中枚举类ElementType包含：

public enum ElementType {
    TYPE,
    FIELD,
    METHOD,
    PARAMETER,
    CONSTRUCTOR,
    LOCAL_VARIABLE,
    ANNOTATION_TYPE,
    PACKAGE,
    TYPE_PARAMETER,
    TYPE_USE
}

上一小节中的@SuppressWarnings中的@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})表示@SuppressWarnings可以用来修饰类、枚举类、接口(TYPE)，属性、方法、参数、构造器。
Documented

用于指定被该元Annotation修饰的Annotation类将被javadoc工具提取成文档。默认情况下，javadoc是不包括注解的。

定义为@Documented的注解必须设置@Retention值为RUNTIME。

Inherited

被它修饰的Annotation将具有继承性。如果某个类使用了被@Inherited修饰的Annotation，则其子类将自动具有该注解。

比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解。
实际应用中，使用较少。

JDK8中注解新特性
重复注解

在JDK8之前，通过数组的形式实现重复注解：

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

/*
 * 使用方法
 */
@MyAnnotations({@MyAnnotation(value = "hi"), @MyAnnotation(value = "123")})
public class AnnotationTest {
}

JDK8之后可使用@Repeatable实现重复注解：

/*
 * MyAnnotation定义修改
 * 1. 添加@Repeatable(MyAnnotations.class)
 */
@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
    String value() default "hello";
}

/*
 * 2. MyAnnotations的Target等元注解要和MyAnnotation相同
 */
public @interface MyAnnotations {
    MyAnnotation[] value();
}


/*
 * 使用方法
 */
@MyAnnotation(value = "hi")
@MyAnnotation(value = "123")
public class AnnotationTest {
}

类型注解

JDK8之前，注解只能是在声明的地方所使用，JDK8开始，注解可以应用在任何地方。
JDK8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：
    ElementType.TYPE_PARAMETER：表示该注解能写在类型变量的声明语句中(如：泛型声明)
    ElementType.TYPE_USE：表示该注解能写在使用类型的任何语句中。

@Target(ElementType.TYPE_USE)
public @interface MyAnnotation {
    String value() default "hello";
}

/*
 * 使用方法
 */
class Generic<@MyAnnotation T> {
    public void show() throws @MyAnnotation RuntimeException {
        int num = (@MyAnnotation int) 1000L;
    }
}
上一篇：Mybatis-plus 分页配置


下一篇：枚举、注解、反射与内省