程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> 詳解Java注解教程及自界說注解

詳解Java注解教程及自界說注解

編輯：關於JAVA

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

Java注解供給了關於代碼的一些信息，但其實不直接感化於它所注解的代碼內容。在這個教程傍邊，我們將進修Java的注解，若何定制注解，注解的應用和若何經由過程反射解析注解。

Java1.5引入了注解，以後很多java框架中年夜量應用注解，如Hibernate、Jersey、Spring。注解作為法式的元數據嵌入到法式傍邊。注解可以被一些解析對象或許是編譯對象停止解析。我們也能夠聲明注解在編譯進程或履行時發生感化。

在應用注解之前，法式源數據只是經由過程java正文和javadoc，然則注解供給的功效要遠遠跨越這些。注解不只包括了元數據，它還可以感化於法式運轉進程中、注解說明器可以經由過程注處理定法式的履行次序。例如，在Jersey webservice 我們為辦法添加URI字符串的情勢的**PATH**注解，那末在法式運轉進程中jerser說明法式將決議該辦法去挪用所給的URI。

創立Java自界說注解

創立自界說注解和創立一個接口類似，然則注解的interface症結字須要以@符號開首。我們可認為注解聲明辦法。我們先來看看注解的例子，然後我們將評論辯論他的一些特征。

package com.journaldev.annotations;
 
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
  public @interface MethodInfo{
  String author() default 'Pankaj';
  String date();
  int revision() default 1;
  String comments();
}

注解辦法不克不及帶有參數；
注解辦法前往值類型限制為：根本類型、String、Enums、Annotation或許是這些類型的數組；
注解辦法可以有默許值；
注解自己可以或許包括元注解，元注解被用來注解其它注解。
這裡有四品種型的元注解：

1. @Documented —— 指明具有這個注解的元素可以被javadoc此類的對象文檔化。這類類型應當用於注解那些影響客戶應用帶正文的元素聲明的類型。假如一種聲明應用Documented停止注解，這類類型的注解被作為被標注的法式成員的公共API。

2. @Target——指明該類型的注解可以注解的法式元素的規模。該元注解的取值可認為TYPE,METHOD,CONSTRUCTOR,FIELD等。假如Target元注解沒有湧現，那末界說的注解可以運用於法式的任何元素。

3. @Inherited——指明該注解類型被主動繼續。假如用戶在以後類中查詢這個元注解類型而且以後類的聲明中不包括這個元注解類型，那末也將主動查詢以後類的父類能否存在Inherited元注解，這個舉措將被反復履行曉得這個標注類型被找到，或許是查詢到頂層的父類。

4.@Retention——指清楚明了該Annotation被保存的時光長短。RetentionPolicy取值為SOURCE,CLASS,RUNTIME。

Java內建注解

Java供給了三種內建注解。

1. @Override——當我們想要復寫父類中的辦法時，我們須要應用該注解去告訴編譯器我們想要復寫這個辦法。如許一來當父類中的辦法移除或許產生更改時編譯器將提醒毛病信息。

2. @Deprecated——當我們願望編譯器曉得某一辦法不建議應用時，我們應當應用這個注解。Java在javadoc 中推舉應用該注解，我們應當供給為何該辦法不推舉應用和替換的辦法。

3. @SuppressWarnings——這個僅僅是告知編譯器疏忽特定的正告信息，例如在泛型中應用原生數據類型。它的保存戰略是SOURCE（譯者注：在源文件中有用）而且被編譯器拋棄。

我們來看一個java內建注解的例子參照上邊提到的自界說注解。

package com.journaldev.annotations;
 
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.List;
 
public class AnnotationExample {
 
public static void main(String[] args) {
}
 
@Override
@MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 1)
public String toString() {
  return 'Overriden toString method';
}
 
@Deprecated
@MethodInfo(comments = 'deprecated method', date = 'Nov 17 2012')
public static void oldMethod() {
  System.out.println('old method, don't use it.');
}
 
@SuppressWarnings({ 'unchecked', 'deprecation' })
@MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 10)
public static void genericsTest() throws FileNotFoundException {
  List l = new ArrayList();
  l.add('abc');
  oldMethod();
}
 
}

信任這個例子可以不言自明並能展現在分歧場景下的運用。

Java注解解析
我們將應用反射技巧來解析java類的注解。那末注解的RetentionPolicy應當設置為RUNTIME不然java類的注解信息在履行進程中將弗成用那末我們也不克不及從中獲得任何和注解有關的數據。

package com.journaldev.annotations;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
 
public class AnnotationParsing {
 
public static void main(String[] args) {
  try {
  for (Method method : AnnotationParsing.class
    .getClassLoader()
    .loadClass(('com.journaldev.annotations.AnnotationExample'))
    .getMethods()) {
    // checks if MethodInfo annotation is present for the method
    if (method.isAnnotationPresent(com.journaldev.annotations.MethodInfo.class)) {
      try {
    // iterates all the annotations available in the method
        for (Annotation anno : method.getDeclaredAnnotations()) {
          System.out.println('Annotation in Method ''+ method + '' : ' + anno);
          }
        MethodInfo methodAnno = method.getAnnotation(MethodInfo.class);
        if (methodAnno.revision() == 1) {
          System.out.println('Method with revision no 1 = '+ method);
          }
 
      } catch (Throwable ex) {
          ex.printStackTrace();
          }
    }
  }
  } catch (SecurityException | ClassNotFoundException e) {
      e.printStackTrace();
     }
  }
 
}

運轉下面法式將輸入：

Annotation in Method 'public java.lang.String com.journaldev.annotations.AnnotationExample.toString()' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=Main method, date=Nov 17 2012)
Method with revision no 1 = public java.lang.String com.journaldev.annotations.AnnotationExample.toString()
Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @java.lang.Deprecated()
Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=deprecated method, date=Nov 17 2012)
Method with revision no 1 = public static void com.journaldev.annotations.AnnotationExample.oldMethod()
Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.genericsTest() throws java.io.FileNotFoundException' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=10, comments=Main method, date=Nov 17 2012)

這就是該教程的全體內容，願望你可以從中學到些器械。