注解相关信息
- @Documented – 存在于JavaDoc
- @Retention – 注解使用场景
- @Target – 目标地址
- @Inherited – 是否允许子类继承该注解
Retention定义注解
指示带注释类型的注释将保留多长时间。 如果注释类型声明中不存在 Retention 注释，则保留策略默认为RetentionPolicy.CLASS 。
package java.lang.annotation;
/**
* Annotation retention policy. The constants of this enumerated type
* describe the various policies for retaining annotations. They are used
* in conjunction with the {@link Retention} meta-annotation type to specify
* how long annotations are to be retained.
*
* @author Joshua Bloch
* @since 1.5
*/
public enum RetentionPolicy {
/**
* Annotations are to be discarded by the compiler.
*/
SOURCE,
/**
* Annotations are to be recorded in the class file by the compiler
* but need not be retained by the VM at run time. This is the default
* behavior.
*/
CLASS,
/**
* Annotations are to be recorded in the class file by the compiler and
* retained by the VM at run time, so they may be read reflectively.
*
* @see java.lang.reflect.AnnotatedElement
*/
RUNTIME
}
● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
● RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
Target描述注解使用场景
-
ElementType.CONSTRUCTOR: 用于描述构造器
-
ElementType.FIELD: 成员变量、对象、属性（包括enum实例）
-
ElementType.LOCAL_VARIABLE: 用于描述局部变量
-
ElementType.METHOD: 用于描述方法
-
ElementType.PACKAGE: 用于描述包
-
ElementType.PARAMETER: 用于描述参数
-
ElementType.TYPE: 用于描述类、接口(包括注解类型) 或enum声明
自定义注解举例
自定义注解
package com.itdfq.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @Author: GodChin
* @Date: 2021/9/15 15:36
* @Description:
*/
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface GetName {
String name();
String value();
}
注解类
package com.itdfq;
import com.itdfq.annotation.GetName;
/**
* @Author: QianMo
* @Date: 2021/9/15 9:17
* @Description: 自定义注解
*/
@GetName(name = "Demo1类",value = "类属性注解")
public class Demo1 {
@GetName(name = "name字段",value = "属性注解")
private String name;
@GetName(name = "test()方法注解",value = "方法注解")
public void test(){
System.out.println("123");
}
public void hello(){
System.out.println("hello world");
}
}
获取注解信息
package com.itdfq.annotation;
import com.alibaba.fastjson.JSON;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
/**
* @Author: QianMo
* @Date: 2021/9/16 9:39
* @Description: 通过反射获取注解信息
*/
public class ClientTest {
public static void main(String[] args) throws Exception {
Class aClass = Class.forName("com.itdfq.Demo1");
//获取注解类信息
System.out.println("------------获取注解类信息-----------");
GetName annotation = (GetName) aClass.getAnnotation(GetName.class);
System.out.println(annotation.name());
System.out.println("------------获取方法注解-----------");
//获取方法注解 使用isAnnotationPresent判断方法上是否使用了注解
Method[] declaredMethods = aClass.getDeclaredMethods();
for (int i = 0 ; i<declaredMethods.length;i++){
if (declaredMethods[i].isAnnotationPresent(GetName.class)){
GetName getName = declaredMethods[i].getAnnotation(GetName.class);
System.out.println(JSON.toJSONString(getName));
}
}
System.out.println("------------获取指定方法注解信息-----------");
//获取指定方法注解信息
Method test = aClass.getDeclaredMethod("test");
GetName annotation1 = test.getAnnotation(GetName.class);
System.out.println(JSON.toJSONString(annotation1));
//获取指定属性字段信息
System.out.println("------------获取指定属性字段信息-----------");
Field name = aClass.getDeclaredField("name");
GetName annotation2 = name.getAnnotation(GetName.class);
System.out.println(JSON.toJSONString(annotation2));
System.out.println("------------获取所有字段信息-----------");
Field[] declaredFields = aClass.getDeclaredFields();
}
}
结果
