Java枚举类和注解

枚举类的使用

当需要定义一组常量时，强烈建议使用枚举类

枚举类的实现：

• JDK1.5 之前需要自定义枚举类
• JDK1.5 新增的 enum 关键字用于定义枚举类

若枚举只有一个对象 , 则可以作为一种单例模式的实现方式。

枚举类的属性：

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

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

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

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

自定义枚举类方式如下

/**
 * 一.枚举类的使用
 *  1.枚举类的理解：类的对象只有有限个，确定的，我们成此类为枚举类
 *  2.当需要定义一组常量时，强烈建议使用枚举类。
 *  3.如果枚举类中只有一个对象，则可以作为单例模式的实现方式。
 * 二.如何定义枚举类
 *  方式一：jdk5.0之前，自定义枚举类
 *  方式二：jdk5.0，可以使用enum关键字定义枚举类
 */
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.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 AUTUM = new Season("秋天","秋高气爽");
    public static final Season WINTER = new Season("冬天","冰天雪地");

    //4.其他诉求：获取枚举类对象的属性
    public String getSeasonName() {
        return seasonName;
    }
    public String getSeasonDesc() {
        return seasonDesc;
    }
	//5.其他诉求：重写toString()
    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}

使用enum关键字定义枚举类

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

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

/**
 * 使用enum关键字定义枚举类
 * 说明：定义的枚举类默认继承于java.lang.Enum类
 */
public class SeasonTest1 {
    public static void main(String[] args) {
        Season1 summer = Season1.SUMMER;
        System.out.println(summer);
    }
}
//使用enum关键字枚举类
enum Season1{
    //1.提供当前枚举类的多个对象，多个对象之间用","隔开，末尾对象";"结束
    SPRING("春天","春暖花开"),
    SUMMER("夏天","夏日炎炎"),
    AUTUM("秋天","秋高气爽"),
    WINTER("冬天","冰天雪地");

    //1.声明Season1对象的属性：private final修饰
    private final String seasonName;
    private final String seasonDesc;

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

    //3.其他诉求：获取枚举类对象的属性
    public String getSeasonName() {
        return seasonName;
    }
    public String getSeasonDesc() {
        return seasonDesc;
    }
}

Enum类的主要方法

方法名	详细描述
valueOf	传入枚举类型的Class对象和枚举常量名称给静态方法valueOf，会得到与参数匹配的枚举常量
toString	得到当前枚举常量的名称，可以通过重写这个方法来使得到的结果更易读
equals	在枚举类型中可以直接使用==来比较两个枚举常量是否相等，Enum提供的这个equals()方法，也是直接使用==实现的

实现接口的枚举类

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

若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可。

若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式，则可以让每个枚举值分别来实现该方法。

/**
 * 一.枚举类的使用
 *  1.枚举类的理解：类的对象只有有限个，确定的，我们成此类为枚举类
 *  2.当需要定义一组常量时，强烈建议使用枚举类。
 *  3.如果枚举类中只有一个对象，则可以作为单例模式的实现方式。
 * 二.如何定义枚举类
 *  方式一：jdk5.0之前，自定义枚举类
 *  方式二：jdk5.0，可以使用enum关键字定义枚举类
 *
 * 三.Enum类中的常用方法：
 *  values()方法：返回枚举类型的对象数组，该方法可以很方便的遍历所有的枚举值
 *  valueOf(string str)：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象
 *  toString()：返回当前枚举类对象常量的名称
 * 四.使用enum关键字定义的枚举类实现接口的情况
 *  情况一：实现接口，在enum类中实现抽象方法
 *  情况二：让枚举类的对象分别实现接口中的抽象方法
 *
 */
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.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 AUTUM = new Season("秋天","秋高气爽");
    public static final Season WINTER = new Season("冬天","冰天雪地");

    //4.获取枚举类对象的属性
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

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

枚举类实现接口：

/**
 * 使用enum关键字定义枚举类
 * 说明：定义的枚举类默认继承于java.lang.Enum类
 *
 */
public class SeasonTest1 {
    public static void main(String[] args) {
        Season1 summer = Season1.SUMMER;
        //toString()
        System.out.println(summer);

        //values()
        Season1[] values = Season1.values();
        for (int i = 0; i < values.length; i++) {
            System.out.println(values[i]);
            values[i].show();
        }

        //valueOf(String objName):返回枚举类中对象名是objName的对象
        Season1 winter = Season1.valueOf("WINTER");
        System.out.println(winter);

        winter.show();
    }
}

interface Info{
    void show();
}

