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

時間 2019-11-05

標籤自定義註解運行時 retentionpolicy.runtime retentionpolicy runtime 简体版

原文原文鏈接

對註解概念不瞭解的能夠先看這個：Java註解基礎概念總結java

前面有提到註解按生命週期來劃分可分爲3類：git

一、RetentionPolicy.SOURCE：註解只保留在源文件，當Java文件編譯成class文件的時候，註解被遺棄；
二、RetentionPolicy.CLASS：註解被保留到class文件，但jvm加載class文件時候被遺棄，這是默認的生命週期；
三、RetentionPolicy.RUNTIME：註解不只被保存到class文件中，jvm加載class文件以後，仍然存在；github

這3個生命週期分別對應於：Java源文件(.java文件) ---> .class文件 ---> 內存中的字節碼。app

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

首先要明確生命週期長度 SOURCE < CLASS < RUNTIME ，因此前者能做用的地方後者必定也能做用。通常若是須要在運行時去動態獲取註解信息，那隻能用 RUNTIME 註解；若是要在編譯時進行一些預處理操做，好比生成一些輔助代碼（如 ButterKnife），就用 CLASS註解；若是隻是作一些檢查性的操做，好比 @Override 和 @SuppressWarnings，則可選用 SOURCE 註解。ide

下面來介紹下運行時註解的簡單運用。函數

獲取註解測試

你須要經過反射來獲取運行時註解，能夠從 Package、Class、Field、Method...上面獲取，基本方法都同樣，幾個常見的方法以下：
--------------------- spa

/**
 * 獲取指定類型的註解
 */
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 等。.net

自定義註解

來看下自定義註解的簡單使用方式，這裏先定義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());
}