Java注解

来源:https://blog.csdn.net/qq1404510094/article/details/80577555

1、概念

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

2、用法

2.1 、注解的定义

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

package com.zjf.annotation;

public @interface TestAnnotation {

}

它的形式跟接口很类似,不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 TestAnnotaion 的注解,可以简单理解为创建了一张名字为 TestAnnotation 的标签。

2.2 、注解的应用

package com.zjf.annotation;

@TestAnnotation
public class Test {

}

创建一个类 Test,然后在类定义的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解这个类了,可以简单理解为将 TestAnnotation 这张标签贴到 Test 这个类上面。

不过,要想注解能够正常工作,还需要介绍一下一个新的概念那就是元注解。

3、元注解

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

3.1、@Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。它的取值如下:

取值 说明
RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。
package com.zjf.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

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

}

上面的代码中,我们指定 TestAnnotation 可以在程序运行周期被获取到,因此它的生命周期非常的长。

3.2、@Documented

顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

3.3、@Target

Target 是目标的意思,@Target 指定了注解运用的地方。可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值:

取值 说明
ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

3.4、@Inherited

Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。举个栗子:

package com.zjf.annotation;

import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

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

}

注解TestAnnotation被@Inherited修饰;

package com.zjf.annotation;

@TestAnnotation
public class Test {

}

类Test被 TestAnnotation注解;

package com.zjf.annotation;

public class ChildTest extends Test{

}

类ChildTest 继承了Test,那么类ChildTest 也拥有TestAnnotation这个注解。

3.5、@Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。什么样的注解会多次应用呢?通常是注解的值可以同时取多个。举个栗子,一个人他既是程序员又是产品经理,同时他还是个画家。

package com.zjf.annotation;

import java.lang.annotation.Repeatable;

@Repeatable(Persons.class)
public @interface Person {
    String role() default "";
}

@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类Persons 相当于一个容器注解。什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。我们再看看代码中的相关容器注解。

package com.zjf.annotation;

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

按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。

package com.zjf.annotation;

@Person(role = "PM")
@Person(role = "CODER")
@Person(role = "ARTIST")
public class SuperMan {

}

上面的代码可以这样理解。Persons 是一张总的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。

4、注解的属性

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id();
    String name();
}

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 name 两个属性。在使用的时候,我们应该给它们进行赋值。

赋值的方式是在注解的括号内以 value=”” 形式,多个属性之前用 ,隔开,如下:

@TestAnnotation(id = 1,name = "zjf")
public class Test {

}

需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。

注解中属性可以有默认值,默认值需要用 default 关键值指定。比如:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id() default -1;
    String name() default "";
}

TestAnnotation 中 id 属性默认值为 -1,name属性默认值为 ""。它可以这样应用:

@TestAnnotation()
public class Test {

}

因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略。

另外,还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内:

public @interface Check {
    int value();
}

上面代码中,Check 这个注解只有 value 这个属性。所以可以这样应用:

@TestAnnotation()
public class Test {
    @Check(1)
    int a;
}

这和下面的效果是一样的:

@TestAnnotation()
public class Test {
    @Check(value = 1)
    int a;
}

最后,还需要注意的一种情况是一个注解没有任何属性。比如:

public @interface Perform {

}

那么在应用这个注解的时候,括号都可以省略:

@TestAnnotation()
public class Test {
    @Check(value = 1)
    int a;
    
    @Perform
    void perform() {}
}

5、Java 预置注解

学习了上面相关的知识,我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。

5.1、@Deprecated

这个元素是用来标记过时的元素,想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

5.2、@Override

提示子类要复写父类中被 @Override 修饰的方法。

5.3、@SuppressWarnings

阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。

5.4、@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

5.5、FunctionalInterface

函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。

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

@FunctionalInterface
public interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see     java.lang.Thread#run()
     */
    public abstract void run();
}

我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口,上面源码可以看到它就被 @FunctionalInterface 注解。

函数式接口标记有什么用,这个原因是函数式接口可以很容易转换为 Lambda 表达式。

6、注解的提取

