枚举类与注解

枚举类与注解

1.枚举类

①枚举类：类的对象只有有限个且确定

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

③如果枚举类中只有一个对象，则可以作为单例设计模式

（1）如何自定义枚举类（两种方式）

1.JDK5.0之前，自定义枚举类

public class java01 {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        System.out.println(spring);
        //在其它类中给属性赋值private Season season=Season.SPRING;
        //改变某个类中的属性值利用set方法setSeasom(Season.SUMMER);
    }
}

class Season {
    //1.使用不可变(private final)声明Season对象的属性
    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.其他诉求：获取枚举类对象的属性及toString()方法
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

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

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

public class java02 {
    public static void main(String[] args) {
        Season summer = Season.SUMMER;
        System.out.println(summer);//输出SUMMER为常量名
        System.out.println(Season.class.getSuperclass());//查看该类的父类:class java.lang.Enum
    }

}

//定义的枚举类默认继承class java.lang.Enum类
enum Season {
    //1.提供当前枚举类的对象：直接写 常量名（构造器） ，多个对象之间用逗号隔开，末尾用分号结束
    SPRING("春天", "春暖花开"),
    SUMMER("夏天", "夏暖花开"),
    AUTUMN("秋天", "秋暖花开"),
    WINTER("冬天", "冬暖花开");

    //2.使用不可变(private final)声明Season对象的属性，只有一个状态或属性可以不写，用变量名代替即可
    private final String seasonName;
    private final String seasonDesc;

    //3.私有化的构造器（有2就要有3）
    private Season1(String seasonName, String seasonDesc) {
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }


    //4.其他诉求：获取枚举类对象的属性，toString()方法一般在enum类中就不再重写了（可以重写）
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

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

（2）Enum类的主要方法（主要3个）

1.toString()：返回当前枚举类对象常量的名称（不重写的情况下）
    
  Season summer = Season.SUMMER;
  System.out.println(summer);//输出SUMMER为常量名

2.类名.values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值（在不重写toString()情况下打印所有常量名）。
    
  Season[] values = Season.values();
  for (int i = 0; i < values.length; i++) {
      System.out.println(values[i]);
  }

  //查看线程的状态
  Thread.State[] values = Thread.State.values();
  for (int i = 0; i < values1.length; i++) {
      System.out.println(values1[i]);
  }

3.valueOf(String str)：找指定名字的对象（可以把一个字符串转为对应的枚举类对象）。要求字符串必须是枚举类对象的“名字”否则会有运行时异常：IllegalArgumentException。
    //根据提供的str，返回枚举类中对象名是str的对象
    Season winter = Season.valueOf("WINTER");
    System.out.println(winter);

（3）实现接口的枚举类–使用enum关键字定义的枚举类实现接口的情况

情况一：实现接口实现Enum类中的抽象方法

public class java02 {
    public static void main(String[] args) {
        Season1 summer = Season1.SUMMER;
        summer.show();
    }
}

interface Info {
    void show();
}

//定义的枚举类默认继承class java.lang.Enum类
enum Season implements Info {
    //1.提供当前枚举类的对象：直接写 常量名（构造器） ，多个对象之间用逗号隔开，末尾用分号结束
    SPRING("春天", "春暖花开"),
    SUMMER("夏天", "夏暖花开"),
    AUTUMN("秋天", "秋暖花开"),
    WINTER("冬天", "冬暖花开");

    //2.使用不可变(private final)声明Season对象的属性
    private final String seasonName;
    private final String seasonDesc;

    //3.私有化的构造器
    private Season1(String seasonName, String seasonDesc) {
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }


    //4.其他诉求：获取枚举类对象的属性，toString()方法一般在enum类中就不再重写了（可以重写）
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

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

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

情况二：让枚举类的对象分别实现接口中的抽象方法

public class java02 {
    public static void main(String[] args) {
        Season[] values = Season.values();
        for (int i = 0; i < values.length; i++) {
            values[i].show();
        }
    }
}
interface Info {
    void show();
}
//定义的枚举类默认继承class java.lang.Enum类
enum Season implements Info {
    //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.使用不可变(private final)声明Season对象的属性
    private final String seasonName;
    private final String seasonDesc;

    //3.私有化的构造器
    private Season1(String seasonName, String seasonDesc) {
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }


