Java枚举和注解

1 枚举

Java 中的枚举（Enumeration）是一种特殊的数据类型，用于定义一个固定数量的命名常量集合。枚举提供了一种更好的方式来表示一组相关的常量，使代码更加可读、可维护和安全。
当需要定义一组常量时，强烈建议使用枚举类 使用说明：

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

主要方法：

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

示例：
使用常量表示线程状态

public class StateDemo {

    public static void main(String[] args) {
        System.out.println(State.WAITING);
    }

    static class State {
        public static final String NEW = "NEW";
        public static final String RUNNABLE = "RUNNABLE";
        public static final String BLOCKED = "BLOCKED";
        public static final String WAITING = "WAITING";
        public static final String TIMED_WAITING = "TIMED_WAITING";
        public static final String TERMINATED = "TERMINATED";
    }
}

使用枚举表示线程状态

public class StateDemo {
    int i;
    static int i1;
    public static void main(String[] args) {
        //获取一个枚举对象
        System.out.println(State.WAITING);
        System.out.println(State.valueOf("BLOCKED"));

        //循环枚举
        State[] states = State.values();
        for (int i = 0; i < states.length; i++) {
            System.out.println(states[i]);
        }
    }

    enum State {
        //一个类State，中有6个这个类的静态对象
        NEW,
        RUNNABLE,
        BLOCKED,
        WAITING,
        TIMED_WAITING,
        TERMINATED;
    }
}

订单状态的枚举

/**
 *   订单状态： Nonpayment（未付款）、 Paid（已付款） 、 Delivered（已发货）、Return（退货）、 Checked（已确认） Fulfilled（已配货）、
 */
public class StateDemo {

    public static void main(String[] args) {
        OrderState[] states = OrderState.values();
        for (int i = 0; i < states.length; i++) {
            System.out.println(states[i] + "-" + states[i].getValue() + "-" + states[i].getCode());
        }
    }

    public enum OrderState {
        //static OrderState NON_PAYMENT = new OrderState("未付款")
        NON_PAYMENT(1, "未付款"),
        PAID(2, "已付款"),
        DELIVERED(3, "已发货"),
        RETURN(4, "退货"),
        CHECKED(5, "已确认"),
        FULFILLED(6, "已配货");

        private OrderState(int code, String value) {
            this.code = code;
            this.value = value;
        }

        private int code;
        private String value;

        public String getValue() {
            return value;
        }

        public int getCode() {
            return code;
        }
    }
}

2 注解

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

2.1 常见JDK注解

• @Override: 限定重写父类方法, 该注解只能用于方法
• @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
• @SuppressWarnings: 抑制编译器警告

示例：

public class AnnotationTest{
     public static void main(String[] args) {
         @SuppressWarnings("unused")
         int a = 10;
     }
     @Deprecated
     public void print(){
         System.out.println("过时的方法");
     }
     @Override
     public String toString() {
         return "重写的toString方法()";
     }
}

2.2 元注解

元注解（Meta-Annotation）是一种用于注解其他注解的注解。换句话说，元注解是用来修饰其他注解的注解。在 Java 中，有四种预定义的元注解，它们分别是：

1. @Retention: 用于指定注解的保留策略，即注解在什么级别可用。它有三个值：
   RetentionPolicy.SOURCE: 注解仅在源码级别可用，编译后不会包含在编译后的类文件中。
   RetentionPolicy.CLASS: 注解在源码和字节码级别可用，编译后会包含在编译后的类文件中，但在运行时不可用。
   RetentionPolicy.RUNTIME: 注解在源码、字节码和运行时均可用，可以通过反射等机制获取注解信息。
2. @Target: 用于指定注解可以应用的目标类型，即在哪些元素上可以使用该注解。它的值可以是一个 ElementType 数组，表示可以应用于多个目标类型，如类、方法、字段等。
3. @Documented: 用于指定注解是否会包含在 JavaDoc 中。如果一个注解被 @Documented 修饰，那么当类或方法被注解后，生成的 JavaDoc 中会包含注解的信息。
4. @Inherited: 用于指定注解是否具有继承性。如果一个注解被 @Inherited 修饰，那么如果一个类继承了被注解的类，它也会继承这个注解。

2.3 通过反射获取注解

通过反射获取注解可以帮助你在运行时获取已注解的类、方法、字段等元素的注解信息。以下是获取注解的步骤：

1. 获取类、方法、字段等的 Class 对象：首先，你需要获取要检查注解的元素的 Class 对象。

2. 通过 Class 对象获取注解信息：使用 Class 对象的 getAnnotation(Class annotationClass) 方法来获取特定类型的注解。如果你知道元素可能有多个注解，你可以使用 getAnnotations() 方法返回注解数组。

3. 检查注解是否存在：你还可以使用 isAnnotationPresent(Class<? extends Annotation> annotationClass) 方法来检查指定类型的注解是否存在。

示例：

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

class MyClass {
    @MyAnnotation("Hello Annotation")
    public void myMethod() {
         ...
    }
}

public class AnnotationReflectionExample {
    public static void main(String[] args) throws NoSuchMethodException {
        // 获取方法的 Class 对象
        Class clazz = MyClass.class;

        // 获取方法对象
        Method method = clazz.getMethod("myMethod");

        // 检查方法上是否存在 MyAnnotation 注解
        if (method.isAnnotationPresent(MyAnnotation.class)) {
            // 获取注解对象
            MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);

            // 获取注解的属性值
            String value = annotation.value();
            System.out.println("Annotation Value: " + value);
        } else {
            System.out.println("MyAnnotation is not present");
        }
    }
}

结果：

Annotation Value: Hello Annotation

在这个示例中，MyAnnotation 是一个自定义注解，它有一个属性 value。通过反射，我们获取了 myMethod 方法的注解信息并输出了注解的属性值。