美文网首页
java进阶之注解

java进阶之注解

作者: MonkeyLqj | 来源:发表于2020-05-07 01:48 被阅读0次

Java注解(Annotation)又称Java标注,是JDK5中引入的一种注释机制。Annotation其实是代码中的特殊标记,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。通过使用注解,开发人员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充信息。

1.注解的声明

与声明一个"Class"不同的是,注解的声明使用 @interface 关键字。一个注解的声明如下:

public @interface AnnotationTest {}

2.元注解

在定义注解时,注解类也能够使用其他的注解声明。对注解类型进行注解的注解类,我们称之为 meta annotation(元注解)。一般情况下,我们在定义自定义注解时,需要指定的元注解主要有两个:@Retention、@Target,对于@Documented和@Inherited用的相对较少,下面我们看下这些元注解。

2.1 注解@Retention

@Retention只能用于修饰Annotation定义,用于指定被修饰的Annotation可以保留多长时间。

Annotation的保留有三种方式:

package java.lang.annotation;

public enum RetentionPolicy {
    SOURCE,
    CLASS,
    RUNTIME;

    private RetentionPolicy() {
    }
}
  • RetentionPolicy.SOURCE: 标记的注解仅保留到源码级别中,并被编译器忽略。
  • RetentionPolicy.CLASS: 标记的注解在编译时由编译器保留,但 Java 虚拟机(JVM)会忽略。
  • RetentionPolicy.RUNTIME: 标记的注解由 JVM 保留,因此运行时环境可以使用它。

@Retention 三个值中 SOURCE < CLASS < RUNTIME,即CLASS包含了SOURCE,RUNTIME包含SOURCE、
CLASS。

示例:

@Retention(RetentionPolicy.RUNTIME)  //注解保留在运行时
public @interface AnnotationTest {
}

2.2 注解@Target

@Target注解标记另一个注解,以限制可以应用注解的Java元素类型。目标注解指定以下元素类型之一作为其值:

package java.lang.annotation;

public enum ElementType {
    TYPE,
    FIELD,
    METHOD,
    PARAMETER,
    CONSTRUCTOR,
    LOCAL_VARIABLE,
    ANNOTATION_TYPE,
    PACKAGE,
    TYPE_PARAMETER,
    TYPE_USE;

    private ElementType() {
    }
}
  • ElementType.TYPE: 可以应用于类的任何元素。
  • ElementType.FIELD: 可以应用于字段或属性。
  • ElementType.METHOD: 可以应用于方法级注解。
  • ElementType.PARAMETER: 可以应用于方法的参数。
  • ElementType.CONSTRUCTOR: 可以应用于构造函数。
  • ElementType.LOCAL_VARIABLE: 可以应用于局部变量。
  • ElementType.ANNOTATION_TYPE: 可以应用于注解类型。
  • ElementType.PACKAGE: 可以应用于包声明。
  • ElementType.TYPE_PARAMETER:可以用于类型参数声明(1.8新加入)
  • ElementType.TYPE_USE:可以用于类型使用声明(1.8新加入)

示例:

@Retention(RetentionPolicy.RUNTIME) //注解保留在运行时
@Target(ElementType.METHOD) //只可以用于方法级注解
public @interface AnnotationTest {
}

2.3 注解@Documented

@Documented注解用于被javadoc工具提取成文档

@Documented
public @interface AnnotationTest {
}

2.4 注解@Inherited

@Inherited表示允许子类继承父类中定义的注解。

示例:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited   // 1
public @interface Inheritable {
}

我们对Inheritable注解添加元注解@Inherited,则Inheritable注解具有继承性。

@Inheritable
public class Base {
}

我们Base类使用了@Inheritable注解,其子类也将使用@Inheritable注解

public class ChildAnnotation extends Base {
    public static void main(String[] args) {
        System.out.println(ChildAnnotation.class.isAnnotationPresent(Inheritable.class));
    }
}

