1. 程式人生 > >@Retention註解作用

@Retention註解作用

@Retention作用是定義被它所註解的註解保留多久,一共有三種策略,定義在RetentionPolicy列舉中.

從註釋上看:

source:註解只保留在原始檔,當Java檔案編譯成class檔案的時候,註解被遺棄;被編譯器忽略

class:註解被保留到class檔案,但jvm載入class檔案時候被遺棄,這是預設的生命週期

runtime:注解不僅被儲存到class檔案中,jvm載入class檔案之後,仍然存在

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


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

首先要明確生命週期長度 SOURCE < CLASS < RUNTIME

 ,所以前者能作用的地方後者一定也能作用。一般如果需要在執行時去動態獲取註解資訊,那隻能用 RUNTIME 註解;如果要在編譯時進行一些預處理操作,比如生成一些輔助程式碼(如 ButterKnife,就用 CLASS註解;如果只是做一些檢查性的操作,比如 @Override 和 @SuppressWarnings,則可選用 SOURCE 註解

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

獲取註解

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

  1. /**
  2. * 獲取指定型別的註解
  3. */
  4. public <A extends Annotation> A getAnnotation
    (Class<A> annotationType)
    ;
  5. /**
  6. * 獲取所有註解,如果有的話
  7. */
  8. public Annotation[] getAnnotations();
  9. /**
  10. * 獲取所有註解,忽略繼承的註解
  11. */
  12. public Annotation[] getDeclaredAnnotations();
  13. /**
  14. * 指定註解是否存在該元素上,如果有則返回true,否則false
  15. */
  16. public boolean isAnnotationPresent(Class<? extends Annotation> annotationType);
  17. /**
  18. * 獲取Method中引數的所有註解
  19. */
  20. public Annotation[][] getParameterAnnotations();

要使用這些函式必須先通過反射獲取到對應的元素:Class、Field、Method 等。

自定義註解

來看下自定義註解的簡單使用方式,這裡先定義3個執行時註解:

  1. // 適用類、介面(包括註解型別)或列舉
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Target(ElementType.TYPE)
  4. public @interface ClassInfo {
  5. String value();
  6. }
  7. // 適用field屬性,也包括enum常量
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Target(ElementType.FIELD)
  10. public @interface FieldInfo {
  11. int[] value();
  12. }
  13. // 適用方法
  14. @Retention(RetentionPolicy.RUNTIME)
  15. @Target(ElementType.METHOD)
  16. public @interface MethodInfo {
  17. String name() default "long";
  18. String data();
  19. int age() default 27;
  20. }
這3個註解分別適用於不同的元素,並都帶有不同的屬性,在使用註解是需要設定這些屬性值。

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

  1. /**
  2. * 測試執行時註解
  3. */
  4. @ClassInfo("Test Class")
  5. public class TestRuntimeAnnotation {
  6. @FieldInfo(value = {1, 2})
  7. public String fieldInfo = "FiledInfo";
  8. @FieldInfo(value = {10086})
  9. public int i = 100;
  10. @MethodInfo(name = "BlueBird", data = "Big")
  11. public static String getMethodInfo() {
  12. return TestRuntimeAnnotation.class.getSimpleName();
  13. }
  14. }

使用還是很簡單的,最後來看怎麼在程式碼中獲取註解資訊:

  1. /**
  2. * 測試執行時註解
  3. */
  4. private void _testRuntimeAnnotation() {
  5. StringBuffer sb = new StringBuffer();
  6. Class<?> cls = TestRuntimeAnnotation.class;
  7. Constructor<?>[] constructors = cls.getConstructors();
  8. // 獲取指定型別的註解
  9. sb.append("Class註解:").append("\n");
  10. ClassInfo classInfo = cls.getAnnotation(ClassInfo.class);
  11. if (classInfo != null) {
  12. sb.append(Modifier.toString(cls.getModifiers())).append(" ")
  13. .append(cls.getSimpleName()).append("\n");
  14. sb.append("註解值: ").append(classInfo.value()).append("\n\n");
  15. }
  16. sb.append("Field註解:").append("\n");
  17. Field[] fields = cls.getDeclaredFields();
  18. for (Field field : fields) {
  19. FieldInfo fieldInfo = field.getAnnotation(FieldInfo.class);
  20. if (fieldInfo != null) {
  21. sb.append(Modifier.toString(field.getModifiers())).append(" ")
  22. .append(field.getType().getSimpleName()).append(" ")
  23. .append(field.getName()).append("\n");
  24. sb.append("註解值: ").append(Arrays.toString(fieldInfo.value())).append("\n\n");
  25. }
  26. }
  27. sb.append("Method註解:").append("\n");
  28. Method[] methods = cls.getDeclaredMethods();
  29. for (Method method : methods) {
  30. MethodInfo methodInfo = method.getAnnotation(MethodInfo.class);
  31. if (methodInfo != null) {
  32. sb.append(Modifier.toString(method.getModifiers())).append(" ")
  33. .append(method.getReturnType().getSimpleName()).append(" ")
  34. .append(method.getName()).append("\n");
  35. sb.append("註解值: ").append("\n");
  36. sb.append("name: ").append(methodInfo.name()).append("\n");
  37. sb.append("data: ").append(methodInfo.data()).append("\n");
  38. sb.append("age: ").append(methodInfo.age()).append("\n");
  39. }
  40. }
  41. System.out.print(sb.toString());
  42. }

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

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


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