1. 程式人生 > >自定義註解之執行時註解(RetentionPolicy.RUNTIME)

自定義註解之執行時註解(RetentionPolicy.RUNTIME)

前面有提到註解按生命週期來劃分可分為3類:

1、RetentionPolicy.SOURCE:註解只保留在原始檔,當Java檔案編譯成class檔案的時候,註解被遺棄;
2、RetentionPolicy.CLASS:註解被保留到class檔案,但jvm載入class檔案時候被遺棄,這是預設的生命週期;
3、RetentionPolicy.RUNTIME:註解不僅被儲存到class檔案中,jvm載入class檔案之後,仍然存在;

這3個生命週期分別對應於:Java原始檔(.java檔案) ---> .class檔案 ---> 記憶體中的位元組碼。

那怎麼來選擇合適的註解生命週期呢?

首先要明確生命週期長度 SOURCE < CLASS < RUNTIME ,所以前者能作用的地方後者一定也能作用。一般如果需要在執行時去動態獲取註解資訊,那隻能用 RUNTIME 註解;如果要在編譯時進行一些預處理操作,比如生成一些輔助程式碼(如 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中引數的所有註解
 */
public Annotation[][] getParameterAnnotations();

要使用這些函式必須先通過反射獲取到對應的元素: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個註解分別適用於不同的元素,並都帶有不同的屬性,在使用註解是需要設定這些屬性值。

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

/**
 * 測試執行時註解
 */
@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());
}

所做的操作都是通過反射獲取對應元素,再獲取元素上面的註解,最後得到註解的屬性值。

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


這個自定義執行時註解是很簡單的例子,有很多優秀的開源專案都有使用執行時註解來處理問題,有興趣可以找一些來研究。因為涉及到反射,所以執行時註解的效率多少會受到影響,現在很多的開源專案使用的是編譯時註解,關於編譯時註解後面再來詳細介紹。