JavaSe:枚举&注解

🎈枚举类的使用

主要内容

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

类的对象只有有限个，确定的。

举例如下：

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

💔自己定义枚举类@Deprecated

package pers.dhx_.java0607;

/**
 * @author Dhx_
 * @className SeasonTest
 * @description TODO
 * @date 2022/6/7 9:21
 */
public class SeasonTest {
    Season nowSeason = Season.SUMMER;
}

//自定义枚举类   JDK 5.0之前
// 使用 enum JDK 5.0之后
class Season {
    //1.声明Season对象的属性：private final 修饰
    private final String type;
    //私有化类的构造器
    private Season(String type) {	this.type = type;}
    private Season() {type = null;}

    //提供当前枚举类的有限个对象，声明为 public static final
public static final Season SPRING = new Season("SPRING");
public static final Season SUMMER = new Season("SUMMER");
public static final Season AUTUMN = new Season("AUTUMN");
public static final Season WINTER = new Season("WINTER");
    //4.其他诉求  (get  属性)

    public String getType() {
        return type;
    }

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

使用enum定义枚举类

💃使用说明

使用 enum 定义的枚举类默认继承了 java.lang.Enum类，因此不能再继承其他类

• 枚举类的构造器只能使用 private 权限修饰符

• 枚举类的所有实例必须在枚举类中显式列出(, 分隔 ; 结尾)。列出的实例系统会自动添加 public static final 修饰

• 必须在枚举类的第一行声明枚举类对象

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

💃常用方法

Enum类的主要方法：

values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。

valueOf(String str)：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是，会有运行时异常：IllegalArgumentException。

toString()：返回当前枚举类对象常量的名称

迭代枚举元素

可以使用 for 语句来迭代枚举元素：

enum Color
{
    RED, GREEN, BLUE;
}
public class MyClass {
  public static void main(String[] args) {
    for (Color myVar : Color.values()) {
      System.out.println(myVar);
    }
  }
}
//RED
//GREEN
//BLUE

switch 中使用枚举类

enum Color
{
    RED, GREEN, BLUE;
}
public class MyClass {
  public static void main(String[] args) {
    Color myVar = Color.BLUE;

    switch(myVar) {
      case RED:
        System.out.println("红色");
        break;
      case GREEN:
         System.out.println("绿色");
        break;
      case BLUE:
        System.out.println("蓝色");
        break;
    }
  }
}

枚举类成员

枚举跟普通类一样可以用自己的变量、方法和构造函数，构造函数只能使用 private 访问修饰符，所以外部无法调用。

枚举既可以包含具体方法，也可以包含抽象方法。 如果枚举类具有抽象方法，则枚举类的每个实例都必须实现它。

enum Color
{
    RED, GREEN, BLUE;
 
    // 构造函数
    private Color()
    {
        System.out.println("Constructor called for : " + this.toString());
    }
 
    public void colorInfo()
    {
        System.out.println("Universal Color");
    }
}
 
public class Test
{    
    // 输出
    public static void main(String[] args)
    {
        Color c1 = Color.RED;
        System.out.println(c1);
        c1.colorInfo();
    }
}

枚举类中的抽象方法实现

enum Color{
    RED{
        public String getColor(){//枚举对象实现抽象方法
            return "红色";
        }
    },
    GREEN{
        public String getColor(){//枚举对象实现抽象方法
            return "绿色";
        }
    },
    BLUE{
        public String getColor(){//枚举对象实现抽象方法
            return "蓝色";
        }
    };
    public abstract String getColor();//定义抽象方法
}

public class Test{
    public static void main(String[] args) {
        for (Color c:Color.values()){
            System.out.print(c.getColor() + "、");
        }
    }
}

⭐课程

package pers.dhx_.java0607;

/**
 * @author Dhx_
 * @className SeasonTest
 * @description TODO
 * @date 2022/6/7 9:21
 */
public class SeasonTest {

