Java中的注解

Java注解(Annotation)是一种表示元数据的标签，即附加在类、接口、方法或字段上，以指示Java编译器和JVM可以使用的一些附加信息。

Java中的注解用于提供附加信息，因此它是XML的另一种选择。

Java 内置注解

@Override

@Override注释确保子类方法覆盖了父类方法。如果不是这样，就会发生编译时错误。

@SuppressWarnings

@SuppressWarnings注释:用于抑制编译器发出的警告

@FunctionalInterface

java8支持，标识一个匿名函数或函数式接口

元注解

所谓元注解就是标记其他注解的注解，用于开发自定义注解

@Target

标识这个注解的作用范围

ElementType 声明了许多常量来指定注解可以作用的元素类型，比如类型、方法、字段等

Element Types	注解可以作用的范围
TYPE	class, interface or enumeration
FIELD	fields
METHOD	methods
CONSTRUCTOR	constructors
LOCAL_VARIABLE	local variables
ANNOTATION_TYPE	annotation type
PARAMETER	parameter

@Target({ElementType.FIELD, ElementType.METHOD})    //表示该注解可以作用在字段或方法上
public @interface MyAnnotation {
}

class Test {
    @MyAnnotation
    private String desc;

    @MyAnnotation
    public String getDesc() {
        return desc;
    }
}

@Retention

指定注解信息保留阶段，有如下三种枚举选择。只能选其一

保留策略	描述
RetentionPolicy.SOURCE	注解在编译过程中丢弃。生成的class不包含注解信息
RetentionPolicy.CLASS	注解在class文件中可用，但会被JVM丢弃;当注解未定义Retention值时，默认值是CLASS
RetentionPolicy.RUNTIME	注解信息在运行期(JVM)保留（.class也有），可通过反射机制读取注解的信息

@Repeatable

JDK1.8新加入的，表明自定义的注解可以在同一个位置重复使用。在没有该注解前，是无法在同一个类型上使用相同的注解多次

@Inherited

默认情况下，注释不会继承给子类。@Inherited表示当前注解会被注解类的子类继承

@Documented

作用是告诉JavaDoc工具，当前注解本身也要显示在Java Doc中(不常用)

自定义注解

语法

@interface MyAnnotation{
    int value();
}  

tips;

1. 方法不应包含任何throws子句

2. 方法应返回以下之一：原始数据类型，字符串，类，枚举或这些数据类型的数组。

3. 方法不应具有任何参数。

4. 我们应该在interface关键字之前附加@来定义注解。

5. 它可以为该方法分配默认值。

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    int id() default 1001;
    String value() default "good";
}

class Test {
    @MyAnnotation(value = "not bad")
    private String desc;
}

使用反射机制获取注解信息

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    int id() default 1001;
    String value() default "good";
}

class Test {
    @MyAnnotation(value = "not bad")
    private String desc;
}

class AnnotationHandle {
    public static void main(String[] args) throws NoSuchFieldException {
        Class<Test> testClass = Test.class;
        Field desc = testClass.getDeclaredField("desc");
        MyAnnotation annotation = desc.getAnnotation(MyAnnotation.class);
        System.out.println(annotation.id());
        System.out.println(annotation.value());
    }
}

output:

1001
not bad