Java——注解详解

Posted 2021-01-26

Java注解同 classs 和 interface 一样，注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。

注解的定义

通过 @interface 关键字进行定义。
public @interface TestAnnotation {
}

这段代码就创建了一个名字为 TestAnnotaion 的注解。

你可以简单理解为创建了一张名字为 TestAnnotation 的标签。

使用注解

@TestAnnotation
public class Test {
}

在类上加上@TestAnnotation 就可以用 TestAnnotation 注解这个类了。

内置注解

@Deprecated、@Override、@SuppressWarnings、@SafeVarargs、@FunctionalInterface

@Deprecatedbr/>这个元素是用来标记过时的元素，编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。
@Override
提示子类要复写父类中被 @Override 修饰的方法br/>@SuppressWarnings
阻止警告的意思，把警告取消。br/>@SafeVarargs
参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。br/>@FunctionalInterface
函数式接口注解，这个是 Java 1.8 版本引入的新特性，函数式编程。

函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。
有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention
当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。
它的取值如下：
RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

@Documented
它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Target
@Target 指定了注解运用的地方。当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。
ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

@Inherited
Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个类使用了被Inherited标注的注解，那么这个类的子类也继承这个注解。

@Repeatable
Repeatable是可重复的意思，注解容器。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。

@interface Persons {
Person[] value();
}

@Repeatable(Persons.class)//相当于用来保存该注解内容的容器。
@interface Person{
String role default "";
}

@Person(role="teach")br/>@Person(role="coder")
@Person(role="PM")
public class Man{
}

注解的属性

注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。
public @interface TestAnnotation {
int id();
String value();br/>}
使用注解
@TestAnnotation(id=1,value="xxxxx")
public class Test {
}
注解中属性可以有默认值，默认值需要用 default 关键值指定。
public int id() default -1;
注:
如果一个注解内只有一个属性时，使用注解时可以直接接属性值填写到括号内。
如果没有属性，使用的时候可以省略括号。

注解的提取

一个注解要在运行时被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。

注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

然后通过 getAnnotation() 方法来获取 Annotation 对象。public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

或者是 getAnnotations() 方法。public Annotation[] getAnnotations() {}

前一种方法返回指定类型的注解。
后一种方法返回应用到这个元素上的所有注解。

例子

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {

    public int id() default 2;
    public String value() default "hello";
}

@TestAnnotation
public class AnnotationTest {
    public static void main(String[] args) throws ClassNotFoundException {
        //Class c = Class.forName("com.temp.annotation.AnnotationTest");
        boolean hasAnnotation = AnnotationTest.class.isAnnotationPresent(TestAnnotation.class);
        if (hasAnnotation ) {
            TestAnnotation testAnnotation = AnnotationTest.class.getAnnotation(TestAnnotation.class);

            Annotation[] ans = AnnotationTest.class.getAnnotations();

            System.out.println(ans[0]);

            System.out.println("id:"+testAnnotation.id());
            System.out.println("value:"+testAnnotation.value());
        }
    } 
}

运行结果：
@com.temp.annotation.TestAnnotation(value=hello, id=2)
id:2
value:hello