    public static void main(String[] args) {
        Season nowSeason = Season.SUMMER;
        System.out.println(Season.SUMMER); // enum 类会自动重写 toString 方法 ,直接输出 对象的名字
        System.out.println(Season.class.getClass()); //class java.lang.Class
        //枚举类默认继承于 java.lang.Class
        //valueOf(String objName) ,根据提供的objName ，返回枚举类中对象名为objName对应的对象
        Season test = Season.valueOf("WINTER");
        System.out.println(test); //WINTER
    }
}

interface test {
    void show();
}

enum Season implements test {
    //1.提供当前枚举类的对象，多个 对象之间用 " , " 隔开，末尾对象用 ' ; ' 结束
    SPRING("SPRING") {
        public void show() {
            System.out.println("This is SPRING");
        }

        public String getSeason() {
            return "spring";
        }

    },
    SUMMER("SUMMER") {
        public void show() {
            System.out.println("This is SUMMER");
        }

        public String getSeason() {
            return "summer";
        }
    },
    AUTUMN("AUTUMN") {
        public void show() {
            System.out.println("This is AUTUMN");
        }

        public String getSeason() {
            return "autumn";
        }
    },
    WINTER("WINTER") {
        public void show() {
            System.out.println("This is WINTER");
        }

        public String getSeason() {
            return "winter";
        }
    };
    private final String type;    //声明Season 对象的属性 ; private final 修饰

    private Season(String type) {    //私有化类的构造器，并给对象属性赋值

        this.type = type;
    }

    private Season() {
        type = null;
    }

    public String getType() {    //4.其他诉求  (get  属性)
        return type;
    }

    @Override //TODO 重写抽象方法 ，可以在类里面重写，也可以每个对象都重写
    public void show() {
    }

    public abstract String getSeason();//定义抽象方法
}

🎈注解(Annotation)

• 基础阶段要求较低，企业开发要求较高。

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。

Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。

🐘简易便于理解版本

如果注解有成员，在使用注解时，必须知名成员的值。

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

自定义注解 通过都会指明两个元注解：Retntion， Target

• JDK提供的四种元注解

  元注解：对现有的注解进行解释说明的注解，

  1.Retention(保持)：

  指定所修饰的 Annotation 的生命周期,

  • SOURCE

  • CLASS（默认）

  • RUNTIME

    只有被声明为RUNTIME生命周期的注解才能通过反射获取

  2.TARGET

  用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。

  

  以下出现频率较低：

  3.Documented(记录在案的)

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

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

  4.Inherited(继承)

  被它修饰的 Annotation 将具有继承性。

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

  比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解

  • 实际应用中，使用较少

  //自定义注解自动继承了java.lang.annotation.Annotation接口
  @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
  @Retention(RetentionPolicy.SOURCE)
  public @interface MyAnnotation {//跟接口没有任何关系
  
