当前位置：首页 > news >正文

Java枚举类与注解

news 来源：原创 2024/11/19 11:33:59

一、枚举类的使用

枚举类的实现

枚举类的属性

自定义枚举类

步骤

举例

使用enum定义枚举类

使用说明

举例

Enum类的主要方法

实现接口的枚举类

二、注解的使用

概述

常见的Annotation示例

自定义Annotation（参照@SupressWarnings 定义）

JDK中的元注解

JDK8中注解的新特性

可重复注解示例

类型注解

一、枚举类的使用

枚举类的对象只有有限个、是确定的。当需要定义一组常量（对象）时，建议使用枚举类。

枚举类的实现

jdk5.0之前：需要自定义枚举类

jdk5.0之后：新增的enum关键字用于定义枚举类

若枚举类只有一个对象，则可以当做一种单例模式的实现方式。

枚举类的属性

枚举类对象的属性不应允许被改动，所以应使用private final修饰

枚举类的使用用private final修饰的属性应该在构造器中为其赋值

若枚举类显示定义了带参数的构造器，则在列出枚举值是也必须对应的传入参数

自定义枚举类

步骤

1、私有化类的构造器，保证不能在类的外部创建对象

2、在类的内部创建枚举类的实例。声明为：public static final

3、对象如果有实例变量，应声明为private final，并在构造器中实例化

举例


/**
 * @auther light
 * @Description 枚举类的使用
 * 方式一：自定义枚举类
 * @create 2022-11-28 16:07
 */
public class SeasonTest01 {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        Season summer = Season.SUMMER;
        Season autumn = Season.AUTUMN;
        Season winter = Season.WINTER;

        System.out.println(spring);
        System.out.println(summer);
        System.out.println(autumn);
        System.out.println(winter);
    }

}

/**
 * 方式一：自定义枚举类
 */
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、其他需求：获取枚举类对象属性


    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }
    //提供toString()方法

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


}

运行结果如下：

使用enum定义枚举类

使用说明

使用enum定义的枚举类默认继承了java.lang.Enum类，因此不能在继承其他类

枚举类的构造器只能使用private权限修饰符

枚举类的所有实例必须在枚举类中显示列出（，分隔；结尾）。列出的实例系统会自动添加private static final修饰

必须在枚举类的第一行声明枚举类对象

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

举例



/**
 * @auther light
 * @Description 枚举类的使用
 * 方式二：使用enum关键字定义枚举类
 * 定义的枚举类默认继承于java.lang.Enum类
 * @create 2022-11-28 16:32
 */
public class SeasonTest02 {
    public static void main(String[] args) {
        Season1 spring = Season1.SPRING;
        Season1 summer = Season1.SUMMER;
        Season1 autumn = Season1.AUTUMN;
        Season1 winter = Season1.WINTER;

        System.out.println(spring);
        System.out.println(summer);
        System.out.println(autumn);
        System.out.println(winter);
        System.out.println(spring.getClass().getSuperclass());
    }
}
/**
 * 方式二：使用enum定义枚举类
 */
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()方法

    @Override
    public String toString() {
        return "Season1{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }


}

运行结果如下：

Enum类的主要方法

values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。

valueOf(String str)：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是，会有运行时异常： IllegalArgumentException。

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

实现接口的枚举类

和普通java类一样，枚举类可以实现一个或多个接口

若每个枚举值再调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可（实现接口，在enum类中实现抽象方法）

若需要每个枚举值在调用实现的接口方法呈现不同的行为方式，则只需要让每个枚举值分别来实现该方法（让枚举类对象分别来实现该方法）

二、注解的使用

概述

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

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

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

未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的 Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

常见的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的部署。

自定义Annotation（参照@SupressWarnings 定义）

定义新的Annotation类型使用@interface关键字

自定义注解自动继承了java.lang.annotation.Annotation接口

Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型，称为配置参数。类型只能是八种基本数据类型、String类型、Class类型（任何一个类都能充当）、enum类型、Annotation类型、以上所有类型的数组

可以在定义Annotation的成员变量时为其指定初始值，指定成员变量的初始值可以使用default关键字

如果只有一个参数成员，建议使用参数名为value

如果定义的注解含有配置参数，那么必须指定参数值，除非它有默认值。格式为“参数名=参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”

没有成员定义的Annotation称为标记，包含成员变量的Annotation称为元数据Annotation

注意：

1、自定义注解必须配上注解的信息处理流程（反射）才有意义

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

JDK中的元注解

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

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

@Retention：用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:
- RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
- RetentionPolicy.CLASS:在class文件中有效（即class保留），当运行 Java 程序时, JVM 不会保留注解。这是默认值
- RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。
@Target：用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

@Documented：用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
- 定义为Documented的注解必须设置Retention值为RUNTIME。
@Inherited：被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。