注解

从JDK1.5 开始，java增加了对元数据（MetaData）的支持，也就是Annotation（注解）
Annotation其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过使用Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
Annotation可以像修饰符一样被使用，可用于修饰包，类，构造器，方法，成员变量参数，局部变量的声明。这些信息被保存在Annotation的"name=value"对中。
概述：
- 在javaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在javaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替javaEE旧版中所遗留的繁冗代码和XML配置等。
- 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架=注解+反射+设计模式
常见Annotation实例
- 使用Annotation时要在其前面增加@符号，并把该Annotation当成一个修饰符使用。用于修饰它支持的程序元素。
  - 示例一：生成文档相关的注解
    - @author 标明开发该类模块的作者，多个作者之前使用,分割
    - @version 标明改类模块的版本
    - @see 参考专项，也就是相关主题
    - @since 从哪个版本开始增加的
    - @param 对方法中某参数的说明，如果没有参数就不能写
    - @return 对方法返回值的说明，如果方法的返回值类型是void就不能写
    - @exception 对方法可能抛出的异常进行说明，如果方法没有用throws显示抛出的异常就不能写
  - 实例二：在编译时进行格式化检查JDK内置的三个基本注解
    - @Override：限定重新父类方法，该注释只能用于方法。
    - @Deprecated：用于表示所修饰的元素（类、方法等）已过时。通常是因为所修饰的结构危险或存在更好的选择。
    - @SuppressWarnings：抑制编译器警告。
  - 实例三：跟踪代码依赖性，实现替代配置文件功能
    - Servlet3.0提供了注解，使得不再需要在web.xml文件中进行Servlet的部署。
    - spring框架中关于“事务”的管理
如何自定义注解参照：@SuppressWarnings
- 注解声明为@interface
- 自定义注解自动继承了java.lang.annotation.Annotation接口
- Annotation的成员变量在Annotation定义中以无参方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们成为配置参数。类型只能是八种基本数据类型、String类型、Class类型、Annotation类型以上所有类型的数组。
- 可以在定义Annotation的成员变量时为其指定初始值，指定成员变量的初始值可以使用default关键字。
- 如果只有一个参数成员，建议使用参数名为value。
- 如果定义的注解含有配置参数，那么使用时丙戌指定参数值，除非它有默认值。格式是参数名 = 参数值，如果只有一个参数成员，且名称为value，可以省略value=。
- 没有成员定义的Annotation成为标记；包含成员变量的Annotation称为元数据Annotation。
注意：自定义注解必须配上注解的信息处理流程才有意义
```
  //自定义注解
  public @interface myAnnotation{
      String value();//属性

      String msg() default "测试默认值"; //默认值设置
  }

  //使用
  @myAnnotation(value="hello")
  class Person{
      private String name;
      private String age;

      public Persion(){

      }

      public Persion(String name,String age){
          this.name = name;
          this.age = age;
      }
  }
```

JDK 提供的4种元注解

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

JDK1.5 提供了4个标准的meta-annotation类型，分别为

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

@Target：用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些程序元素。@Target也包含一个名为value的成员变量

取值`ElementType`		取值`ElementType`
CONSTRUCTOR	用于描述构造器	PACKAGE	用于描述包
FIFLD	用于描述域	PARAMETER	用于描述参数
LOCAL_VARIABLE	用于描述局部变量	TYPE	用于描述类、接口（包括注解类型）或enum声明
METHOD	用于描述方法

@Documented：用于指定被该元Annotation修饰的Annotation类将被javadoc工具提取成文档。默认情况下，javadoc是不包括注解的。
@Inherited：被它修饰的Annotation将具有继承性。如果某个类使用了被@Inherited修饰的Annotation，则其子类将自动具有该注解。
- 比如：如果把标有@Inherited注解的自定义注解标注在类级别上，子类则可以继承父类类级别的注解
- 实际应用中，使用较少。

元数据的理解：
String name = "atguigu";

通过反射获取注解信息

  //自定义注解
  public @interface myAnnotation{
      String value();//属性

      String msg() default "测试默认值"; //默认值设置
  }

  //使用
  @myAnnotation(value="hello")
  class Person{
      private String name;
      private String age;

      public Persion(){

      }

      public Persion(String name,String age){
          this.name = name;
          this.age = age;
      }
  }

  //通过反射获取注解信息
  @Test
  public void testGetAnnotation(){
      Class clazz = Person.class;
      Annotation[] annotations = clazz.getAnnotations();
      for(int i = 0;i < annotations.length;i++){
          System.out.println(annotations[i]);
      }
  }

JDK1.8中注解的新特性

可重复性

JDK1.8之前写法

//自定义注解
public @interface MyAnnotation{
    String value();//属性

    String msg() default "测试默认值"; //默认值设置
}

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

//使用
@MyAnnotations({@MyAnnotation(value="hi"),@MyAnnotation(value="hi")})
class Person{
    private String name;
    private String age;

    public Persion(){

    }

    public Persion(String name,String age){
        this.name = name;
        this.age = age;
    }
}

JDK1.8之后写法

可重复注解、类型注解

//自定义注解
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE)
@Repeatable(MyAnnotations.class) //1.8 之后使用 注解生命周期需要一致@Retention @Target @Inherited
public @interface MyAnnotation{
    String value();//属性

    String msg() default "测试默认值"; //默认值设置
}

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE)
public @interface MyAnnotations{
    MyAnnotation[] value();
}

//使用
@MyAnnotation(value="hi")
@MyAnnotation(value="hello")
class Person{
    private String name;
    private String age;

    public Persion(){

    }

    public Persion(String name,String age){
        this.name = name;
        this.age = age;
    }
}

类型注解
- JDK1.8之后，关于原注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER,TYPE_USE
- JDK1.8之前，注解只能是在声明的地方所使用，1.8开始，注解可以应用在任何地方
  - ElementType.TYPE_PARAMETER 表示该注解能卸载类型变量的声明语句中（如：泛型声明）
```
@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine{
}

public calss TestTypeDefine<@TypeDefine() U>{
    private U u;
    public <@TypeDefine() T> void test(T t){
    }
}
```
  - ElementType.TYPE_USE 表示该注解能卸载使用类型的任何语句中

posted @ 2019-05-21 14:37 猫珥阅读(129) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

猫珥

maoerlj

注解

公告