Java枚举类与注解_获取枚举上定义的注解-优快云博客

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

//自定义枚举类
class Season{
    //1. 声明Season对象的属性 : 使用private final来修饰
    private final String seasonName;
    private final String seasonDesc;

    //2. 私有化类的构造器 并给对象的属性初始化
    private Season(String seasonName, String seasonDesc){
        this.seasonDesc = seasonDesc;
        this.seasonName = seasonName;
    }

    //3. 提供当前枚举类的多个对象 声明为 public static final 的
    public static final Season SPRING = new Season("spring", "beautiful");
    public static final Season SUMMER = new Season("summer", "hot");
    public static final Season AUTUMN = new Season("autumn", "desolation");
    public static final Season WINTER = new Season("winter", "cold");

    //4. 其他诉求 :
    // 获取枚举类的属性
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }
    // 提供toString()方法
    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}

2. 如何使用关键字enum定义枚举类

JDK5.0时，使用关键字enum定义枚举类

定义的枚举类默认继承于 java.lang.Enum，Enum中toString()方法被重写为打印对象的名字

步骤 :

使用 enum 代替 class
必须在枚举类的第一行提供当前枚举类的对象，多个对象之间用 "," 隔开，末尾对象用 ";" 结束
声明枚举类对象的属性 : 使用private final来修饰
私有化类的构造器(不用加private) 并给对象的属性初始化
其他诉求，提供get方法，重写toString方法等

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

        Day day = Day.MORNING;
        System.out.println(day);//MORNING
    }
}

//使用enum关键字定义枚举类
enum Day{
    //1. 提供当前枚举类的对象，多个对象之间用 "," 隔开，末尾对象用 ";" 结束
    MORNING("morning", "start"),
    AFTERNOON("afternoon", "hot"),
    NIGHT("night", "dark");

    //2. 声明Season对象的属性 : 使用private final来修饰
    private final String name;
    private final String desc;

    //3. 私有化类的构造器(不用加private) 并给对象的属性初始化
    Day(String name, String desc){
        this.desc = desc;
        this.name = name;
    }

    //4. 其他诉求 :
    public String getName() {
        return name;
    }
    public String getDesc() {
        return desc;
    }
    //toString()方法默认重写为打印对象名字
//    @Override
//    public String toString() {
//        return "Day{" +
//                "name='" + name + '\'' +
//                ", desc='" + desc + '\'' +
//                '}';
//    }
}

3. Enum类的主要方法

主要方法 :

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

@Test
public void test(){
    Day day = Day.MORNING;
    System.out.println(day.toString());//MORNING

    //获取枚举类的所有对象 返回枚举类数组
    Day[] values = Day.values();
    for (int i = 0; i < values.length; i++) {
        System.out.println(values[i]);
    }

    //返回枚举类中对象是objName的对象
    String str = "NIGHT";
    Day strDay = Day.valueOf(str);//如果没有这个名字 则抛IllegalArgumentException异常
    System.out.println(strDay);//NIGHT
}

4. 实现接口的枚举类(enum定义)

interface Info{
    void show();
}

public enum Status implements Info {
    //情况二 : 实现接口时 考虑到不同枚举类对象实现不同的接口中的方法
    BUSY("BUSY"){
        @Override
        public void show() {
            System.out.println("Info : BUSY");
        }
    },
    FREE("FREE"){
        @Override
        public void show() {
            System.out.println("Info : FREE");
        }
    },
    VOCATION("VOCATION"){
        @Override
        public void show() {
            System.out.println("Info : VOCATION");
        }
    };

    private final String name;

    Status(String name){
        this.name = name;
    }

    public String getName() {
        return name;
    }

    //情况一 : 所有对象实现一个接口中的方法
//    @Override
//    public void show() {
//        System.out.println("Info : All");
//    }
}

public class StatusTest {
    public static void main(String[] args) {
        Status status1 = Status.FREE;
        Status status2 = Status.BUSY;
        Status status3 = Status.VOCATION;

        status1.show();//Info : FREE
        status2.show();//Info : BUSY
        status3.show();//Info : VOCATION
    }
}

二、注解的使用

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示例

2.1 生成文档相关的注解

@author 标明开发该类模块的作者，多个作者之间使用,分割

@version 标明该类模块的版本

@see 参考转向，也就是相关主题

@since 从哪个版本开始增加的

@param 对方法中某参数的说明，如果没有参数就不能写

@return 对方法返回值的说明，如果方法的返回值类型是void就不能写

@exception 对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写

其中 :

@param @return 和 @exception 这三个标记都是只用于方法的。

@param的格式要求：@param 形参名形参类型形参说明

@return 的格式要求：@return 返回值类型返回值说明

@exception的格式要求：@exception 异常类型异常说明

@param和@exception可以并列多个

2.2 在编译时进行格式检查

JDK内置的三个基本注解

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

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

