10. 枚举类与注解

一、枚举类的使用

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

定义枚举类

方式一：自定义枚举类（jdk5.0之前）

class Season{}

步骤

声明Season对象的属性:private final修饰

private final String seasonName;
private final String seasonDesc;

私有化类的构造器,并给对象属性赋值

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

提供当前枚举类的多个对象：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("冬天","冰天雪地");

其他诉求
- 获取枚举类对象的属性
- 提供toString()

注意

枚举类对象的属性不应允许被改动, 所以应该使用 private final 修饰
枚举类的使用 private final 修饰的属性应该在构造器中为其赋值
私有化类的构造器，保证不能在类的外部创建其对象
在类的内部创建枚举类的实例。声明为： public static final

方式二：使用enum关键字定义枚举类（jdk5.0）

定义的枚举类默认继承于java.lang.Enum类
枚举类的所有实例必须在枚举类中显式列出(, 分隔 ; 结尾)。列出的实例系统会自动添加 public static final 修饰
必须在枚举类的第一行声明枚举类对象

示例：

enum Season1{
    //1.提供当前枚举类的对象，多个对象之间用","隔开，末尾对象";"结束
    SPRING("春天","春暖花开"),
    SUMMER("夏天","夏日炎炎"),
    AUTUMN("秋天","秋高气爽"),
    WINTER("冬天","冰天雪地");
    //2.声明Season对象的属性:private final修饰
    //3.私有化类的构造器,并给对象属性赋值
    //4.其他诉求
    }

使用enum关键字定义的枚举类中，可以使用父类Enum的toString()方法，直接输出枚举类实例的名字

Season a = Season.SPRING;
System.out.println(a);//c_1.Season@ba8a1dc
Season1 b = Season1.SPRING;
System.out.println(b);//SPRING

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

//values():返回所有的枚举类对象构成的数组
Season1[] values = Season1.values();
for (int i = 0; i < values.length; i++) {
    System.out.println(values[i]);
}
//valueOf(String objName):返回枚举类中对象名是objName的对象。
Season1 winter = Season1.valueOf("WINTER");
System.out.println(winter);//WINTER

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

interface Info{
    void show();
}

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

与class类实现接口，在类中实现抽象方法相同，每个枚举类的实例共用一个实现方法

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

每个枚举类实例使用不同的实现方法

SPRING("春天", "春暖花开") {
    @Override
    public void show() {
        System.out.println("1");
    }
},
SUMMER("夏天", "夏日炎炎") {
    @Override
    public void show() {
        System.out.println("2");
    }
},
AUTUMN("秋天", "秋高气爽") {
    @Override
    public void show() {
        System.out.println("3");
    }
},
WINTER("冬天", "冰天雪地") {
    @Override
    public void show() {
        System.out.println("4");
    }
};

开发中的使用

以下记录一些枚举类在项目中的常用方式：

便于数据库中字符串对应数值类型的转换

public enum ApprovalStatusEnum {
    //0=无需审批;1=未提交;2=待审批;3=审批拒绝;4=审批通过
    NO_APPROVAL("无需审批", 0), NOT_SUBMITTED("未提交", 1), PENDING_APPROVAL("待审批", 2),
    APPROVAL_REJECTED("审批拒绝", 3), APPROVED("审批通过", 4);
    private String name;
    private Integer code;

    ApprovalStatusEnum(String name, int code) {
        this.name = name;
        this.code = code;
    }

    // 普通方法
    public static String getName(int code) {
        for (ApprovalStatusEnum c : ApprovalStatusEnum.values()) {
            if (c.getCode() == code) {
                return c.name;
            }
        }
        return null;
    }

    public static Integer getCode(String name) {
        for (ApprovalStatusEnum c : ApprovalStatusEnum.values()) {
            if (c.getName().equalsIgnoreCase(name)) {
                return c.code;
            }
        }
        return null;
    }

    // get set 方法
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }
}

二、注解(Annotation)

Annotation的理解：

1.jdk 5.0新增功能

2.Annotation 其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取, 并执行相应的处理。通过使用 Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。

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

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

一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

Annocation的使用示例

示例一：生成文档相关的注解

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

@param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求：@param 形参名形参类型形参说明
@return 的格式要求：@return 返回值类型返回值说明
@exception的格式要求：@exception 异常类型异常说明
@param和@exception可以并列多个

示例二：在编译时进行格式检查

JDK内置的三个基本注解

@Override: 限定重写父类方法, 该注解只能用于方法

@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择

@SuppressWarnings: 抑制编译器警告

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

自定义 Annotation

步骤

参照@SuppressWarnings定义

注解声明为：@interface
内部定义成员，通常使用value表示
- Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
可以指定成员的默认值，使用default定义
如果自定义注解没有成员，表明是一个标识作用。
- 如果注解有成员，在使用注解时，需要指明成员的值。
- 自定义注解必须配上注解的信息处理流程(使用反射)才有意义。
- 自定义注解通常都会指明两个元注解：Retention、Target

示例：

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

jdk 提供的4种元注解

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

@Retention
@Target
@Documented
@Inherited

元数据：指用来描述数据的数据
String name ="李明";name就是元数据

@Retention：指定所修饰的 Annotation 的生命周期
- SOURCE\CLASS（默认行为）\RUNTIME
  只有声明为RUNTIME生命周期的注解，才能通过反射获取。
@Target:用于指定被修饰的 Annotation 能用于修饰哪些程序元素

出现的频率较低：

@Documented:表示所修饰的注解在被javadoc解析时，保留下来（提取成文档）。
- 定义为Documented的注解必须设置Retention值为RUNTIME。
@Inherited:被它修饰的 Annotation 将具有继承性。

JDK8中注解的新特性

可重复注解：

在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
MyAnnotation的Target和Retention等元注解与MyAnnotations相同。

@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
    String value() default "hello";
}

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

//jdk 8之前的写法：
//@MyAnnotations({@MyAnnotation(value="hi"),@MyAnnotation(value="hi")})
@MyAnnotation(value="hi")
@MyAnnotation(value="abc")
class A{}

类型注解：

ElementType.TYPE_PARAMETER

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

public class TestTypeDefine<@TypeDefine() U> {
    private U u;
    public <@TypeDefine() T> void test(T t) {
    }
}
@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine {
}

ElementType.TYPE_USE

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

posted @ 2023-09-30 16:21 LemonPuer 阅读(23) 评论(0) 收藏举报

刷新页面返回顶部

柠檬普洱