程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> Java注解Annotation解析

Java注解Annotation解析

編輯：關於JAVA

Java注解Annotation解析。本站提示廣大學習愛好者：（Java注解Annotation解析）文章只能為提供參考，不一定能成為您想要的結果。以下是Java注解Annotation解析正文

概述

Java在1.5版本引入注解Annotation，又稱Java標注，注解是一種語法元數據，可以被直接應用到源代碼中，類/辦法/變量/參數/包名等都可以被注解。和Javadoc標簽分歧，編譯器在生成class文件時刻可以或許保存注解代碼，同時，能夠為了在法式運轉進程中（run-time）可使用注解，Java虛擬機遇把注解保存，如許便可以經由過程反射獲得注解Annotation的相干信息。

內置注解

其實我們日常平凡會常常碰見注解，例如@Override、@Deprecated等等，這些都是JDK中內置的注解，先來看看Java內置的注解重要有哪些。
•感化於Java代碼的注解
◦@Override 檢討某個辦法能否是復寫的辦法，假如這個辦法在父類或許完成的接口中未找到，編譯會失足。
◦@Deprecated 標志某個辦法或許類被放棄，假如應用該類或許辦法，編譯進程會報正告
◦@SuppressWarnings 告訴編譯器疏忽關於被標注的參數的正告
◦@SafeVarargs 疏忽關於挪用含有泛型參數的辦法或許結構器的正告，1.7新增注解
◦@FunctionalInterface 注解某一個聲明的接口將被用作功效性接口，1.8新增注解

•作於其他注解的注解，被稱為元注解（Meta Annotation）
◦@Retention 指明被標注的注解在甚麼時刻應用（也就是注解甚麼時刻會被保存）
■僅僅在源代碼中保存，在編譯進程中拋棄（RetentionPolicy.RUNTIME）
■注解在編譯進程中保留到class文件，在class文件被加載時刻疏忽（RetentionPolicy.CLASS）
■注解在class文件加載時刻被讀取，也就是運轉中注解可用，可以經由過程反射獲得注解信息（RetentionPolicy.RUNTIME）

◦@Documented 指明在生成Javadoc時刻，被標注的注解將被寫入Javadoc文檔中
◦@Target 指明被標注的注解的感化規模
■ElementType.TYPE:用於描寫類、接口(包含注解類型) 或enum聲明
■ElementType.FIELD:用於描寫域
■ElementType.METHOD:用於描寫辦法
■ElementType.PARAMETER:用於描寫參數
■ElementType.CONSTRUCTOR:用於描寫結構器
■ElementType.LOCAL_VARIABLE:用於描寫部分變量
■ElementType.ANNOTATION_TYPE:用於描寫注解
■ElementType.PACKAGE:用於描寫包

◦@Inherited 指明被標注的注解是被繼續的，也就是說假如一個@Inherited潤飾的annotation類型被用於一個類，則這個annotation也會感化於改類的子類。
◦@Repeatable 指明被標注的注解可以屢次感化於統一個對象，1.9新增注解

自界說注解

下面說了那末多注解，年夜家集中存眷元注解，我們自界說注解時刻，平日會應用元注解來協助我們。自界說注解格局為public @interface 注解名 {界說體}，應用@interface自界說注解時，主動繼續了java.lang.annotation.Annotation接口。自界說注解時，不克不及繼續其他的注解或接口。注解中聲明的辦法現實上是聲清楚明了一個注解參數，辦法的稱號就是參數的稱號，前往值類型就是參數的類型，可以經由過程default來聲明參數的默許值。

自界說注解很簡略，應用@interface來界說一個注解，以下。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface ClassInfo {
 String author() default "Wang";
 String date();
 String comments();
}

自界說了一個名為ClassInfo的注解，依據@Retention可以得知這個注解會一向存在，也就是在法式運轉中時刻，這個注解照樣有用的；@Target(ElementType.TYPE)解釋ClassInfo注解的是感化於類、接口或enum聲明的；@Documented
解釋ClassInfo信息可以被寫入Javadoc文檔中。