      @SuppressWarnings("unused")
      String value() default "helloJava"; 
      //使用default设定默认值
  }

🍚java8 注解新特性

⭐可重复注解

Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，

反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法

参数上的注解。

做法:

1. 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
2. MyAnnotation的Target以及Retention需要于MyAnnotations相同

@Inherited
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
public @interface MyAnnotation {//跟接口没有任何关系
 String value() default "helloJava"; //使用default设定默认值
}

🌟类型注解

ElementType.java

/**
 * Type parameter declaration
 *
 * @since 1.8   //java8 
 */
TYPE_PARAMETER,  //
class Generic<@MyAnnotation T>
{
}
/**
 * Use of a type
 *
 * @since 1.8  //java8 
 */
TYPE_USE,   //类型注解
public void show() throws @MyAnnotation RuntimeException
{
  Arraylist<@MyAnnotation  String>lsit=new ArrayList<>();
  int num =(@MyAnnotation int)10L;
}
/**
 * Module declaration.  //模块注解
 * @since 9
 */
MODULE

主要内容：

• 注解(Annotation)概述
• 常见的Annotation示例
• 自定义Annotation
• JDK中的元注解
• 利用反射获取注解信息（在反射部分涉及）
• JDK 8中注解的新特性

内置的注解

Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是

• @Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。

• @Deprecated - 标记过时方法。如果使用该方法，会报编译警告。

• @SuppressWarnings - 指示编译器去忽略注解中声明的警告。作用在其他注解的注解(或者说 元注解)是:

• @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。

• @Documented - 标记这些注解是否包含在用户文档中。

• @Target - 标记这个注解应该是哪种 Java 成员。

• @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

从 Java 7 开始，额外添加了 3 个注解:

• @SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
• @FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
• @Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

1、Annotation 架构

从中，我们可以看出：

(01) 1 个 Annotation 和 1 个 RetentionPolicy 关联。

可以理解为：每1个Annotation对象，都会有唯一的RetentionPolicy属性。

(02) 1 个 Annotation 和 1~n 个 ElementType 关联。

可以理解为：对于每 1 个 Annotation 对象，可以有若干个 ElementType 属性。

(03) Annotation 有许多实现类，包括：Deprecated, Documented, Inherited, Override 等等。

Annotation 的每一个实现类，都 “和 1 个 RetentionPolicy 关联” 并且 " 和 1~n 个 ElementType 关联"。

下面，我先介绍框架图的左半边(如下图)，即 Annotation, RetentionPolicy, ElementType；然后在就 Annotation 的实现类进行举例说明。

2、Annotation 组成部分

java Annotation 的组成中，有 3 个非常重要的主干类。它们分别是：

Annotation.java

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

ElementType.java

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口（包括注释类型）或枚举声明  */