用标签来比作注解,前面的内容是讲怎么写注解,然后贴到哪个地方去,而现在我们要做的工作就是检阅这些标签内容。 形象的比喻就是你把这些注解标签在合适的时候撕下来,然后检阅上面的内容信息。要想正确检阅注解,离不开一个手段,那就是反射,注解通过反射获取。

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

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

然后通过 getAnnotation() 方法来获取 Annotation 对象:

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

或者是 getAnnotations() 方法:

public Annotation[] getAnnotations() {}

前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解。
如果获取到的 Annotation 如果不为 null,则就可以调用它们的属性方法了。比如

public class AnnotationDemo {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        try {
            Class<?> testClass = Class.forName("com.zjf.annotation.Test");
            boolean hasAnnotation = testClass.isAnnotationPresent(TestAnnotation.class);
            if (hasAnnotation) {
                TestAnnotation testAnnotation = testClass.getAnnotation(TestAnnotation.class);
                System.out.println("testAnnotation id == " + testAnnotation.id());
                System.out.println("testAnnotation name == " + testAnnotation.name());
            }
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}

程序的运行结果是:

testAnnotation id == -1
testAnnotation name ==

这个正是 TestAnnotation 中 id 和 name的默认值。

上面的例子中,只是检阅出了注解在类上的注解,其实属性、方法上的注解照样是可以的。同样还是要假手于反射(需要注意的是,如果一个注解要在运行时被成功提取,那么@Retention(RetentionPolicy.RUNTIME) 是必须的):

@TestAnnotation(id = 1,name = "zjf")
public class Test {
    @Check(value = 10)
    int a;
    
    @Perform
    void perform() {}
}

下面是提取注解内容的代码:

public class AnnotationDemo {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        try {
            Class<?> testClass = Class.forName("com.zjf.annotation.Test");
            boolean hasAnnotation = testClass.isAnnotationPresent(TestAnnotation.class);
            if (hasAnnotation) {
                TestAnnotation testAnnotation = testClass.getAnnotation(TestAnnotation.class);
                System.out.println("testAnnotation id == " + testAnnotation.id());
                System.out.println("testAnnotation name == " + testAnnotation.name());      
            }
            
            Field aField = testClass.getDeclaredField("a");
            aField.setAccessible(true);
            //获取一个成员变量上的注解
            Check check = aField.getDeclaredAnnotation(Check.class);
            if (null != check) {
                System.out.println("check value == " + check.value());
            } else {
                System.out.println("check == null");
            }
            
            Method perforMethod = testClass.getDeclaredMethod("perform");
            if (null != perforMethod) {
                Annotation[] annotations = perforMethod.getAnnotations();
                for (int i = 0; i < annotations.length; i++) {
                    System.out.println("annotations[" + i + "] == " + annotations[i].annotationType().getSimpleName());
                }
            } else {
                System.out.println("null == perforMethod");
            }
            
            Class<?> superManClass = Class.forName("com.zjf.annotation.SuperMan");
            Persons persons = superManClass.getAnnotation(Persons.class);
            for (int i = 0; i < persons.value().length; i++) {
                System.out.println("persons.value()[" + i + "] == " + persons.value()[i]);
            }
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
    
}

输出结果为:

testAnnotation id == 1
testAnnotation name == zjf
check value == 10
annotations[0] == Perform
persons.value()[0] == @com.zjf.annotation.Person(role=PM)
persons.value()[1] == @com.zjf.annotation.Person(role=CODER)
persons.value()[2] == @com.zjf.annotation.Person(role=ARTIST)

7、注解的使用场景

对啊注解到底有什么用?根据官方文档的描述:注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

注解有许多用处,主要如下:

  • 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息
  • 编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
  • 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取
    值得注意的是,注解不是代码本身的一部分。

当开发者使用了Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT,Annotation-Processing-tool的简写,称为注解处理器。

8、总结

  • 如果注解难于理解,你就把它类同于标签,标签为了解释事物,注解为了解释代码。
  • 注解的基本语法,创建如同接口,但是多了个 @ 符号。
  • 注解的元注解。
  • 注解的属性。
  • 注解主要给编译器及工具类型的软件用的。
  • 注解的提取需要借助于 Java 的反射技术,反射比较慢,所以注解使用时也需要谨慎计较时间成本。