Java運行時注解(RetentionPolicy.RUNTIME)

注解按生命周期來劃分可分為3類:

1、RetentionPolicy.SOURCE:注解只保留在源文件,當Java文件編譯成class文件的時候,注解被遺棄;
2、RetentionPolicy.CLASS:注解被保留到class文件,但jvm加載class文件時候被遺棄,這是默認的生命周期;
3、RetentionPolicy.RUNTIME:注解不僅被保存到class文件中,jvm加載class文件之后,仍然存在;

這3個生命周期分別對應(yīng)于:Java源文件(.java文件) ---> .class文件 ---> 內(nèi)存中的字節(jié)碼。

那怎么來選擇合適的注解生命周期呢?

首先要明確生命周期長度 SOURCE < CLASS < RUNTIME ,所以前者能作用的地方后者一定也能作用。一般如果需要在運行時去動態(tài)獲取注解信息,那只能用 RUNTIME 注解;如果要在編譯時進行一些預(yù)處理操作,比如生成一些輔助代碼(如 ButterKnife),就用 CLASS注解;如果只是做一些檢查性的操作,比如** @Override** 和 @SuppressWarnings,則可選用 SOURCE 注解。

下面來介紹下運行時注解的簡單運用。

獲取注解

你需要通過反射來獲取運行時注解,可以從 Package、Class、Field、Method...上面獲取,基本方法都一樣,幾個常見的方法如下:

/** 
 * 獲取指定類型的注解 
 */  
public <A extends Annotation> A getAnnotation(Class<A> annotationType);  
  
/** 
 * 獲取所有注解,如果有的話 
 */  
public Annotation[] getAnnotations();  
  
/** 
 * 獲取所有注解,忽略繼承的注解 
 */  
public Annotation[] getDeclaredAnnotations();  
  
/** 
 * 指定注解是否存在該元素上,如果有則返回true,否則false 
 */  
public boolean isAnnotationPresent(Class<? extends Annotation> annotationType);  
  
/** 
 * 獲取Method中參數(shù)的所有注解 
 */  
public Annotation[][] getParameterAnnotations();

要使用這些函數(shù)必須先通過反射獲取到對應(yīng)的元素:**Class、Field、Method **等。

自定義注解

來看下自定義注解的簡單使用方式,這里先定義3個運行時注解:

// 適用類、接口(包括注解類型)或枚舉  
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.TYPE)  
public @interface ClassInfo {  
    String value();  
}  
// 適用field屬性,也包括enum常量  
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.FIELD)  
public @interface FieldInfo {  
    int[] value();  
}  
// 適用方法  
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.METHOD)  
public @interface MethodInfo {  
    String name() default "long";  
    String data();  
    int age() default 27;  
}  

這3個注解分別適用于不同的元素,并都帶有不同的屬性,在使用注解是需要設(shè)置這些屬性值。

再定義一個測試類來使用這些注解:

/** 
 * 測試運行時注解 
 */  
@ClassInfo("Test Class")  
public class TestRuntimeAnnotation {  
  
    @FieldInfo(value = {1, 2})  
    public String fieldInfo = "FiledInfo";  
  
    @FieldInfo(value = {10086})  
    public int i = 100;  
  
    @MethodInfo(name = "BlueBird", data = "Big")  
    public static String getMethodInfo() {  
        return TestRuntimeAnnotation.class.getSimpleName();  
    }  
}  

使用還是很簡單的,最后來看怎么在代碼中獲取注解信息:

/** 
 * 測試運行時注解 
 */  
private void _testRuntimeAnnotation() {  
    StringBuffer sb = new StringBuffer();  
    Class<?> cls = TestRuntimeAnnotation.class;  
    Constructor<?>[] constructors = cls.getConstructors();  
    // 獲取指定類型的注解  
    sb.append("Class注解:").append("\n");  
    ClassInfo classInfo = cls.getAnnotation(ClassInfo.class);  
    if (classInfo != null) {  
        sb.append(Modifier.toString(cls.getModifiers())).append(" ")  
                .append(cls.getSimpleName()).append("\n");  
        sb.append("注解值: ").append(classInfo.value()).append("\n\n");  
    }  
  
    sb.append("Field注解:").append("\n");  
    Field[] fields = cls.getDeclaredFields();  
    for (Field field : fields) {  
        FieldInfo fieldInfo = field.getAnnotation(FieldInfo.class);  
        if (fieldInfo != null) {  
            sb.append(Modifier.toString(field.getModifiers())).append(" ")  
                    .append(field.getType().getSimpleName()).append(" ")  
                    .append(field.getName()).append("\n");  
            sb.append("注解值: ").append(Arrays.toString(fieldInfo.value())).append("\n\n");  
        }  
    }  
  
    sb.append("Method注解:").append("\n");  
    Method[] methods = cls.getDeclaredMethods();  
    for (Method method : methods) {  
        MethodInfo methodInfo = method.getAnnotation(MethodInfo.class);  
        if (methodInfo != null) {  
            sb.append(Modifier.toString(method.getModifiers())).append(" ")  
                    .append(method.getReturnType().getSimpleName()).append(" ")  
                    .append(method.getName()).append("\n");  
            sb.append("注解值: ").append("\n");  
            sb.append("name: ").append(methodInfo.name()).append("\n");  
            sb.append("data: ").append(methodInfo.data()).append("\n");  
            sb.append("age: ").append(methodInfo.age()).append("\n");  
        }  
    }  
  
    System.out.print(sb.toString());  
}  

所做的操作都是通過反射獲取對應(yīng)元素,再獲取元素上面的注解,最后得到注解的屬性值。

看一下輸出情況,這里我直接顯示在手機上:

image

這個自定義運行時注解是很簡單的例子,有很多優(yōu)秀的開源項目都有使用運行時注解來處理問題,有興趣可以找一些來研究。因為涉及到反射,所以運行時注解的效率多少會受到影響,現(xiàn)在很多的開源項目使用的是編譯時注解,關(guān)于編譯時注解后面再來詳細介紹。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 本文章涉及代碼已放到github上annotation-study 1.Annotation為何而來 What:A...
    zlcook閱讀 29,792評論 15 116
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,711評論 19 139
  • 伙伴兒們今天表現(xiàn)得不錯,出色地完成了工作任務(wù),我也打了個“順風(fēng)車”,準點兒跟著大伙兒下班回家了!作為組長,能夠帶領(lǐng)...
    小小Mark閱讀 208評論 3 0
  • 現(xiàn)在他變心了,嫌棄她,把她當成陌生人。 01 客廳里空蕩而冷寂,她紅腫著眼睛,呆坐在沙發(fā)上。 孩子蹲在地上,乖巧地...
    幸美人閱讀 573評論 0 2
  • 80后一代是非常獨特的,經(jīng)常我們都感嘆自己的生不逢時,但是其實歷史也給我們80后特殊的意義。80年正在成為社會的中...
    李北齋閱讀 2,362評論 0 0

友情鏈接更多精彩內(nèi)容