JavaSE - [7] 高级部分之枚举和注解

枚举类的理解

枚举类的理解 : 类的对象只有有限个,确定的.我们称之为枚举类
2.当定义一组常量的时候,强烈建议使用枚举类
3.枚举类中如果只有一个对象,可以作为单例模式使用

自定义枚举类

如何自定义枚举类
 如何使用关键字enum定义枚举类
 Enum类的主要方法
 实现接口的枚举类

使用 enum 关键字定义枚举类

类的对象只有有限个，确定的。举例如下：
 星期：Monday(星期一)、......、Sunday(星期天)
 性别：Man(男)、Woman(女)
 季节：Spring(春节)......Winter(冬天)
 支付方式：Cash（现金）、WeChatPay（微信）、Alipay(支付宝)、BankCard(银行卡)、CreditCard(信用卡)
 就职状态：Busy、Free、Vocation、Dimission
 订单状态：Nonpayment（未付款）、Paid（已付款）、Delivered（已发货）、
Return（退货）、Checked（已确认）Fulfilled（已配货）、
 线程状态：创建、就绪、运行、阻塞、死亡
 当需要定义一组常量时，强烈建议使用枚举类

枚举类的实现
JDK1.5之前需要自定义枚举类
JDK 1.5 新增的 enum 关键字用于定义枚举类
若枚举只有一个对象, 则可以作为一种单例模式的实现方式。

枚举类的属性
 枚举动 类对象的属性不应允许被改动, 所以应该使用 private final 修饰
枚举类的使用 private final 修饰的属性应该在构造器中为其赋值
若枚举类显式的定义了带参数的构造器, 则在列出枚举值时也必须对应的

传入参数
 枚举类的属性
 枚举动 类对象的属性不应允许被改动, 所以应该使用 private final 修饰
枚举类的使用 private final 修饰的属性应该在构造器中为其赋值
若枚举类显式的定义了带参数的构造器, 则在列出枚举值时也必须对应的

传入参数

1. 私有化类的构造器，保证不能在类的外部创建其对象
2. 在类的内部创建枚举类的实例。声明为：public static final
3. 对象如果有实例变量，应该声明为private final，并在构造器中初始化

使用说明
使用 enum 定义的枚举类默认继承了 java.lang.Enum类，因此不能再继承其他类
枚举类的构造器只能使用 private 权限修饰符
枚举类的所有实例必须在枚举类中显式列出(, 分隔 ; 结尾)。列出的实例系统会自动添加 public static final 修饰
必须在枚举类的第一行声明枚举类对象
JDK 1.5 中可以在 switch 表达式中使用Enum定义的枚举类的对象作为表达式, case 子句可以直接使用枚举值的名字, 无需添加枚举类作为限定。

/**
 * @Author: icanci
 * 1.枚举类的理解 : 类的对象只有有限个,确定的.我们称之为枚举类
 * 2.当定义一组常量的时候,强烈建议使用枚举类
 * 3.枚举类中如果只有一个对象,可以作为单例模式使用
 * 自定义枚举类 jdk5.0之前
 * jdk5.0之后,使用enum关键字
 */
public class SeasonTest {
    public static void main(String[] args) {
        System.out.println(Season.AUTUMN.getSeasonName()+" "+Season.AUTUMN.getSeasonDesc());
        System.out.println();
    }
}

/**
 * 自定义,枚举类
 */
class Season {
    /**
     * 声明Season的属性
     */
    private final String seasonName;
    private final String seasonDesc;

    /**
     * 1.私有化构造器 并给对象属性赋值
     */
    private Season(String seasonName, String seasonDesc) {
        this.seasonDesc = seasonDesc;
        this.seasonName = seasonName;
    }

    /**
     * 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.获取枚举类的属性
     */
    public String getSeasonDesc() {
        return seasonDesc;
    }

    public String getSeasonName() {
        return seasonName;
    }

    @Override
    public String toString() {
        return super.toString();
    }
}

JDK5.0之后

public class SeasonTest1 {
    public static void main(String[] args) {
        System.out.println(Season.AUTUMN.getSeasonName());
        Season1 season1 = Season1.AUTUMN;
        System.out.println(season1);

        System.out.println(Season1.class.getSuperclass());
    }
}

/**
 * 自定义,枚举类
 */
enum Season1 {