//使用enum关键字枚举类
enum Season1 implements Info{
    //1.提供当前枚举类的多个对象，多个对象之间用","隔开，末尾对象";"结束
    SPRING("春天","春暖花开"){
        @Override
        public void show() {
            System.out.println("春天在哪里？");
        }
    },
    SUMMER("夏天","夏日炎炎"){
        @Override
        public void show() {
            System.out.println("夏天在哪里");
        }
    },
    AUTUM("秋天","秋高气爽"){
        @Override
        public void show() {
            System.out.println("秋天在哪里");
        }
    },
    WINTER("冬天","冰天雪地"){
        @Override
        public void show() {
            System.out.println("冬天在哪里");
        }
    };

    //1.声明Season1对象的属性：private final修饰
    private final String seasonName;
    private final String seasonDesc;

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

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

    public String getSeasonDesc() {
        return seasonDesc;
    }

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

注解（Annotation）

注解

从JDK5.0 开始 , Java 增加了对元数据（MetaData）的支持，也就是Annotation（注解）。

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

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

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

示例二： 在编译时进行格式检查（JDK内置的三个基本注解）

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

自定义 Annotation

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

public @interface MyAnnotation{
    String value();
}

JDK中的元注解

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

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

• Retention

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

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

• Target

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

  取值（ElementType）		取值（ElementType）
  CONSTRUCTOR	用于描述构造器	PACKAGE	用于描述包
  FIELD	用于描述域	PARAMETER	用于描述参数
  LOCAL_VARIABLE	用于描述局部变量	TYPE	用于描述类，接口或enum声明
  METHOD	用于描述方法

• Documented

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

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

• Inherited

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

/**
 * 1.Annotation其实就是代码里的特殊标记，这些标记可以在编译、类加载，运行时被读取，并执行相应的处理。
 * 通过使用Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。
 * 2.在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。
 * 3.Annotation可以像修饰符一样被使用，可用于修饰包，类，构造器，方法，成员变量，参数，局部变量的声明，
 * 这些信息被保存在Annotation的"name=value"对中。
 *
 * 如何自定义注解，参照@SuppressWarnings定义
 *  1.注解声明为：@interface
 *  2.内部定义成员，通常使用value表示
 *  3.可以指定成员的默认值，使用default定义
 *  4.如果自定义注解没有成员，表明是一个标识作用
 *
 * 如果注解有成员，在使用注解时，需要指明成员的值
 * 自定义注解必须配上注解的信息处理流程（使用反射）才有意义
 * 自定义注解通常都会指明两个元数据：Retention，Target
 *
 * jdk提供的4种原注解
 * 元注解：对现有的注解进行解释说明的注解
 * - Retention：指定所修饰的Annotation的生命周期，SOURCE/CLASS(默认)/RUNTIME
 *      只有声明为RUNTIME生命周期的注解，才能通过反射获取
 *
 * - Target：用于指定被修饰的Annotation能用于修饰哪些程序元素
 * - Documented：表示所修饰的注解在被javadoc解析时，保留下来
 * - Inherited
 *
 * 可以通过反射获取注解信息
 *
 * jdk8中注解的新特性：可重复注解，类型注解
 * 可重复注解：(1)在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
 *            (2)MyAnnotation的Target和Retention和MyAnnotations相同。
 *
 * 类型注解：
 *  ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）
 *  ElementType.TYPE_USE    表示该注解能写在使用类型的任何语句中
 */
public class AnnotationTest {
    public static void main(String[] args) {
        Person p = new Student();
        p.walk();
    }

    @Test
    public void testGetAnnotation(){
        Class clazz = Student.class;
        Annotation[] annotations = clazz.getAnnotations();
        for (int i=0; i<annotations.length; i++){
            System.out.println(annotations[i]);
        }
    }
}
//jdk8之前
//@MyAnnotations({@MyAnnotation(value = "hi"),@MyAnnotation(value = "hi")})
@MyAnnotation("hi")
@MyAnnotation("abc")
class Person{
    private String name;
    private int age;

    public Person() {
    }

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

    public void walk(){
        System.out.println("人走路");
    }
    public void eat(){
        System.out.println("人吃饭");
    }
}
interface Info1{
    void show();
}
class Student extends Person implements Info1{
    @Override
    public void walk() {
        System.out.println("学生走路");
    }

    @Override
    public void show() {
    }
}
class Generic<@MyAnnotation T> {
    public void show(){
        ArrayList<@MyAnnotation String> list = new ArrayList<>();
        int num = (@MyAnnotation int) 10L;
    }
}

JDK8中注解的新特性

Java8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。

可重复注解示例

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

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

//jdk8之前
//@MyAnnotations({@MyAnnotation(value = "hi"),@MyAnnotation(value = "hi")})
@MyAnnotation("hi")
@MyAnnotation("abc")

类型注解

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

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

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

class Generic<@MyAnnotation T> {
    public void show(){
        ArrayList<@MyAnnotation String> list = new ArrayList<>();
        int num = (@MyAnnotation int) 10L;
    }
}