Java学习——Day10：枚举与注解

三、枚举类&注解

3.1 枚举类

package study.javaSenior.enumClass;

/**
 * 一、枚举类的使用
 * 1.枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类
 * 2.当需要定义一组常量时，强烈建议使用枚举类
 * 3.如果枚举类中只有一个对象，则可以作为单例模式的实现方式
 *
 * 二、如何定义枚举类
 * 1.jdk5.0之前自定义枚举类
 * 2.jdk5.0时，可以使用enum关键字定义枚举类
 *   说明：定义的枚举类默认继承于java.lang.Enum
 *
 * 三、Enum中常用的方法
 *  values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
 *  valueOf(String str)：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是，会有运行时异常：IllegalArgumentException。
 *  toString()：返回当前枚举类对象常量的名称
 *
 * 四、使用enum关键字定义的枚举类实现接口的情况
 *  情况一：实现接口，在enum类中实现抽象方法
 *  情况二：让枚举类的每个对象分别实现接口中的抽象方法
 * @author zhengxu
 * @create 2021-06-24 10:25
 */
public class SeasonTest {
    public static void main(String[] args) {
        Season spring=Season.SPRING;
        System.out.println(spring);//Season{seasonName='春天', seasonDesc='春暖花开'}

        Season1 summer=Season1.SUMMER;
        System.out.println(summer);//SUMMER

        System.out.println("***************************");
        //values()方法
        Season1[] values = Season1.values();
        for (int i = 0; i < values.length; i++) {
            System.out.println(values[i]);//SPRING\SUMMER\AUTUMN\WINTER
        }
        Thread.State[] values1=Thread.State.values();
        for (int i = 0; i < values1.length; i++) {
            System.out.println(values1[i]);//NEW\RUNNABLE\\\\\
        }
        //valueof(String objName):根据提供的对象名，返回相对应的对象，没找到就抛异常
        Season1 winter=Season1.valueOf("WINTER");
        System.out.println(winter);//WINTER

        winter.show();//这是一个季节

    }
}

//使用enum关键字定义枚举类实现接口
interface info{
    void show();
}

//jdk5.0时：使用enum关键字定义枚举类
enum Season1 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("冬天的秘密");
        }
    };

    //1.声明Season对象的属性
    private final String seasonName;
    private final String seasonDesc;

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

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

//jdk5.0之前：自定义枚举类
class Season{
    //1.声明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 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.其他诉求1:获取枚举类的对象

    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

    //5.其他诉求2：提供toString()

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

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

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

  • @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的部署。

  • spring框架中关于“事务”的管理

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

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

package study.javaSenior.annotation;

import java.util.Date;

/**
 * 注解的使用示例
 * @author zhengxu
 * @create 2021-06-24 11:31
 */
public class AnnotationTest {
    public static void main(String[] args) {
        Person person=new Person();
        person.walk();

        //使用示例二：@Deprecated,表示该结构已经过时了
        Date date=new Date(2021,6,24);

        @SuppressWarnings("unused")
        int num=10;//变量没有被使用时，会显示灰色,不会被编译，但加上上方关键字时就会被编译
    }
}


@MyAnnotation(value="hi")
class Person{
    private String name;
    private int age;

    public Person() {
    }

    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 Info{
   void show();
}

//使用示例一：重写父类方法或者重写接口方法，override
class Student extends Person implements Info {
    @Override
    public void walk(){
        System.out.println("学生走路");
    }

    @Override
    public void show() {
        System.out.println("学生展示");
    }
}

package study.javaSenior.annotation;

/**
 * 自定义新的 Annotation 类型使用 @interface 关键字，参照@SuppressWarning定义
 * ①注解声明为：@interface
 * ②内部定义成员，通常使用value表示
 * ③可以指定成员的默认值，使用default定义
 * ④如果自定义注释没有成员，表示是一个标识作用
 *
 * 自定义注解必须配上注解的信息处理流程（使用反射）才有意义。
 * @author zhengxu
 * @create 2021-06-24 21:41
 */
public @interface MyAnnotation {
    String value() default "hello";//可以自定义一个默认值
}

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

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

  • Retention
  • Target
  • Documented
  • Inherited

package study.javaSenior.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * 元注解：对现有注解进行修饰
 * @Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个
 *             RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:
 *             RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
 *             RetentionPolicy.CLASS（默认行为）:在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM不会保留注解。
 *             RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。
 *
 * @Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。
 *
 * @Documented: 表示所修饰的注解在被javadoc解析时，保留下来。定义为Documented的注解必须设置Retention值为RUNTIME。
 *
 * @Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
 *             比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解
 *             实际应用中，使用较少
 * @author zhengxu
 * @create 2021-06-25 9:05
 */

@Inherited
@Documented
@Retention(java.lang.annotation.RetentionPolicy.RUNTIME)//标识该注解仅在运行时有效
@Target({java.lang.annotation.ElementType.TYPE, java.lang.annotation.ElementType.METHOD})//表示该注解只能用于描述类和方法
public @interface MyAnnotation01 {
    String value() default "hello";
}

//@Retention
enum RetentionPolicy{
    SOURCE,
    CLASS,
    RUNTIME
}

//@Target
enum ElementType{
    TYPE,//用于描述类、接口（包括注解类型）或enum声明
    FIELD,//用于描述域
    METHOD,//用于描述方法
    PARAMETER,//用于描述参数
    CONSTRUCTOR,//用于描述构造器
    LOCAL_VARIABLE,//用于描述构造器
    PACKAGE,//用于描述包
    //jdk1.8新增
    TYPE_PARAMETER,//表示该注解能写在类型变量的声明语句中（如：泛型声明）。
    TYPE_USE；//表示该注解能写在使用类型的任何语句中
}

【注意】：注解一般配合反射来使用

• 可重复注解：
  • 在MyAnnotation上声明@Repeatable,成员值为MyAnnotations.class
  • MyAnnotation的Target和Retention等元注解相同

【注意】：重复注解的元注解必须一致