一文搞懂：自定义注解

随着注解使用的越来越广泛，在逐步体会到注解带来的便利同时，人们又会提出新的需求，如何才能根据自己的需求定制注解。

自定义注解的使用。我们用@interface 定义一个注解，然后定义其属性，然后注解可以被标注到属性、方法、类以及注解上，我们再使用注解时，使用目标对象的getDeclaredAnnotataion方法获取注解实例对象。

如何定义注解。定义注解需要使用@interface。如：

public @interface Test{} 自定义的注解需要添加元注解或者默认配置。

元注解解读。@Target用到哪里，@Retention什么时候用，@Inherited是否允许继承。

@Target 表示注解用于什么地方。具体参数类型如下：
ElementType.CONSTRUCTOR，用于构造器
ElementType.FIELD，用于成员变量、属性
ElementType.LOCAL，用于描述局部变量
ElementType.METHOD，用于描述方法
ElementType.PACKAGE，用于描述包
ElementType.PARAMETER，用于描述参数
ElementType.TYPE，用于描述类、接口

@Retention 表示什么时候使用该注解。具体参数如下：
RetentionPolicy.SOURCE，表示在编译阶段丢弃，编译结束后，无意义。如：@Override。
RetentionPolicy.CLASS，表示在类加载时丢去，在字节码加载时有用，默认使用这种方式。
RetentionPolicy.RUNTIME，表示始终不会丢弃，在运行时，使用反射机制读取到该注解的信息。自定义注解多为这种方式。

@Inherited 表示能否被继承，若使用，则表示可以被继承。

下边进行实例操

一、首先自定义一个注解。如：

@Target(value = ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Teacher {
 public String name() default "";
 public String school() default "";
 public String students() default "";
}

二、使用反射告诉这个注解要做什么

public class AnnotationUtil {
 public static void getTeacherInfo(Class clazz){
 String teacherInfo = "老师信息：";
 //获取类中所有变量field
 Field[] fields = clazz.getDeclaredFields();
 //遍历field数组
 for (Field field: fields) {
 if (field.isAnnotationPresent(Teacher.class)) {
 //找到有@Teacher的注解
 Teacher teacher = field.getAnnotation(Teacher.class);
 teacherInfo = teacherInfo+teacher.name()+","+teacher.school()+","+teacher.students();
 System.out.println(teacherInfo);
 }
 }
 }
}

三、在其它地方使用该注解

public class SmallStudent {
 
 @Teacher(name = "黄老师", school = "杭州一中", students = "高三五班")
 public String teacher;
}

四、测试

@Test
public void testAnnotation(){
 AnnotationUtil.getTeacherInfo(SmallStudent.class);
}

五、测试结果

老师信息：黄老师,杭州一中,高三五班

最后，自定义注解你理解了吗，欢迎讨论和关注。

一文搞懂：自定义注解

猜你喜欢