    /**
     * 1.提供当前枚举类的多个对象,多个对象直接使用",隔开.
     */
    SPRING("春天", "鸟语花香"),
    SUMMER("夏天", "暴风骤雨"),
    AUTUMN("秋天", "秋高气爽"),
    WINTER("冬天", "大雪纷飞");
    /**
     * 2.声明Season的属性
     */
    private final String seasonName;
    private final String seasonDesc;

    /**
     * 1.私有化构造器 并给对象属性赋值
     */
    private Season1(String seasonName, String seasonDesc) {
        this.seasonDesc = seasonDesc;
        this.seasonName = seasonName;
    }

    /**
     * 4.获取枚举类的属性
     */
    public String getSeasonDesc() {
        return seasonDesc;
    }

    public String getSeasonName() {
        return seasonName;
    }

}

Enum 类中的常用方法

方法

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

public class SeasonTest1 {
    public static void main(String[] args) {
        System.out.println(Season.AUTUMN.getSeasonName());
        Season1 season1 = Season1.AUTUMN;
        System.out.println(season1);

        System.out.println(Season1.class.getSuperclass());

        System.out.println(season1.toString());

        Season1[] values = Season1.values();
        for (int i = 0; i < values.length; i++) {
            System.out.println(values[i].toString());
        }
        System.out.println();
        Thread.State[] vals = Thread.State.values();
        for (int i = 0; i < vals.length; i++) {
            System.out.println(vals[i]);
        }
        System.out.println();
        Season1 spring = Season1.valueOf("SPRING");
        System.out.println(spring);
    }
}

/**
 * 自定义,枚举类
 */
enum Season1 {

    /**
     * 1.提供当前枚举类的多个对象,多个对象直接使用",隔开.
     */
    SPRING("春天", "鸟语花香"),
    SUMMER("夏天", "暴风骤雨"),
    AUTUMN("秋天", "秋高气爽"),
    WINTER("冬天", "大雪纷飞");
    /**
     * 2.声明Season的属性
     */
    private final String seasonName;
    private final String seasonDesc;

    /**
     * 1.私有化构造器 并给对象属性赋值
     */
    private Season1(String seasonName, String seasonDesc) {
        this.seasonDesc = seasonDesc;
        this.seasonName = seasonName;
    }

    /**
     * 4.获取枚举类的属性
     */
    public String getSeasonDesc() {
        return seasonDesc;
    }

    public String getSeasonName() {
        return seasonName;
    }

}

打印结果

秋天
AUTUMN
class java.lang.Enum
AUTUMN
SPRING
SUMMER
AUTUMN
WINTER

NEW
RUNNABLE
BLOCKED
WAITING
TIMED_WAITING
TERMINATED

SPRING

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

和普通 Java 类一样，枚举类可以实现一个或多个接口
若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只
要统一实现该方法即可。
若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式,
则可以让每个枚举值分别来实现该方法

public class SeasonTest1 {
    public static void main(String[] args) {
        System.out.println(Season.AUTUMN.getSeasonName());
        Season1 season1 = Season1.AUTUMN;
        System.out.println(season1);

        System.out.println(Season1.class.getSuperclass());

        System.out.println(season1.toString());

        Season1[] values = Season1.values();
        for (int i = 0; i < values.length; i++) {
            System.out.println(values[i].toString());
        }
        System.out.println();
        Thread.State[] vals = Thread.State.values();
        for (int i = 0; i < vals.length; i++) {
            System.out.println(vals[i]);
        }
        System.out.println();
        Season1 spring = Season1.valueOf("SPRING");
        System.out.println(spring);
        spring.show();
    }
}


/**
 * SeasonInfo接口
 * 实现接口
 */
interface SeasonInfo {
    void show();
}
/**
 * 自定义,枚举类
 */
enum Season1 implements SeasonInfo{

    /**
     * 1.提供当前枚举类的多个对象,多个对象直接使用",隔开.
     */
    SPRING("春天", "鸟语花香"){
        @Override
        public void show() {
            System.out.println("春天");
        }
    },
    SUMMER("夏天", "暴风骤雨"){
        @Override
        public void show() {
            System.out.println("夏天");
        }
    },
    AUTUMN("秋天", "秋高气爽"){
        @Override
        public void show() {
            System.out.println("秋天");
        }
    },
    WINTER("冬天", "大雪纷飞"){
        @Override
        public void show() {
            System.out.println("冬天");
        }
    };
    /**
     * 2.声明Season的属性
     */
    private final String seasonName;
    private final String seasonDesc;

