Java 注解

Java 注解用于为 Java 代码提供元数据。作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。

注解其实同class 和Interface 一样，注解也属于一种类型，它是在JavaSE5.0版本中开始引入的概念。注解就相当于标签

注解的定义

注解通过@interface 关键字进行定义

1
2
public @interface TestAnnotation{
}

注解的形式和接口很像，只不过前面多了一个@符号，上面的代码就创建了一个名字叫TestAnnotation 的注解。可以简单理解为创建了一张名字为TestAnnotation的标签。

注解的应用

1
2
3
4
@TestAnnotation
public class Test
{    
}// 可以简单理解为将@TestAnnotation 这张标签贴到Test 这个类上面。

元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。

元注解也是一张标签，但是它是一张特殊的标签，它的作用和目的就是给其他普通的标签进行解释说明的。

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

  • @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注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

1
2
3
4
5
6
7
8
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}


@Test
public class A {}
public class B extends A {}

注解 Test 被 @Inherited 修饰，之后类 A 被 Test 注解，类 B 继承 A,类 B 也拥有 Test 这个注解。

  • @Repeatable

可重复，就是可以添加多个一样的注解，但是属性可以不一样。

注解的属性

注解的属性也叫做成员变量，注解只有成员变量，没有方法，注解的成员变量在注解中的定义中以“无参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

1
2
3
4
5
6
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id();
    String msg();
}

上面代码定义了TestAnnotation 这个注解拥有id 和msg 两个属性，在使用的时候，应该给他们赋值，赋值的方式是在注解的括号内以value=””形式，多个属性之前用，隔开。

1
2
3
@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}

注解中的属性可以有默认值，默认值需要用default 关键字指定

1
2
3
4
5
6
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    public int id() default -1;
    public String msg() default "Hi";
}

TestAnnotation 中 id 属性默认值为 -1，msg 属性默认值为 Hi。

注解的提取

当写好注解后，现在的工作是检查这些注解，提取上面的信息。

要想正确的检阅注解，需要使用反射。

注解通过反射获取，首先可以通过Class 对象的isAnnotationPresent()方法判断它是否应用了某个注解

1
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

然后通过getAnnotation()方法来获取Annotation 对象。(返回指定类型的注解)

1
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

或者是getAnnotations()方法（返回注解到这个元素上的所有注解）

1
public Annotation[] getAnnotations() {}

如果获取到的Annotation 如果不为空，就可以调用他们的属性方法了。比如

1
2
3
4
5
6
7
8
9
10
11
12
@TestAnnotation()
public class Test {
    public static void main(String[] args) {
        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);

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