我们的ChildAnnotation类继承自Base类,然后运行结果为true。
如果我们将上面 “1”注释掉,那么@Inheritable将不具有继承性,其运行结果为false。

3.注解元素类型

通过上述对@AnnotationTest注解的定义,我们了解了注解定义的过程,由于@AnnotationTest内部没有定义其他元素,所以@AnnotationTest也称为标记注解,但在自定义注解中,一般都会包含一些元素以表示某些值,方便处理器使用,这点在下面的例子将会看到:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface AnnotationTest {
    String value() default "";
}

我们声明了一个String类型的value元素,默认是空字符串,须注意到对应任何元素的声明应采用方法的声明方式,同时可选择使用default提供默认值。

@AnnotationTest(value = "123")
public class Test {
}

而对于上面没有使用default默认值,我们在使用的时候就必须去指定@AnnotationTest(value = "123")否则编译器会报错, 使用了default默认值就可以直接使用@AnnotationTest可以去管value

注解支持的元素数据类型除了上述的String,还支持如下数据类型:

  • 所有基本类型(int,float,boolean,byte,double,char,long,short)
  • String
  • Class
  • enum
  • Annotation
  • 上述类型的数组

倘若使用了其他数据类型,编译器将会丢出一个编译错误,注意,声明注解元素时可以使用基本类型但不允许使用任何包装类型,同时还应该注意到注解也可以作为元素的类型,也就是嵌套注解。

4.注意

编译器对默认值的限制

编译器对元素的默认值有严格的要求。元素要么具有默认值,要么在使用注解时提供元素的值。其次,对于非基本类型的元素,无论是在源代码中声明,还是在注解接口中定义默认值,都不能以null作为值,这就是限制,但造成一个元素的存在或缺失状态,因为每个注解的声明中,所有的元素都存在,并且都具有相应的值,为了绕开这个限制,只能定义一些特殊的值,例如空字符串或负数,表示某个元素不存在。

注解不支持继承

注解是不支持继承的,因此不能使用关键字extends来继承某个@interface,但注解在编译后,编译器会自动继承java.lang.annotation.Annotation接口,即使Java的接口可以实现多继承,但定义注解时依然无法使用extends关键字继承@interface

相关文章

  • Java之RPC和REST的区别

    Java进阶之RPC和REST的区别 目录 简单介绍 什么是REST?Java中常用的REST注解 什么是RPC?...

  • Java进阶之注解

    Java的注解应用广泛,且使代码结构看起来整洁明了,著名的JUnit和TestNG测试框架中就大量应用了注解。 一...

  • java进阶之注解

    Java注解(Annotation)又称Java标注,是JDK5中引入的一种注释机制。Annotation其实是代...

  • 注解

    Android进阶之Annotation(注解)的使用

  • java5.0注解知识快速进阶

    java5.0注解知识快速进阶 1.了解注解 对于java开发人员来说,在编写代码时,除源程序外,还会使用Java...

  • Android进阶之自定义注解

    Android进阶之自定义注解 本篇文章内容包括: 注解的概念 元注解 自定义注解 Android自定义编译时注解...

  • Java——注解(Annotation)入门学习

    学习资料: Java编程思想 ——第20章 公共技术点之 Java 注解 Annotation 注解(Annota...

  • Spring注解原理探索(三)

    之 Java如何识别注解 关键词:Java 反射java.lang.reflect 包,实现反射功能的工具类。注解...

  • Spring注解原理探索(一)

    之 Java元注解释义 Question 注解在Java中如何起作用? Spring是如何识别注解? 如何自定义注...

  • Java高级进阶-注解

    什么是注解 注解是用来对Java代码进行注释和解释的一种标识,这种标识同时可以被用来传递参数和信息,它的本质是元数...

网友评论

      本文标题:java进阶之注解

      本文链接:https://www.haomeiwen.com/subject/tsbnghtx.html