一、概述
Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。
Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。
使用注解可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
二、内置注解
Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。
-
作用在代码的注解是:
@Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
@Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
@SuppressWarnings - 指示编译器去忽略注解中声明的警告。 -
作用在其他注解的注解(或者说 元注解)是
①@Retention - 用于指定被修饰的Annotation可以保留多长时间,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
- RetentionPolicy.CLASS:编译器将把注解信息放在class文件中,当运行java程序时,jvm不可获取Annotation信息。这是默认值。
- RetentionPolicy.RUNTIME:编译器将把Annotation记录在class文件中。当运行java程序时,jvm可以获取注解信息,程序可以通过反射获取注解信息。
- RetentionPolicy.SOURCE:注解只保留在源码中,编译器将直接舍弃这种Annotation
@Retention包含一个RetentionPolicy类型的value变量,因此使用该注解时必须为该变量指定值。
使用
@Retention(value=RetentionPolicy.RUNTIME)
public @interface Testable{}
//或者省略value,仅value变量名可以省略
@Retention(RetentionPolicy.RUNTIME)
public @interface Testable{}
②@Documented - 标记这些注解是否包含在用户文档中。
③@Target - 用于指定注解可以修饰哪些程序单元。@Target包含一个ElementType类型的value变量,使用该注解时也需要给该变量指定值。
ElementType.ANNOTATION_TYPE:只能修饰注解
ElementType.CONSTRUCTOR:只能修饰构造器
ElementType.FIELD:只能修饰成员变量
ElementType.LOCAL_VARIABLE:只能修饰局部变量
ElementType.METHOD:只能修饰方法
ElementType.PACKAGE:只能修饰包定义
ElementType.PARAMETER:只能修饰参数
ElementType.TYPE:可以修饰类、接口(包括注解类型)、或枚举定义
使用:
@Retention(ElementType.FIELD)
public @interface Testable{}
④@Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
- 从 Java 7 开始,额外添加了 3 个注解:
①@SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
②@FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
③@Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
网友评论