    FIELD,              /* 字段声明（包括枚举常量）  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

RetentionPolicy.java

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

说明：

(01) Annotation 就是个接口。

“每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联，并且与 “1～n 个 ElementType” 关联。可以通俗的理解为：每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；至于 ElementType 属性，则有 1~n 个。

(02) ElementType 是 Enum 枚举类型，它用来指定 Annotation 的类型。

“每 1 个 Annotation” 都与 “1～n 个 ElementType” 关联。当 Annotation 与某个 ElementType 关联时，就意味着：Annotation有了某种用途。例如，若一个 Annotation 对象是 METHOD 类型，则该 Annotation 只能用来修饰方法。

(03) RetentionPolicy 是 Enum 枚举类型，它用来指定 Annotation 的策略。通俗点说，就是不同 RetentionPolicy 类型的 Annotation 的作用域不同。

“每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联。

• a) 若 Annotation 的类型为 SOURCE，则意味着：Annotation 仅存在于编译器处理期间，编译器处理完之后，该 Annotation 就没用了。 例如，" @Override" 标志就是一个 Annotation。当它修饰一个方法的时候，就意味着该方法覆盖父类的方法；并且在编译期间会进行语法检查！编译器处理完后，“@Override” 就没有任何作用了。
• b) 若 Annotation 的类型为 CLASS，则意味着：编译器将 Annotation 存储于类对应的 .class 文件中，它是 Annotation 的默认行为。
• c) 若 Annotation 的类型为 RUNTIME，则意味着：编译器将 Annotation 存储于 class 文件中，并且可由JVM读入。

这时，只需要记住"每 1 个 Annotation" 都与 “1 个 RetentionPolicy” 关联，并且与 “1～n 个 ElementType” 关联。学完后面的内容之后，再回头看这些内容，会更容易理解。

3、java 自带的 Annotation

理解了上面的 3 个类的作用之后，我们接下来可以讲解 Annotation 实现类的语法定义了

1）Annotation 通用定义

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation1 {
}

说明：

上面的作用是定义一个 Annotation，它的名字是 MyAnnotation1。定义了 MyAnnotation1 之后，我们可以在代码中通过 “@MyAnnotation1” 来使用它。 其它的，@Documented, @Target, @Retention, @interface 都是来修饰 MyAnnotation1 的。下面分别说说它们的含义：

(01) @interface

使用 @interface 定义注解时，意味着它实现了 java.lang.annotation.Annotation 接口，即该注解就是一个Annotation。

定义 Annotation 时，@interface 是必须的。

注意：它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后，该注解不能继承其他的注解或接口。

(02) @Documented

类和方法的 Annotation 在缺省情况下是不出现在 javadoc 中的。如果使用 @Documented 修饰该 Annotation，则表示它可以出现在 javadoc 中。

定义 Annotation 时，@Documented 可有可无；若没有定义，则 Annotation 不会出现在 javadoc 中。

(03) @Target(ElementType.TYPE)

前面我们说过，ElementType 是 Annotation 的类型属性。而 @Target 的作用，就是来指定 Annotation 的类型属性。

@Target(ElementType.TYPE) 的意思就是指定该 Annotation 的类型是 ElementType.TYPE。这就意味着，MyAnnotation1 是来修饰"类、接口（包括注释类型）或枚举声明"的注解。

定义 Annotation 时，@Target 可有可无。若有 @Target，则该 Annotation 只能用于它所指定的地方；若没有 @Target，则该 Annotation 可以用于任何地方。

(04) @Retention(RetentionPolicy.RUNTIME)

前面我们说过，RetentionPolicy 是 Annotation 的策略属性，而 @Retention 的作用，就是指定 Annotation 的策略属性。

@Retention(RetentionPolicy.RUNTIME) 的意思就是指定该 Annotation 的策略是 RetentionPolicy.RUNTIME。这就意味着，编译器会将该 Annotation 信息保留在 .class 文件中，并且能被虚拟机读取。

定义 Annotation 时，@Retention 可有可无。若没有 @Retention，则默认是 RetentionPolicy.CLASS。

2）java自带的Annotation

通过上面的示例，我们能理解：@interface 用来声明 Annotation，@Documented 用来表示该 Annotation 是否会出现在 javadoc 中， @Target 用来指定 Annotation 的类型，@Retention 用来指定 Annotation 的策略。

理解这一点之后，我们就很容易理解 java 中自带的 Annotation 的实现类，即 Annotation 架构图的右半边。如下图：

java 常用的 Annotation：

@Deprecated  -- @Deprecated 所标注内容，不再被建议使用。
@Override    -- @Override 只能标注方法，表示该方法覆盖父类中的方法。
@Documented  -- @Documented 所标注内容，可以出现在javadoc中。
@Inherited   -- @Inherited只能被用来标注“Annotation类型”，它所标注的Annotation具有继承性。
@Retention   -- @Retention只能被用来标注“Annotation类型”，而且它被用来指定Annotation的RetentionPolicy属性。
@Target      -- @Target只能被用来标注“Annotation类型”，而且它被用来指定Annotation的ElementType属性。
@SuppressWarnings -- @SuppressWarnings 所标注内容产生的警告，编译器会对这些警告保持静默。

由于 “@Deprecated 和 @Override” 类似，“@Documented, @Inherited, @Retention, @Target” 类似；下面，我们只对 @Deprecated, @Inherited, @SuppressWarnings 这 3 个 Annotation 进行说明。

2.1) @Deprecated

@Deprecated 的定义如下：

@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Deprecated {
}

说明：

• (01) @interface – 它的用来修饰 Deprecated，意味着 Deprecated 实现了 java.lang.annotation.Annotation 接口；即 Deprecated 就是一个注解。 (02) @Documented – 它的作用是说明该注解能出现在 javadoc 中。
• (03) @Retention(RetentionPolicy.RUNTIME) – 它的作用是指定 Deprecated 的策略是 RetentionPolicy.RUNTIME。这就意味着，编译器会将Deprecated 的信息保留在 .class 文件中，并且能被虚拟机读取。
• (04) @Deprecated 所标注内容，不再被建议使用。

例如，若某个方法被 @Deprecated 标注，则该方法不再被建议使用。如果有开发人员试图使用或重写被 @Deprecated 标示的方法，编译器会给相应的提示信息。示例如下:

DeprecatedTest.java

import java.util.Date;
import java.util.Calendar;

public class DeprecatedTest {
// @Deprecated 修饰 getString1(),表示 它是建议不被使用的函数
  @Deprecated
  private static void getString1(){
    System.out.println("Deprecated Method");
  }
  
  private static void getString2(){
    System.out.println("Normal Method");
  }
  
  // Date是日期/时间类。java已经不建议使用该类了
  private static void testDate() {
    Date date = new Date(113, 8, 25);
    System.out.println(date.getYear());
  }
  // Calendar是日期/时间类。java建议使用Calendar取代Date表示"日期/时间"
  private static void testCalendar() {
    Calendar cal = Calendar.getInstance();
    System.out.println(cal.get(Calendar.YEAR));
  }
  
  public static void main(String[] args) {
    getString1();
    getString2();
    testDate();
    testCalendar();
  }
}

说明：

上面是 eclipse 中的截图，比较类中 “getString1() 和 getString2()” 以及 “testDate() 和 testCalendar()” 。

(01) getString1() 被 @Deprecated 标注，意味着建议不再使用 getString1(); 所以 getString1() 的定义和调用时，都会一横线。这一横线是eclipse() 对 @Deprecated 方法的处理。

getString2() 没有被 @Deprecated 标注，它的显示正常。

(02) testDate() 调用了 Date 的相关方法，而 java 已经建议不再使用 Date 操作日期/时间。因此，在调用 Date的API 时，会产生警告信息，途中的 warnings。

testCalendar() 调用了 Calendar 的 API 来操作日期/时间，java 建议用 Calendar 取代 Date。因此，操作 Calendar 不会产生 warning。

2.2) @Inherited

@Inherited 的定义如下：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
}

说明：

• (01) @interface – 它的用来修饰 Inherited，意味着 Inherited 实现了 java.lang.annotation.Annotation 接口；即 Inherited 就是一个注解。
• (02) @Documented – 它的作用是说明该注解能出现在 javadoc 中。
• (03) @Retention(RetentionPolicy.RUNTIME) – 它的作用是指定 Inherited 的策略是 RetentionPolicy.RUNTIME。这就意味着，编译器会将 Inherited 的信息保留在 .class 文件中，并且能被虚拟机读取。
• (04) @Target(ElementType.ANNOTATION_TYPE) – 它的作用是指定 Inherited 的类型是 ANNOTATION_TYPE。这就意味着，@Inherited 只能被用来标注 “Annotation 类型”。
• (05) @Inherited 的含义是，它所标注的Annotation将具有继承性。

假设，我们定义了某个 Annotaion，它的名称是 MyAnnotation，并且 MyAnnotation 被标注为 @Inherited。现在，某个类 Base 使用了

MyAnnotation，则 Base 具有了"具有了注解 MyAnnotation"；现在，Sub 继承了 Base，由于 MyAnnotation 是 @Inherited的(具有继承性)，所以，Sub 也 “具有了注解 MyAnnotation”。

@Inherited 的使用示例:

InheritableSon.java

import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Inherited;


 //自定义的Annotation。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@interface Inheritable
{
}

@Inheritable
class InheritableFather
{
  public InheritableFather() {
    // InheritableBase是否具有 Inheritable Annotation
    System.out.println("InheritableFather:"+InheritableFather.class.isAnnotationPresent(Inheritable.class));
  }
}

// InheritableSon 类只是继承于 InheritableFather，

public class InheritableSon extends InheritableFather
{
  public InheritableSon() {
    super();   // 调用父类的构造函数
    // InheritableSon类是否具有 Inheritable Annotation
    System.out.println("InheritableSon:"+InheritableSon.class.isAnnotationPresent(Inheritable.class));
  }
  
  public static void main(String[] args)
  {
    InheritableSon is = new InheritableSon();
  }
}

运行结果：

InheritableFather:true
InheritableSon:true

现在，我们对 InheritableSon.java 进行修改：注释掉 “Inheritable 的 @Inherited 注解”。

InheritableSon.java

import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import  java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Inherited;


  //自定义的Annotation。
 
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
//@Inherited
@interface Inheritable
{
}

@Inheritable
class InheritableFather
{
  public InheritableFather() {
    // InheritableBase是否具有 Inheritable Annotation
    System.out.println("InheritableFather:"+InheritableFather.class.isAnnotationPresent(Inheritable.class));
  }
}


 // InheritableSon 类只是继承于 InheritableFather，
 
public class InheritableSon extends InheritableFather
{
  public InheritableSon() {
    super();   // 调用父类的构造函数
    // InheritableSon类是否具有 Inheritable Annotation
    System.out.println("InheritableSon:"+InheritableSon.class.isAnnotationPresent(Inheritable.class));
  }
  
  public static void main(String[] args)
  {
    InheritableSon is = new InheritableSon();
  }
}

运行结果：

InheritableFather:true
InheritableSon:false

对比上面的两个结果，我们发现：当注解 Inheritable 被 @Inherited 标注时，它具有继承性。否则，没有继承性。

2.3) @SuppressWarnings

@SuppressWarnings 的定义如下：

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

说明：

(01) @interface – 它的用来修饰 SuppressWarnings，意味着 SuppressWarnings 实现了 java.lang.annotation.Annotation 接口；即 SuppressWarnings 就是一个注解。

(02) @Retention(RetentionPolicy.SOURCE) – 它的作用是指定 SuppressWarnings 的策略是 RetentionPolicy.SOURCE。这就意味着，SuppressWarnings 信息仅存在于编译器处理期间，编译器处理完之后 SuppressWarnings 就没有作用了。

(03) @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) – 它的作用是指定 SuppressWarnings 的类型同时包括TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE。

• TYPE 意味着，它能标注"类、接口（包括注释类型）或枚举声明"。
• FIELD 意味着，它能标注"字段声明"。
• METHOD 意味着，它能标注"方法"。
• PARAMETER 意味着，它能标注"参数"。
• CONSTRUCTOR 意味着，它能标注"构造方法"。
• LOCAL_VARIABLE 意味着，它能标注"局部变量"。

(04) String[] value(); 意味着，SuppressWarnings 能指定参数

(05) SuppressWarnings 的作用是，让编译器对"它所标注的内容"的某些警告保持静默。例如，“@SuppressWarnings(value={“deprecation”, “unchecked”})” 表示对"它所标注的内容"中的 "SuppressWarnings 不再建议使用警告"和"未检查的转换时的警告"保持沉默。示例如下：

SuppressWarningTest.java

import java.util.Date;

public class SuppressWarningTest {

  //@SuppressWarnings(value={"deprecation"})*
  public static void doSomething(){
    Date date = new Date(113, 8, 26);
    System.out.println(date);
  }
  public static void main(String[] args) {
    doSomething();
  }
}

说明：

(01) 左边的图中，没有使用 @SuppressWarnings(value={“deprecation”}) , 而 Date 属于 java 不再建议使用的类。因此，调用 Date 的 API 时，会产生警告。而右边的途中，使用了 @SuppressWarnings(value={“deprecation”})。因此，编译器对"调用 Date 的 API 产生的警告"保持沉默。

补充：SuppressWarnings 常用的关键字的表格

deprecation  -- 使用了不赞成使用的类或方法时的警告
unchecked    -- 执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型。
fallthrough  -- 当 Switch 程序块直接通往下一种情况而没有 Break 时的警告。
path         -- 在类路径、源文件路径等中有不存在的路径时的警告。
serial       -- 当在可序列化的类上缺少 serialVersionUID 定义时的警告。
finally      -- 任何 finally 子句不能正常完成时的警告。
all          -- 关于以上所有情况的警告。

---

4、Annotation 的作用

Annotation 是一个辅助类，它在 Junit、Struts、Spring 等工具框架中被广泛使用。

我们在编程中经常会使用到的 Annotation 作用有：

1）编译检查

Annotation 具有"让编译器进行编译检查的作用"。

例如，@SuppressWarnings, @Deprecated 和 @Override 都具有编译检查作用。

(01) 关于 @SuppressWarnings 和 @Deprecated，已经在"第3部分"中详细介绍过了。这里就不再举例说明了。

(02) 若某个方法被 @Override 的标注，则意味着该方法会覆盖父类中的同名方法。如果有方法被 @Override 标示，但父类中却没有"被 @Override 标注"的同名方法，则编译器会报错。示例如下：

OverrideTest.java

public class OverrideTest {

  /*
    toString() 在java.lang.Object中定义；
    因此，这里用 @Override 标注是对的。
   */
  @Override
  public String toString(){
    return "Override toString";
  }

/*
    getString() 没有在OverrideTest的任何父类中定义；
    但是，这里却用 @Override 标注，因此会产生编译错误！
  */
  @Override
  public String getString(){
    return "get toString";
  }
  