@SuppressWarnings: 抑制编译器警告

public class AnnotationTest {
    public static void main(String[] args) {
        Person p = new Student();
        p.walk();//学生走路

        //虽然注解解析为过时的方法 但是还可以用
        Date date = new Date(2022, 8, 2);
        System.out.println(date);//Sat Sep 02 00:00:00 CST 3922

        //抑制编译器警告
        @SuppressWarnings({"unused", "rawtypes"})
        ArrayList arrayList = new ArrayList();
    }
}

class Person{
    String name;
    int age;

    public Person(){}
    public Person(String name, int age){
        this.age = age;
        this.name = name;
    }

    public void walk(){
        System.out.println("人走路");
    }

    public void eat(){
        System.out.println("人吃饭");
    }
}

interface Info{
    void show();
}

class Student extends Person implements Info{
    //在方法前加 Override 会强制校验下面的类是不是重写类 如果不是则编译的时候就会报错
    @Override
    public void walk() {
        System.out.println("学生走路");
    }

    @Override
    public void eat() {
        System.out.println("学生吃饭");
    }

    @Override
    public void show() {
        System.out.println("Student");
    }
}

2.3 实现替代配置文件功能

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

Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

3. 自定义Annotation

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

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

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

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

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

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

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

注意：自定义注解必须配上注解的信息处理流程（使用反射实现）才有意义。

如何定义注解 : 参照@SuppressWarning定义

注解声明为@interface
内部定义成员变量，通常使用value表示
可以指定成员的默认值，使用default定义
如果自定义注解没有成员，表明该注解是一个标识作用

如果注解有成员，在使用注解时，需指明成员的值

public @interface MyAnnotation {

    String value() default "hi";

}

//当注解只有一个成员变量且名为value时 可以省略 " value = "
//当注解无成员变量或有成员变量但赋了默认值 则可以省略()
@MyAnnotation(value = "hello")
class Person{
    String name;
    int age;
}

4. JDK中的元注解

JDK提供的四种元注解 : 修饰其他注解的注解

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

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

Retention
Target
Documented
Inherited

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

元数据的理解：对现有数据的修饰

String name = "atguigu";
//如果将 "atguigu" 看做是数据的话
//String表示数据的类型，name表示数据的名称 这两个数据称作元数据

4.1 @Retention

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

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

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String value() default "hi";

}

4.2 @Target

@Target : 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value (ElementType 枚举类数组)的成员变量。

如果不用此元注解，代表自定义的注解在哪个地方都可以使用

如果使用此元注解，代表自定义的注解在指定的地方可以使用

4.3 @Documented

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

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

4.4 @Inherited

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

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

如何知道子类上有注解 :

//通过反射获取注解信息
@Test
public void test(){
    @SuppressWarnings("rawtypes")
    Class clazz = Student.class;

    Annotation[] annotation = clazz.getAnnotations();

    for (int i = 0; i < annotation.length; i++) {
        System.out.println(annotation[i]);
        //@com.atguigu.annotationtest.MyAnnotation(value=hello)
    }
    
}

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

在反射时讲

6. JDK 8中注解的新特性

6.1 可重复注解

在JDK8之前的版本中，如果想使用重复注解，解决方案为新定义一个该注解的数组注解

public @interface MyAnnotations {
    
    MyAnnotation[] value();
    
}
//添加注解
@MyAnnotations({@MyAnnotation(value = "hello"), @MyAnnotation(value = "hi")})
class Person{
    String name;
    int age;
}

在JDK8中引入了一个新的元注解 @Repeatable

在MyAnnotation注解上声明 @Repeatable(MyAnnotations.class)
要求注解MyAnnotation的@Target和@Retention等元注解和MyAnnotations相同
在需要注解的位置就可以重复使用了

//MyAnnotation注解
@Repeatable(MyAnnotations.class)
@Target({ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String value() default "hi";

}
//MyAnnotations注解
@Target({ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {

    MyAnnotation[] value();

}
//可重复注解的使用
@MyAnnotation(value = "hello")
@MyAnnotation(value = "hello")
class Person{
    String name;
    int age;
}

6.2 类型注解

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个 : TYPE_PARAMETER、TYPE_USE。

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。

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

public class TestTypeDefine<@TypeDefine() U> {
	private U u;
	public <@TypeDefine() T> void test(T t){}
}

@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine{ }
@MyAnnotation
public class AnnotationTest<U> {
    @MyAnnotation
    private String name;
    public static void main(String[] args) {
        AnnotationTest<@MyAnnotation String> t = null;
        int a = (@MyAnnotation int) 2L;
        @MyAnnotation
        int b = 10;
    }
    public static <@MyAnnotation T> void method(T t) { }
    public static void test(@MyAnnotation String arg) throws @MyAnnotation Exception { } 
}

@Target(ElementType.TYPE_USE)
@interface MyAnnotation { }