Java基础之注解

Java注解

1. 注解的使用示例

使用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框架中关于“事务”的管理

2. 自定义注解

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

• 自定义注解自动继承了**java.lang.annotation.Annotation**接口

• Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。

  其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。

• 可以在定义Annotation的成员变量时为其指定初始值,指定成员变量的初始值可使用**default**关键字

• 如果只有一个参数成员，建议使用参数名为value

• 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名=参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”

• override没有成员定义的Annotation称为标记; 包含成员变量的Annotation称为元数据Annotation

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

// 自定义注解
public @interface MyAnnotation() {
    String value() default "hello";
} 

// 使用  
@MyAnnotation(value = "nihao")

3. JDK中四个基本元注解的使用

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

• JDK5.0提供了4个标准的meta-annotation类型

  Retention、Target为常用的两个元注解

  • Retention

    • 只能用于修饰一个Annotation定义, 用于指定该Annotation 的生命周期, @Rentention包含一个RetentionPolicy类型的成员变量, 使用@Rentention时必须为该value 成员变量指定值:
    • RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
    • RetentionPolicy.CLASS:在class文件中有效（即class保留），当运行Java 程序时, JVM不会保留注解。这是默认值
    • RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行Java 程序时, JVM会保留注释。程序可以通过反射获取该注释。

    // 自定义注解
    @Rentention(RetentionPolicy.RUNTIEM)
    public @interface MyAnnotation() {
        String value() default "hello";
    } 
    

  • Target

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

    • @Target也包含一个名为value的成员变量。

    • 

      // 自定义注解
      @Target({TYPE, FILED, METHOD, PARAMETER, CONSTRUCTOR, LOCAL)VARIABLE})
      @Rentention(RetentionPolicy.RUNTIEM)
      public @interface MyAnnotation() {
          String value() default "hello";
      } 
      

  以下两个注解出现频率较低

  • Documented
    • 用于指定被该元Annotation修饰的Annotation类将被javadoc工具提取成文档。默认情况下，javadoc是不包括注解的。
  • Inherited
    • 被它修饰的Annotation将具有继承性。如果某个类使用了被@Inherited修饰的Annotation, 则其子类将自动具有该注解。

4. JDK8注解新特性

4.1 可重复注解

1. 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
2. MyAnnotation的Target和Retention等元注解与MyAnnotations相同。

@Repeatable(MyAnnotations.class)
@Target({TYPE, FILED})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value();
}

@Target({TYPE, FILED})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {
    MyAnnotation[] value();
}

// 具体应用
@MyAnnotation("hello")
@MyAnnotation("hi")
public class Person {
    
}

4.2 类型注解

• JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER,TYPE_USE。
• 在Java8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。
  • ElementType.TYPE_PARAMETER表示该注解能写在类型变量的声明语句中（如：泛型声明）。
  • ElementType.TYPE_USE表示该注解能写在使用类型的任何语句中。

@Target({TYPE, FILED, TYPE_PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "1";
}

public class Generic<@MyAnnotation T> {
    
}

@Target({TYPE, FILED, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "1";
}

public class Generic {
    int num = (@MyAnnotation int)10L;
}