再來看一下自界說注解中的一些注解參數，外面有三個注解參數，注解參數是可以設置默許值，例如author注解參數，默許值為Wang，其他兩個參數就沒有默許值。

再來看另外一個自界說的注解。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MethodInfo {
 String description() default "No Description";
 String date();
}

這個自界說的注解MethodInfo是感化於辦法的，在法式運轉中時刻，這個注解也會存在；外面有兩個注解參數。

注解參數的界說（辦法的界說），只能用public或許default兩個拜訪權限潤飾符，參數的類型支撐以下幾種。
•八種根本數據類型（byte，int，short，long，float，double，char，boolean）
•String類型
•Class類型
•enum類型
•Annotation類型
•以上一切類型的數組

注解的應用

除下面兩個注解，又添加了一個Field感化域的注解。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FieldInfo {
 String type();
 String name();
}

自界說的注解中的注解參數假如沒有聲明默許值，在應用自界說注解時刻，必需給這些參數賦值，不然編譯器會報錯。

看一下注解應用的代碼：

@ClassInfo(author = "wang",
  date = "2016/9/13",
  comments = "annotation demo")
public class AnnotationDemo {

 @FieldInfo(type = "public", name = "firstField")
 public int firstField;

 @FieldInfo(type = "private", name = "secondField")
 private String secondField;

 @MethodInfo(description = "method in AnnotationDemo", name = "firstMethod")
 public void firstMethod(String value) {
  System.out.printf("first method involved");
 }

 @MethodInfo(description = "method in AnnotationDemo", name="secondMethod")
 private void secondMethod() {
  System.out.printf("first method involved");
 }
}

獲得注解信息

要獲得注解信息，起首得包管注解在法式運轉時刻會存在，所以普通會給自界說的注解添加了@Retention(RetentionPolicy.RUNTIME)元注解，如許在法式運轉進程中，我們可以經由過程反射去獲得一些注解信息，關於反射的解釋，可以檢查這篇文章。

public class AnnotationTest {
 public static void main(String[] args) {
  resolveClassAnnotationInfo(AnnotationDemo.class);
  resolveFieldAnnotationInfo(AnnotationDemo.class);
  resolveMethodAnnotationInfo(AnnotationDemo.class);
 }

 private static void resolveClassAnnotationInfo(Class<?> clz) {
  // 斷定該類能否有ClassInfo注解
  if(clz.isAnnotationPresent(ClassInfo.class)) {
   ClassInfo classInfo = (ClassInfo) clz.getAnnotation(ClassInfo.class);
   System.out.println(classInfo.author() + " " + classInfo.comments() + " " + classInfo.date());
  }
 }

 private static void resolveFieldAnnotationInfo(Class<?> clz) {
  Field[] fields = clz.getDeclaredFields();
  for (Field field : fields) {
   if(field.isAnnotationPresent(FieldInfo.class)) {
    FieldInfo fieldInfo = (FieldInfo) field.getAnnotation(FieldInfo.class);
    System.out.println(fieldInfo.type() + " " + fieldInfo.name());
   }
  }
 }

 private static void resolveMethodAnnotationInfo(Class<?> clz) {
  Method[] methods = clz.getDeclaredMethods();
  for (Method method : methods) {
   if(method.isAnnotationPresent(MethodInfo.class)) {
    MethodInfo methodInfo = (MethodInfo) method.getAnnotation(MethodInfo.class);
    System.out.println(methodInfo.name() + " " + methodInfo.description());
   }
  }
 }
}

經由過程反射獲得類中的Field/Method等等，經由過程getAnnotation()或許getAnnotations()獲得相干注解，拿到詳細注解便可以獲得詳細的信息了。

運轉成果輸入以下：

圖-1 運轉成果圖

總結

關於Java的初學者乃至是有必定經歷的Java開辟人員，對Java注解的接觸能夠比擬少，而在現實中，也很罕用到注解，然則會常常會在代碼外面看見，這篇文章算是對注解的淺易引見，最最少在代碼層面是浏覽無壓力的。

以上就是本文的全體內容，願望對年夜家的進修有所贊助，也願望年夜家多多支撐。