枚举类与注解

上一篇：Java常用类——第二部分

---

10. 枚举类与注解

10.1 枚举类的使用

1. 枚举类的概念

当一个类的对象只有有限个且是确定的，则这个类可以称为枚举类。例如：星期：Monday(星期一)、…、Sunday(星期天)

2. 枚举类的相关说明

枚举类的实现

• JDK1.5之前需要自定义枚举类
• JDK 1.5 新增的 enum 关键字用于定义枚举类

枚举类的属性

• 枚举类对象的属性不应允许被改动，所以应该使用 private final 修饰
• 枚举类的使用 private final 修饰的属性应该在构造器中为其赋值
• 若枚举类显式的定义了带参数的构造器，则在列出枚举值时也必须对应的传入参数

其他说明

• 枚举类中类的对象是有限个的，确定的
• 当需要定义一组常量时，建议使用枚举类
• 若枚举只有一个对象，则可以作为一种单例模式的实现方 式

3. 自定义枚举类

步骤：

1. 私有化类的构造器，保证不能在类的外部创建其对象
2. 在类的内部创建枚举类的实例；声明为：public static final
3. 对象如果有实例变量，应该声明为private final，并在构造器中初始化
4. 如果有其他需求可以进行相应的定义

例子

class Season {
    private final String SEASON_NAME;//季节的名称
    private final String SEASON_DESC;//季节的描述
    private Season(String seasonName,String seasonDesc){
        this.SEASON_NAME = seasonName;
        this.SEASON_DESC = seasonDesc;
    }
    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("冬天", "白雪皑皑");

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

public class SeasonTest {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        System.out.println(spring);
    }
}

4. 使用enum定义枚举类

使用说明

• 使用 enum 定义的枚举类默认继承了 java.lang.Enum类，因此不能再继承其他类
• 枚举类的构造器只能使用 private 权限修饰符（默认是private，因此可省略）
• 枚举类的所有实例必须在枚举类中显式列出(",“分隔，”;"结尾)。列出的实例系统会自动添加 public static final 修饰，不能再手动添加
• 必须在枚举类的第一行声明枚举类对象
• JDK 1.5 中可以在 switch 表达式中使用枚举类的对象作为表达式，case 子句可以直接使用枚举值的名字，无需添加枚举类作为限定

步骤

1. 使用enum关键字定义枚举类
2. 提供当前枚举类的对象，多个对象之间用",“隔开，末尾对象”;"结束
3. 声明Season对象的属性（一般使用private final修饰）
4. 私有化类的构造器，并给对象属性赋值
5. 如果有其他需求可以进行相应的定义

例子

enum Season {
    SPRING("春天", "春暖花开"),
    SUMMER("夏天", "夏日炎炎"),
    AUTUMN("秋天", "秋高气爽"),
    WINTER("冬天", "白雪皑皑");

    private final String SEASON_NAME; // 季节的名称
    private final String SEASON_DESC; // 季节的描述

    Season(String seasonName,String seasonDesc) {
        this.SEASON_NAME = seasonName;
        this.SEASON_DESC = seasonDesc;
    }
}

public class SeasonTest {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        System.out.println(spring);
    }
}

5. Enum类的主要方法

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

6. 实现接口的枚举类

说明

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

例子

interface Info {
    void showInfo();
}

enum Season implements Info {
    // 枚举值单独实现接口方法
    SPRING("春天", "春暖花开") {
        @Override
        public void showInfo() {
            System.out.println("春天");
        }
    },
    SUMMER("夏天", "夏日炎炎") {
        @Override
        public void showInfo() {
            System.out.println("夏天");
        }
    },
    AUTUMN("秋天", "秋高气爽"),
    WINTER("冬天", "白雪皑皑");

    private final String SEASON_NAME; // 季节的名称
    private final String SEASON_DESC; // 季节的描述

    Season(String seasonName, String seasonDesc) {
        this.SEASON_NAME = seasonName;
        this.SEASON_DESC = seasonDesc;
    }

    // 统一实现接口方法
    @Override
    public void showInfo() {
        System.out.println("这是一个季节");
    }
}

public class SeasonTest1 {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        spring.showInfo();
        Season autumn = Season.AUTUMN;
        autumn.showInfo();
    }
}

10.2 注解(Annotation)

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. 常见的Annotation示例

使用 Annotation 时要在其前面增加 @ 符号，并把该 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：抑制编译器警告

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

  • Servlet3.0提供了注解(annotation)，使得不再需要在web.xml文件中进行Servlet的部署。
  • spring框架中关于“事务”的管理

3. 自定义 Annotation

说明

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

例子

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

@MyAnnotation("test")
class AnnotationTest {
    
}

4. JDK 中的元注解

JDK 的元 Annotation 用于修饰其他 Annotation 定义

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

• Retention

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

  • RetentionPolicy.SOURCE：在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注解
  • RetentionPolicy.CLASS：在class文件中有效（即class保留），当运行 Java 程序时，JVM 不会保留注解；这是默认值
  • RetentionPolicy.RUNTIME：在运行时有效（即运行时保留），当运行 Java 程序时，JVM 会保留注释；程序可以通过反射获取该注解，只有声明为RUNTIME生命周期的注解，才能通过反射获取

• Target

  @Target：用于修饰 Annotation 定义，用于指定被修饰的 Annotation 能用于修饰哪些程序元素，@Target包含一个 ElementType 类型的数组成员变量，使用 @Target 时必须为该 value 成员变量指定值：

  • TYPE：用于描述类、接口(包括注解类型)或enum声明
  • FIELD：用于描述域（属性）
  • METHOD：用于描述方法
  • PARAMETER：用于描述参数
  • CONSTRUCTOR：用于描述构造器
  • LOCAL_VARIABLE：用于描述局部变量
  • PACKAGE：用于描述包
  • …

• Documented

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

• Inherited

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

5. 利用反射获取注解信息

例子

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

@MyAnnotation("test")
class Test {
}

class AnnotationTest {
    public static void main(String[] args) {
        Class<Test> testClass = Test.class;
        Annotation[] annotations = testClass.getAnnotations();
        System.out.println(Arrays.toString(annotations));
    }
}

6. JDK8中注解的新特性

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

可重复注解

JDK 8之前实现可重复注解的方式

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "hi";
}

@interface MyAnnotations {
    MyAnnotation[] value();
}
// 可重复注解
@MyAnnotations({@MyAnnotation("hello"), @MyAnnotation("world")})
class Test {

}

JDK 8实现可重复注解的方式

• 在需要使用可重复注解的注解上声明@Repeatable，成员值为包含了该注解数组的成员变量的注解的class对象

• 包含了该注解数组的成员变量的注解的元注解需要与实现可重复注解的注解的元注解相同

例子：

1. 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class

2. MyAnnotation的Target和Retention等元注解与MyAnnotations相同。

@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
@Documented
public @interface MyAnnotation {
    String value() default "hi";
}

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

@MyAnnotation("hello")
@MyAnnotation("world")
class Test {

}

类型注解

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

• ElementType.TYPE_PARAMETER：表示该注解能写在类型变量的声明语句中（如：泛型声明）
• ElementType.TYPE_USE：表示该注解能写在使用类型的任何语句中。

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

class Test<@MyAnnotation T> {
    public void test() {
        List<@MyAnnotation String> list = new ArrayList<>();
    }
}

---

下一篇：Java集合——第一部分