java注解学习

一、注解是什么

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

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

注解可以看做给编译器看的注释

二、内置的注解

作用在代码的注解是

• @Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
• @Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
• @SuppressWarnings - 指示编译器去忽略注解中声明的警告。

作用在其他注解的注解(或者说 元注解)是

• @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
• @Documented - 标记这些注解是否包含在用户文档中。
• @Target - 标记这个注解应该是哪种 Java 成员。
• @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

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

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

三、Annotation

1. Annotation 组成部分

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

• Annotation.java
• ElementType.java
• RetentionPolicy.java

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

package java.lang.annotation;

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

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

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

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

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

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

    PACKAGE             /* 包声明  */
}

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

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

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

2. Annotation 通用定义

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

(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。
--------------------------------------------------以上部分学习自菜鸟教程----------------------------

四、自定义注解

在定义一个注解之前，需要考虑以下几个要素

1. 指定注解针对的地方

@Target() 元注解常用参数有以下几种情况

  1. ElementType.TYPE 针对类、接口
  2. ElementType.FIELD 针对成员变量
  3. ElementType.METHOD 针对成员方法
  4. ElementType.PARAMETER 针对方法参数
  5. ElementType.CONSTRUCTOR 针对构造器
  6. ElementType.PACKAGE 针对包
  7. ElementType.ANNOTATION_TYPE 针对注解

2. 指定注解的保留域

@Retention()常用参数有以下几种情况

  1. RetentionPolicy.SOURCE 源代码级别，编译器处理之后不再保留
  2. RetentionPolicy.CLASS 注解信息保留到类对应的class文件中
  3. RetentionPolicy.RUNTIME 运行时使用，由jvm读取

自定义一个注解

package com.zhaojun.test;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface InitMethod {//注解只起标注作用 }

定义一个类，使用注解

package com.zhaojun.test;
public class InitDemo {    
    @InitMethod    
    public void init(){        System.out.println("init...");    }
    
    public void other(){        System.out.println("other...");    }
}

测试注解

package com.zhaojun.test;

import java.lang.reflect.Method;

public class Test {
    public static void main(String[] args) throws Exception {
        //通过反射机制调用类中拥有@InitMethod注解的方法，即解析注解
        Class<?> clzz = Class.forName("com.zhaojun.test.InitDemo");
        Method[] methods = clzz.getMethods();
        if (methods.length>0){
            for (Method method : methods) {
                boolean annotationPresent = method.isAnnotationPresent(InitMethod.class);
                if(annotationPresent) //判断是否有InitMethod注解
                   method.invoke(clzz.newInstance());//调用方法
            }
        }
    }
}