  public static void main(String[] args) {
  }
}

上面是该程序在 eclipse 中的截图。从中，我们可以发现 “getString()” 函数会报错。这是因为 “getString() 被 @Override 所标注，但在OverrideTest 的任何父类中都没有定义 getString1() 函数”。

“将 getString() 上面的 @Override注释掉”，即可解决该错误。

2) 在反射中使用 Annotation

在反射的 Class, Method, Field 等函数中，有许多于 Annotation 相关的接口。

这也意味着，我们可以在反射中解析并使用 Annotation。

AnnotationTest.java

import java.lang.annotation.Annotation;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Inherited;
import java.lang.reflect.Method;

/*
  Annotation在反射函数中的使用示例
 */
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
  String[] value() default "unknown";
}

/*
  Person类。它会使用MyAnnotation注解。
 */
class Person {
  
  /*
    empty()方法同时被 "@Deprecated" 和 "@MyAnnotation(value={"a","b"})"所标注
    (01) @Deprecated，意味着empty()方法，不再被建议使用
    (02) @MyAnnotation, 意味着empty() 方法对应的MyAnnotation的value值是默认值"unknown"
   */
  @MyAnnotation
  @Deprecated
  public void empty(){
    System.out.println("\nempty");
  }
  
  /*
    sombody() 被 @MyAnnotation(value={"girl","boy"}) 所标注，
    @MyAnnotation(value={"girl","boy"}), 意味着MyAnnotation的value值是{"girl","boy"}
   */
  @MyAnnotation(value={"girl","boy"})
  public void somebody(String name, int age){
    System.out.println("\nsomebody: "+name+", "+age);
  }
}

