21-枚举与注解

1. 枚举类型#

有时候，变量(对象) 的取值只在一个有限的集合内。比如：
- 星期：Monday(星期一)、...、Sunday(星期天)
- 性别：Man(男)、Woman(女)
- 季节：Spring(春节)、Summer(夏天)，Autumn(秋天)，Winter(冬天)
- 支付方式：Cash(现金)、WeChatPay(微信)、Alipay(支付宝)、BankCard(银行卡)、CreditCard(信用卡)
- 就职状态：Busy、Free、Vocation、Dimission
- 订单状态：Nonpayment(未付款)、Paid(已付款)、Delivered(已发货)、 Return(退货)、Checked(已确认)、Fulfilled(已配货)
- 线程状态：创建、就绪、运行、阻塞、死亡
针对这种情况，可以自定义枚举类型。枚举类型包括有限个的对象。
- JDK5.0 之前需要自定义枚举类
- JDK5.0 新增的 enum 用于定义枚举类
若枚举只有一个对象, 则可以作为一种 [单例模式] 的实现方式
当需要定义一组常量时，强烈建议使用枚举类

1.1 定义枚举类#

1.1.1 自定义枚举类#

枚举类对象的属性不应允许被改动，所以应该使用 private final 修饰
private final 修饰的属性应该在 [构造器] 中为其赋值
若枚举类显式的定义了带参数的构造器，则在列出枚举值时也必须对应的传入参数
私有化类的构造器，保证不能在类的外部创建其对象
在类的内部创建枚举类的实例。声明为：public static final

// JDK5.0 之前，自定义枚举类
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 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 + '\'' +
                '}';
    }
}

1.1.2 使用 enum 定义枚举类#

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

// JDK5.0 之后，使用 enum 关键字定义枚举类 (默认继承于 Java.lang.Enum)
enum Season1 { // extends 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. [诉求] 获取枚举类对象的属性
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

    // toString(): 打印引用名
}

JDK5.0 中可以在 switch 表达式中使用 Enum 定义的枚举类的对象作为表达式，case 子句可以直接使用枚举值的名字，无需添加枚举类作为限定。

1.2 Enum类#

使用 enum 定义的枚举类默认继承了 java.lang.Enum 类
Enum 类的主要方法
- values()：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值
- valueOf(String str)：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象常量名。如不是，会抛出运行时异常：IllegalArgumentException
- toString()：返回当前枚举类对象常量的名称

1.3 实现接口的枚举类#

实现接口，在 enum 类中实现抽象方法 // 每个对象调用此方法，执行相同的方法体
让 enum 类中的对象分别实现接口中的抽象方法

interface Info {
    void func();
}

enum Season1 implements Info { // extends Enum<Season1>

    SPRING("春天", "春暖花开") {
        @Override
        public void func() {
            System.out.println("春天的味道");
        }
    },
    SUMMER("夏天", "夏日炎炎") {
        @Override
        public void func() {
            System.out.println("夏天的味道");
        }
    },
    AUTUMN("秋天", "秋高气爽") {
        @Override
        public void func() {
            System.out.println("秋天的味道");
        }
    },
    WINTER("冬天", "冰天雪地") {
        @Override
        public void func() {
            System.out.println("冬天的味道");
        }
    };
    
    /*
    @Override
    public void func() {
        System.out.println("季节是有气味的");
    }
    希望每个对象调用func()，展现出不同的内容 → 每个对象各自实现func()
    */
    
    // ...
}

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 当成一个修饰符使用，用于修饰它支持的程序元素。

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

2.3 自定义 Annotation#

自定义注解必须配上注解的信息处理流程(反射)才有意义

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

public @interface MyAnnotation {
    String value() default "Hello";
}

2.4 元注解#

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 包含一个 ElementType 枚举类型的成员变量
- 使用 @Rentention 时必须为该名为 value 成员变量指定值
@Documented
- 用于指定被该「元Annotation」修饰的 Annotation 类将被 javadoc 工具提取成文档
- 默认情况下，javadoc 是不包括注解的
- 定义为 Documented 的注解必须设置 Retention 值为 RUNTIME
@Inherited
- 被它修饰的 Annotation 将具有继承性
- 如果某个类使用了被 @Inherited 修饰的 Annotation，则其子类将自动具有该注解
- 如果把标有 @Inherited 注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解

2.5 可重复注解、类型注解#

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

2.5.1 可重复的注解#

在 JDK8 之前我们不能在一个类型重复使用同一个注解；如果想要这样使用，要用数组来实现重复注解。

public @interface MyAnnotation {
    String value();
}

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

-------------- 使用 ↓ ----------------

@MyAnnotations({@MyAnnotation("Hello"), @MyAnnotation("World")})
class Person {}

JDK8 之后，在需要重复的注解上声明@Repeatable，成员值为 MyAnnotations.class，让这 2 个注解关联在一起。并且，MyAnnotation 的 @Target 、@Retention等元注解要与 MyAnnotations 一致。

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

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

-------------- 使用 ↓ ----------------

@MyAnnotation("World")
@MyAnnotation("Hello")
class Person {}

2.5.2 类型注解#

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

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

2.6 反射获取注解#

JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement <I>，该接口代表程序中可以接受注释的程序元素。

当一个 Annotation 类型被定义为运行时 Annotation 后，该注释才是运行时可见，当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取。

程序可以调用 AnnotatedElement 对象的如下方法来访问 Annotation 信息：

代码演示：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface DemoAnno {
    public String name();
    public int age() default 22;
}

public class Demo {
    public static void main(String[] args) {
        Class sc = Student.class;
        if (sc.isAnnotationPresent(DemoAnno.class)) {
            DemoAnno da = (DemoAnno) sc.getAnnotation(DemoAnno.class);
            String name = da.name();
            int age = da.age();
            System.out.println(name+":"+age);
        } else {
            System.out.println("没有注解");
        }
    }
}

posted @ 2020-07-12 13:48 tree6x7 阅读(170) 评论(0) 编辑收藏举报

刷新页面返回顶部

登录后才能查看或发表评论，立即登录或者逛逛博客园首页

阅读排行：
· DeepSeek 开源周回顾「GitHub 热点速览」
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布：重大改进与新特性概览！
· AI与.NET技术实操系列（二）：开始使用ML.NET
· 单线程的Redis速度为什么快？

Loading

◥(ฅºωºฅ)◤