11.java之枚举类与注解

1.枚举类

1.1 枚举类的使用

1.枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类
2.当需要定义一组常量时，强烈建议使用枚举类
3.如果枚举类中只有一个对象，则可以作为单例模式的实现方式

1.2 如何定义枚举类

方式一：JDK5.0之前，自定义枚举类

package java2;

/**
 * @author wang
 * @description 1
 * @data 2022-04-12 21:15
 */
public class SeasonTest {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        System.out.println(spring.toString());
    }
}

//自定义枚举类
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 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 + '\'' +
                '}';
    }
}

方式二：JDK5.0时，可以使用enum关键字定义枚举类
说明：定义的枚举类默认继承于java.lang.Enum类

package java2;

/**
 * @author wang
 * @description
 * @data 2022-04-12 21:30
 */
public class SeasonTest2 {
    public static void main(String[] args) {
        Season2 summer = Season2.SUMMER;
        System.out.println(summer);

        
    }
}

enum Season2{
    // 1.提供当前枚举类的对象，多个对象之间用“,”隔开；末尾对象“;”结束
    SPRING("春天","春暖花开"),
    SUMMER("夏天","夏日炎炎"),
    AUTUMN("秋天","秋高气爽"),
    WINTER("冬天","冰天雪地");

    // 2.声明Season对象的属性:private final修饰
    private final String seasonName;
    private final String seasonDesc;

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

    // 3.提供当前枚举类的多个对象：public static final的

    // 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 + '\'' +
//                '}';
//    }
}

1.3 Enum类中的常用方法

Enum类的主要方法：

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

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

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

package java2;

/**
 * @author wang
 * @description
 * @data 2022-04-12 21:30
 */
public class SeasonTest2 {
    public static void main(String[] args) {
        Season2 summer = Season2.SUMMER;
        System.out.println(summer);

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

        Thread.State[] values1 = Thread.State.values();
        for (int i = 0;i < values1.length;i++){
            System.out.println(values1[i]);
        }

        // valueOf(String str):返回枚举类中对象名为objName的对象
        // 如果没有objName的枚举类对象，则抛出异常
        Season2 winter = Season2.valueOf("WINTER");
        System.out.println(winter);

        winter.show();
    }
}

interface Info{
    void show();
}

enum Season2 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.声明Season对象的属性:private final修饰
    private final String seasonName;
    private final String seasonDesc;

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

    // 3.提供当前枚举类的多个对象：public static final的

    // 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 + '\'' +
//                '}';
//    }

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

2.注解的使用

2.1 注解（Annotation）概述

• 从 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.2 Annotation的使用示例

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

package com.annotation.javadoc;
/**
 * @author shkstart
 * @version 1.0
 * @see Math.java
 */
public class JavadocTest {
    /**
     * 程序的主方法，程序的入口
     * @param args String[] 命令行参数
     */
    public static void main(String[] args) {
    }
    /**
     * 求圆面积的方法
     * @param radius double 半径值
     * @return double 圆的面积
     */
    public static double getArea(double radius){
        return Math.PI * radius * radius;
    }
}

示例二：在编译时进行格式检查(JDK内置的三个基本注解)
  @Override: 限定重写父类方法, 该注解只能用于方法
  @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
  @SuppressWarnings: 抑制编译器警告

package com.annotation.javadoc;
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方法()";
    }
}

示例三：跟踪代码依赖性，实现替代配置文件功能
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

@WebServlet("/login")
public class LoginServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws
            ServletException, IOException { }
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws
            ServletException, IOException {
        doGet(request, response);
    } 
}

<servlet>
    <servlet-name>LoginServlet</servlet-name>
    <servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>LoginServlet</servlet-name>
    <url-pattern>/login</url-pattern>
</servlet-mapping>

2.3 如何自定义注解

参照：@SuppressWarnings定义

① 注解声明为：@interface
② 内部定义成员，通常使用value表示
③ 可以指定成员的默认值，使用default定义
④ 如果自定义注解没有成员，表明是一个标识作用

如果注解有成员，在使用注解时，需要指明成员的值。
自定义注解必须配上注解的信息处理流程（使用反射）才有意义。
自定义注解一般都会指明两个元注解：Retention、Target

@Inherited
public @interface MyAnnotation {
    String value() default "hello";
}

2.4 JDK提供的4中元注解

元注解：对现有注解进行解释说明的注解
Retention：指明指定所修饰Annotation的生命周期：SOURCE\CLASS(默认)\RUNTIME(只有声明为RUNTIME声明周期的注解，才能通过反射获取)
Target：用于指定被修饰的Annotation能用于修饰那些程序元素

出现频率低：
Documented：表示所修饰的注解再被javadoc解析时被保留下来
Inherited：所修饰的注解具有继承性

2.5 通过反射来获取注解信息 — 到反射内容时系统讲解

    @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]);
        }
    }

2.6 JDK8中注解的新特性：可重复注解、类型注解

2.6.1 可重复注解

① 在MyAnnotation上声明@Repeatable，成员之为MyAnnotations.class
② MyAnnotation的Target和Retention等元注解要与MyAnnotations相同

package java2;

import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;


@Inherited
@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
    String value() default "hello";
}

package java2;

import java.lang.annotation.Inherited;

@Inherited
public @interface MyAnnotations {
    MyAnnotation[] value();
}


//JDK8之前的写法
@MyAnnotations({@MyAnnotation(value = "hi"),@MyAnnotation(value = "hi")})

//JDK8之后的写法
@MyAnnotation(value = "hi")
@MyAnnotation(value = "hi")

2.6.2 类型注解

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

package java2;

import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;


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


class Generic<@MyAnnotation T>{
    public void show() throws @MyAnnotation RuntimeException{
        ArrayList<@MyAnnotation String> list = new ArrayList<>();

        int num = (@MyAnnotation int)10L;
    }
}