public class AnnotationTest {

  public static void main(String[] args) throws Exception {
    
    // 新建Person
    Person person = new Person();
    // 获取Person的Class实例
    Class<Person> c = Person.class;
    // 获取 somebody() 方法的Method实例
    Method mSomebody = c.getMethod("somebody", new Class[]{String.class, int.class});
    // 执行该方法
    mSomebody.invoke(person, new Object[]{"lily", 18});
    iteratorAnnotations(mSomebody);
    

    // 获取 somebody() 方法的Method实例
    Method mEmpty = c.getMethod("empty", new Class[]{});
    // 执行该方法
    mEmpty.invoke(person, new Object[]{});     
    iteratorAnnotations(mEmpty);
  }
  
  public static void iteratorAnnotations(Method method) {

    // 判断 somebody() 方法是否包含MyAnnotation注解
    if(method.isAnnotationPresent(MyAnnotation.class)){
      // 获取该方法的MyAnnotation注解实例
      MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
      // 获取 myAnnotation的值，并打印出来
      String[] values = myAnnotation.value();
      for (String str:values)
        System.out.printf(str+", ");
      System.out.println();
    }
    
    // 获取方法上的所有注解，并打印出来
    Annotation[] annotations = method.getAnnotations();
    for(Annotation annotation : annotations){
      System.out.println(annotation);
    }
  }
}

运行结果：

somebody: lily, 18
girl, boy, 
@com.skywang.annotation.MyAnnotation(value=[girl, boy])

empty
unknown, 
@com.skywang.annotation.MyAnnotation(value=[unknown])
@java.lang.Deprecated()

3) 根据 Annotation 生成帮助文档

通过给 Annotation 注解加上 @Documented 标签，能使该 Annotation 标签出现在 javadoc 中。

4) 能够帮忙查看查看代码

通过 @Override, @Deprecated 等，我们能很方便的了解程序的大致结构。

另外，我们也可以通过自定义 Annotation 来实现一些功能