JavaSE---10注解

04 注解

4.1 注解的理解

• Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
• Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在Annotation 的“name=value” 对中。
• 一定程度上可以说：框架= 注解+ 反射+ 设计模式。

4.2 注解使用示例

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

@SuppressWarnings("unused")
int num = 10;
//System.out.println(num);
@SuppressWarnings({ "unused", "rawtypes" })
ArrayList list = new ArrayList();

4.3 自定义注解

如何自定义注解：参照@SuppressWarnings定义

① 注解声明为：@interface

② 内部定义成员，通常使用value表示

③ 可以指定成员的默认值，使用default定义

④ 如果自定义注解没有成员，表明是一个标识作用。

如果注解有成员，在使用注解时，需要指明成员的值。

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

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

public @interface MyAnnotation {

    String value();
   //String value() default "hello";//默认值

}

4.4 jdk中4个基本的元注解的使用

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

  • ==Retention==:指定所修饰的 Annotation 的**生命周期**：**SOURCE、CLASS**（默认行为）、**RUNTIME**只有声明为RUNTIME生命周期的注解，才能通过反射获取。
    

  • Target:用于指定被修饰的 Annotation 能用于修饰哪些程序元素

    

  • ==Documented==:表示所修饰的注解在被javadoc解析时，保留下来。（不常用）
    

  • ==Inherited==:被它修饰的 Annotation 将具有继承性。（不常用）
    

@Retention(RetentionPolicy.SOURCE)//在注解上面的注解
public @interface MyAnnotation {
    String value();
}

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
    String value() default "book";
}

4.5 jdk8新特性

4.5.1 可重复注解

① 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class

② MyAnnotation的Target和Retention等元注解与MyAnnotations相同。

其中MyAnnotation是自己定义的注解

@Retention(RetentionPolicy.RUNTIME)//为了和MyAnnotation保持一致
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {

    MyAnnotation[] value();
}

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

4.5.2 类型注解

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

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, 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;
    }
}

---