极简JAVA 注解

桃扇骨 2021-11-05 11:36 393阅读 0赞

### 自定义注解 ###

*  使用@interface定义注解
 *  可定义多个参数和默认值，核心参数推荐使用value
 *  必须通过一些元注解来修饰自定义注解，@Target指定注解的应用范围
 *  设置@Retention设置注解的作用范围（一般设置为RUNTIME）
    
        @Target({ 
            ElementType.TYPE,
            ElementType.FIELD,
            ElementType.METHOD
        })
        //定义该注解可以作用域class/interface上，类的成员变量上，类的成员方法上
        @Retention(RetentionPolicy.RUNTIME)
        //定义该注解的作用范围
        public @interface Report{ 
            int type() default 0;
            String level() default "debug";
            String value() default "";
        }
    
    元注解:
    
     *  `@Target` : 定义Annotation可以被应用于源码的哪些位置
        
         *  类或接口：ElementType.TYPE
         *  类的字段：ElementType.FIELD
         *  类的方法：ElementType.METHOD
         *  构造方法：ElementType.CONSTRUCTOR
         *  方法参数：ElementType.PARAMETER
            
            例子：
            
                @Target(ElementType.TYPE)
                //可以传入单一的变量，也可以传入数组
                @Target({ 
                    ElementType.TYPE,
                    ElementType.FIELD
                })
     *  `@Retention` ：定义Annotation的生命周期
        
         *  仅编译期：RetentionPolicy.SOURCE （注解是给编译器看的，编译器编译过后直接丢弃该种注解，如@Override）
         *  仅class文件：RetentionPolicy.CLASS（注解默认的生命周期是CLASS） (注解会存在于class文件中，但执行时会被VM丢弃)
         *  运行期：RetentionPolicy.RUNTIME （VM在运行期可以保留该注解，可通过反射来读取该注解的信息）
            
            通常自定义的注解一般的生命周期都是RUNTIME
     *  `@Repeatable`：定义该注解是否允许重复（JDK>=1.8）
     *  `@Inherited`：定义子类是否可以继承父类定义的Annotationn
        
        仅针对@Target为ElementType.TYPE，且仅支持class的继承，不支持interface的继承
     *  `@Document`：将注解包含在Javadoc中

### 如何处理自定义注解 ###

（只针对RUNTIME类型的注解）

Annotation也是一种类，可以通过反射API来读取Annotation

*  Class.**isAnnotationPresent**(annotation.class) 判断某个annotation是否存在
 *  Field.isAnnotationPresent()
 *  Method.isAnnotationPresent()
 *  Constructor.isAnnotationPresent()

获取Annotation

Class | Field | Method .getAnnotation(anno.class)

public class Test{ 
        @Report(value = "this is String",type = 0）
        private String a;
        
        @Report(value = "this is method",type = 1）
                public void say(){ 
                    Syste.out.println("hello");
                }
                
                public static void main(String[] args){ 
                    Class clazz = Test.class;
                    Field[] fs = clazz.getDeclaredFields();
                    Method[] ms = clazz.getDeclaredMethods();
                    for(Field f:fs){ 
                        if(f.isAnnotationPresent(Report.class)){ 
                            Report r = f.getAnnotation(Report.class);
                            System.out.println(r.type()+","+r.value());
                        }
                    }
                }
    }

获取方法参数的annotation比较麻烦，如

public void say(@Report(type = 2) String name, String age){ 
        //...
    }

想要获取函数`say()`的参数的注解，如下

Method m = ....;
    //这里的m假设是上方的say函数
    //因为一个函数的参数是多个，而每个参数又可以有多个注解修饰，所以获取到的是个二维数组
    Annotation[][] annos = m.getParameterAnnotations();
    Annotation[] annos_1 = annos[0];  //获取第一个参数的注解，上面相当于获取了参数name的注解
    for(Annotation anno:annos_1){ 
        if(anno instanceof Report){ 
            Report r = (Report) anno;
            System.out.println(".....");
        }
    }

注意，注解的生命周期一定要为Annotation设置`@Retention(RetentionPolicy.RUNTIME)`，否则，在运行时，无法通过反射对注解进行处理