Java 注解（Annotation）

原创

mob604756e85b28 2021-03-13 11:27:42 ©著作权

文章标签 java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob604756e85b28的原创作品，请联系作者获取转载授权，否则将追究法律责任

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

内置的注解

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 开始支持，标识某注解可以在同一个声明上使用多次。

Java 注解（Annotation）_java

从中，我们可以看出：

(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 的实现类进行举例说明。

Java 注解（Annotation）_java_02

注解的作用

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

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

1）编译检查

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

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

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

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

Java 注解（Annotation）_java_03

OverrideTest.javapublic 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.javaimport 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, 18girl, boy, @com.skywang.annotation.MyAnnotation(value=[girl, boy])
emptyunknown, @com.skywang.annotation.MyAnnotation(value=[unknown])@java.lang.Deprecated()