    /**
     * 1.私有化构造器 并给对象属性赋值
     */
    private Season1(String seasonName, String seasonDesc) {
        this.seasonDesc = seasonDesc;
        this.seasonName = seasonName;
    }

    /**
     * 4.获取枚举类的属性
     */
    public String getSeasonDesc() {
        return seasonDesc;
    }

    public String getSeasonName() {
        return seasonName;
    }

    @Override
    public void show() {
        System.out.println("这是一个季节");
    }
}

注解的理解

主要 内容：
 注解(Annotation)概述
 常见的Annotation示例
 自定义Annotation
 JDK中的元注解
 利用反射获取注解信息（在反射部分涉及）
 JDK 8中注解的新特性
从 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的部署。
示例四:框架中的使用

JDK 内置的三个基本注解

@Override 限定重写的方法
@Deprecated 表示所修的的元素(类,方法)过时
@SupperssWarnings 抑制编译器警告

如何自定义注解

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

public @interface MyAnno {
    
}

 自定义注解自动继承了java.lang.annotation.Annotation 接口
 Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能
是八种基本数据类型、String 类型 、Class 类型 、enum 类型 、Annotation 类型 、以上所有类型的 数组。
 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
 如果只有一个参数成员，建议使用 参数名为value
 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，
可以省略“value=”

public @interface MyAnno {
    String value() default "dede";
}

 没有成员定义的 Annotation 称为 标记; 包含成员变量的 Annotation 称为元数据 Annotation
注意：自定义注解必须配上注解的信息处理流程(使用反射)才有意义。

jdk 中4个基本的元注解的使用

JDK 的元 Annotation 用于修饰其他 Annotation 定义
JDK5.0提供了4个标准的meta-annotation类型，分别是：
Retention
Target
Documented
Inherited
元数据的理解 String name = "icanci";
元注解,修饰其他注解的注解

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

  
  
  

  原理

public enum RetentionPolicy{
    SOURCE,
    CLASS,
    RUNTIME
}

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno {
    String value() default "dede";
}

• Target
  用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

  
  
  

  键值对

@Target({ElementType.FIELD,ElementType.METHOD,ElementType.PACKAGE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno {
    String value() default "dede";
}

• Documented
  用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
  定义为Documented的注解必须设置Retention值为RUNTIME

@Documented
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.PACKAGE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno {
    String value() default "dede";
}

• Inherited
  @Inherited: 被它修饰的 Annotation 将具有 继承性。如果某个类使用了被
  @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
  比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解
  实际应用中，使用较少

@Inherited
@Documented
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.PACKAGE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno {
    String value() default "dede";
}

public class Test2 {
    public static void main(String[] args) {
        Class test1Class = Test1.class;
        Annotation[] annotatedInterfaces = test1Class.getAnnotations();
        for (int i = 0; i < annotatedInterfaces.length; i++) {
            System.out.println(annotatedInterfaces[i]);
        }
    }
}

打印

@cn.icanci.AnnotationTest.MyAnno(value=icanci)

JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口

该接口代表程序中可以接受注解的程序元素
当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取
程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息

方法

jdk8新特性：可重复注解

@Target({ElementType.FIELD,ElementType.METHOD,ElementType.PACKAGE,ElementType.TYPE,ElementType.LOCAL_VARIABLE,ElementType.CONSTRUCTOR,ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MyAnno2.class)
public @interface MyAnno {
    String value() ;
}

@Target({ElementType.FIELD,ElementType.METHOD,ElementType.PACKAGE,ElementType.TYPE,ElementType.LOCAL_VARIABLE,ElementType.CONSTRUCTOR,ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno2 {
    MyAnno[] value() ;
}

@MyAnno("test1")
@MyAnno("test2")
public class Test1 {

}

jdk8新特性：类型注解

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：
TYPE_PARAMETER,TYPE_USE。
 在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用
在任何地方。
 ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语
句中（如：泛型声明）。

```@Target({ElementType.FIELD,ElementType.METHOD,ElementType.PACKAGE,ElementType.TYPE,ElementType.LOCAL_VARIABLE,ElementType.CONSTRUCTOR,ElementType.PARAMETER,ElementType.TYPE_PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MyAnno2.class)
public @interface MyAnno {
    String value() default "hello";
}

public class Gen<@MyAnno T> {
}

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

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

public class Gen<@MyAnno T> {
    public void show() throws @MyAnno RuntimeException {
        ArrayList<@MyAnno T> list = new ArrayList();
        int num = (@MyAnno int) 10L;
    }
}

可重复注解中元注解不一致的问题解决

都得一致