    //4.其他诉求：获取枚举类对象的属性，toString()方法一般在enum类中就不再重写了（可以重写）
    public String getSeasonName() {
        return seasonName;
    }

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

可将之前的练习进行修改

public enum Status {
    //常量名，因为没有重写toString()类，因此在输出时直接输出常量名
    FREE, BUSY, VOCATION;
}

public class Programer extends Employee {
    private Status status = Status.FREE;（在别的类中直接引用--类名.变量名）
}

switch (p.getStatus()) {//byte short char int string 枚举类对象可以作为switch参数出现
    case BUSY://不用写Static.BUSY直接写BUSY即可
        throw new TeamExctption("该员工已是某团队成员");
    case VOCATION:
        throw new TeamExctption("该员工正在休假，无法添加");
}
//修改状态时仍用类名.常量名
p.setStatus(Status.BUSY);

2.注解（Annotation）

（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）常见的注解示例

示例一：生成文档相关的注解
@author 标明开发该类模块的作者，多个作者之间使用,分割
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明，如果没有参数就不能写
@return 对方法返回值的说明，如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写
    
示例二：在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings("all"): 抑制编译器警告，参数通常用all
    
示例三：跟踪代码依赖性，实现替代配置文件功能
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。
spring框架中关于“事务”的管理

（3）自定义Annotation

参照@SuppressWarnings定义

①注解声明为 @interface

②内部定义成员，通常使用value表示（类型 变量名();）–String value();

③可以指定成员的默认值，使用default定义(类型 变量名() default “”😉–String value() default “hello”;

注：类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。

​ 可以在定义Annotation的成员变量时为其指定初始值, 指定成员变量的初始值可使用default关键字，如果只有一个参数成员，建议使用参数名为value

④如果自定义注解没有成员，表明是一个标识作用

⑤使用时如果注解有成员，需要指定成员的值，如果在自定义类中有默认值，但可以再改

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

@Target(TYPE,METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnatation {
    //情况一：没默认值String value();--注解的参数--参数类型 参数名() default "默认值";--如果没有写默认值则使用MyAnnatation(value="值");必须要写值，若下面注解有了默认值则可以不写
    //情况二：默认值
    String value() default "hello";//变量为value时使用时可以省略变量名直接写值--@MyAnnatation("hi")
    int age() default 0;
    int id() default -1;//默认值为-1，代表不存在
    String[] schools();
}
//情况一：自定义注解中有值且没有默认值时一定要写值。
//@MyAnnatation(value = "hello",schools="华北理工大学，北京大学")如果只有一个成员可以不写成员名@MyAnnatation("hello")
//情况二：如果在自定义类中有默认值,如果对默认值不满意则可以再改
@MyAnnatation(value = "hello",schools="华北理工大学，北京大学")//因为有了默认值所以有些变量可以不用赋值，只写没写的或者是需要更改的即可
class Person {
    private String name;
}

（4）JDK中的元注解（4种）

1.说明

元注解：对现有的注解进行解释说明的注解，JDK 的元 Annotation 用于修饰其他 Annotation 定义（修饰其他注解的注解）

元数据的理解：对现有数据修饰的数据，如：String name = “atguigu”;

2.四种元注解

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

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

1.@Retention:只能用于修饰一个Annotation定义,用于指定该Annotation的生命周期(标识我们的注解再什么地方还有效), @Rentention包含一个RetentionPolicy类型的成员变量, 使用@Rentention 时必须为该value成员变量指定值:
(1)RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
(2)RetentionPolicy.CLASS:在class文件中有效（即class保留）,当运行Java程序时, JVM 不会保留注解。这是默认值
(3)RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行Java程序时,JVM 会保留注释。程序可以通过反射获取该注释。
注：只有声明为RUNTIME声明周期的注解才可以通过反射获取
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnatation {
    //情况一：没默认值String value();
    //情况二：默认值
    String value() default "hello";
}

2.@Target:指明所修饰的注解可以修饰哪些结构，一般使用在注解的定义之前，如：
@Retention(RetentionPolicy.RUNTIME)
//CONSTRUCTOR--注解可以修饰构造器	PACKAGE--注解可以修饰包	FIELD--注解可以描述域	PARAMETER--注解可以修饰参数
  LOCAL-VARIABLE--用于修饰局部变量	 TYPE--用于描述类、接口（包括注解类型）或enum声明	 METHOD--方法
@Target({FIELD,METHOD,LOCAL_VARIABLE})--标记Target之后MyAnnatation只可以用在这几个结构中
public @interface MyAnnatation {
    //情况一：没默认值String value();
    //情况二：默认值
    String value() default "hello";
}
注：自定义注解通常都会指明两个元注解：Retention、Target
3.@Documented:表示所修饰的注解在被javadoc解析时保留下来（不加默认是不保留的）。
4.@Inherited:被它修饰的注解将具有继承性(子类可以继承父类的注解)

（5）JDK8中注解的新特性

1.可重复注解

（1）说明：①在注解定义上声明一个@Repeatable(MyAnnotations.class)

​ ②MyAnnotation与MyAnnotations的Target和Retention等元注解都相同

​ ③在想使用的地方可以多次使用

//JDK8之前重复使用一个注解的写法
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({FIELD, METHOD, LOCAL_VARIABLE, TYPE})
public @interface MyAnnatation {
    String value() default "hello";
}
public @interface MyAnnotations {
    MyAnnatation[] value();
}
@MyAnnotations({@MyAnnatation(value = "h1"), @MyAnnatation(value = "h2")})
class Person {
    private String name;
}
//JDK8之后的写法
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({FIELD,METHOD,LOCAL_VARIABLE,TYPE})
public @interface MyAnnatation {
    String value() default "hello";
}
@Retention(RetentionPolicy.RUNTIME)
@Target({FIELD,METHOD,LOCAL_VARIABLE,TYPE})
public @interface MyAnnotations {
    MyAnnatation[] value();
}
@MyAnnatation(value = "h1")
@MyAnnatation(value = "h2")
class Person {
    private String name;
}

2.类型注解

（1）说明:JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER,TYPE_USE。在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用 在任何地方。

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

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