注解的基本概念
注解的英文就是 Annotation，是 JDK1.5 版本之后开始有的功能。注解就是给 java 代码加上一个标识规则，javac编译器在编译时就会去检测应用了该注解类的类是否符合标识规则，来约束程序员编码规范。
JDK 中常用的注解
先来了解一下，我们开发中最最常用几个注解：
- @Override 约束方法必须从父类中覆写
下面是我们经常手写代码时会犯的错误：
复写Object 中的equals(Object obj)时很容将参数类型定义为当前类的类型，如果没有添加@Override的话那系统会认为这个方法并不是继承至Object的equals方法，那么使用两个对象进行比较就会出现问题。
-
@Deprecated 约束元素已经过期，不建议使用
-
@SuppressWarning 压制警告提示
元注解
注解中的注解，只能用于修饰注解。
@Retention 约束注解的保留时期
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
RetentionPolicy value();
}
RetentionPolicy 它是枚举类，分为以下三种类型：
- RetentionPolicy.SOURCE
1.当注解保留时期为 SOURCE 时：表示注解信息只会被保留到源码和编译期间，当javac编译器编译源代码后会将该注解去除，但是在编译期间，注解处理器是是可以处理这些注解的，在编译完成之后，这些注解信息就没有了
- RetentionPolicy.CLASS
2.当注解保留时期为 CLASS 时：表示注解信息会被保留到编译时期,该注解信息会被编译到.class文件中，但不会被虚拟机加载到内存中，保留到 Javac 将 .java 文件编译成 .class 文件，但是不会随着 ClassLoader 将该 .class 文件加载到内存中
- RetentionPolicy.RUNTIME
3.当注解保留时期为 RUNTIME 时：表示注解信息会被保留到"运行时期"，这是可以通过反射获取该注解的信息
Javac 会将源文件.java 编译为 .class 文件，然后通过 ClassLoader 将 .class 文件加载到内存中
成为字节码，这时就可以通过反射来获取对应的注解信息。
@Target约束注解使用位置
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
ElementType[] value();
}
ElementType 注解修饰的元素类型，使用 ElementType 枚举类来表示：
public enum ElementType {
/** Class, interface (including annotation type), or enum declaration */
TYPE,
/** Field declaration (includes enum constants) */
FIELD,
/** Method declaration */
METHOD,
/** Formal parameter declaration */
PARAMETER,
/** Constructor declaration */
CONSTRUCTOR,
/** Local variable declaration */
LOCAL_VARIABLE,
/** Annotation type declaration */
ANNOTATION_TYPE,
/** Package declaration */
PACKAGE,
/**
* Type parameter declaration
*
* @since 1.8
* @hide 1.8
*/
TYPE_PARAMETER,
/**
* Use of a type
*
* @since 1.8
* @hide 1.8
*/
TYPE_USE
}
验证注解的三种保留策略
验证 RetentionPolicy.SOURCE ,RetentionPolicy.CLASS,RetentionPolicy.RUNTIME 三种方式，
-
当注解保留策略为 RetentionPolicy.SOURCE 时，那么在反编译编译后的 .class 文件应该是看不到我们自定义的注解的
-
当注解保留策略为 RetentionPolicy.CLASS 时，那么该注解不会被加载到内存中，使用反射来检测是否有注解
-
当注解保留策略为 RetentionPolicy.RUNTIME 时,注解是可以在运行时期被反射获取的。
验证 RetentionPolicy.SOURCE：
- 定义 CustomAnnotation 保留时期为 RetentionPolicy.SOURCE
@Retention(RetentionPolicy.SOURCE)
public @interface CustomAnnotation {
}
- 使用该注解
public class DoSomething {
@CustomAnnotation
public void doSomething() {
System.out.print("do something");
}
}
- 查看编译后的 DoSomething.class 文件
这时 @CustomAnnotation 在编译成 .class 文件时就被去除了。
public class DoSomething {
public DoSomething() {
}
public void doSomething() {
System.out.print("do something");
}
}
验证 RetentionPolicy.CLASS：
- 定义 CustomAnnotation 保留时期为 RetentionPolicy.CLASS
@Retention(RetentionPolicy.CLASS)
public @interface CustomAnnotation {
}
- 使用该注解
public class DoSomething {
@CustomAnnotation
public void doSomething() {
System.out.print("do something");
}
}
- 查看编译后的 DoSomething.class 文件可以发现，这个@CustomAnnotation 在编译成 .class 文件之后仍旧会被保留下来。
public class DoSomething {
public DoSomething() {
}
@CustomAnnotation
public void doSomething() {
System.out.print("do something");
}
}
- 通过反射来校验
通过以下方式获取到的 annotation 为 null 表示 RetentionPolicy.CLASS 修饰的注解是不会被加载到内存中的
public class Test {
public static void main(String[] args) {
try {
//反射获取 DoSomething 中 doSomething 对应的 Method 对象
Method method = DoSomething.class.getDeclaredMethod("doSomething");
//获取该 Method 的注解
CustomAnnotation annotation = method.getAnnotation(CustomAnnotation.class);
if(annotation==null){
//表示该方法在运行时期是没有注解的
}else {
//表示该方法在运行时期是有注解的
}
} catch (NoSuchMethodException e) {
e.printStackTrace();
}
}
}
验证 RetentionPolicy.RUNTIME：
跟验证 RetentionPolicy.CLASS：一样，只不过能通过反射获取到注解的信息。
网友评论