程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> Java中注解(Annotation)自定義注解入門

Java中注解(Annotation)自定義注解入門

編輯:關於JAVA

要深入學習注解,我們就必須能定義自己的注解,並使用注解,在定義自己的注解之前,我們就必須要了解Java為我們提供的元注解和相關定義注解的語法。

元注解:

元注解的作用就是負責注解其他注解。Java5.0定義了4個標准的meta-annotation類型,它們被用來提供對其它 annotation類型作說明。Java5.0定義的元注解:

1.@Target,

2.@Retention,

3.@Documented,

4.@Inherited

這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個元注解的作用和相應分參數的使用說明。

@Target:

 @Target說明了Annotation所修飾的對象范圍:Annotation可被用於 packages、types(類、接口、枚舉、Annotation類型)、類型成員(方法、構造方法、成員變量、枚舉值)、方法參數和本地變量(如循環變量、catch參數)。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。

作用:用於描述注解的使用范圍(即:被描述的注解可以用在什麼地方)

取值(ElementType)有:

1.CONSTRUCTOR:用於描述構造器

2.FIELD:用於描述域

3.LOCAL_VARIABLE:用於描述局部變量

4.METHOD:用於描述方法

5.PACKAGE:用於描述包

6.PARAMETER:用於描述參數

7.TYPE:用於描述類、接口(包括注解類型) 或enum聲明

使用實例:

@Target(ElementType.TYPE)   
public @interface Table {   
    /**   
     * 數據表名稱注解,默認值為類名稱   
     * @return   
     */
    public String tableName() default "className";   
}   
       
@Target(ElementType.FIELD)   
public @interface NoDBColumn {   
       
}

注解Table 可以用於注解類、接口(包括注解類型) 或enum聲明,而注解NoDBColumn僅可用於注解類的成員變量。

@Retention:

@Retention定義了該Annotation被保留的時間長短:某些Annotation僅出現在源代碼中,而被編譯器丟棄;而另一些卻被編譯在class文件中;編譯在class文件中的Annotation可能會被虛擬機忽略,而另一些在class被裝載時將被讀取(請注意並不影響class的執行,因為Annotation與class在使用上是被分離的)。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。

作用:表示需要在什麼級別保存該注釋信息,用於描述注解的生命周期(即:被描述的注解在什麼范圍內有效)

取值(RetentionPoicy)有:

1.SOURCE:在源文件中有效(即源文件保留)

2.CLASS:在class文件中有效(即class保留)

3.RUNTIME:在運行時有效(即運行時保留)

Retention meta-annotation類型有唯一的value作為成員,它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。具體實例如下:

@Target(ElementType.FIELD)   
@Retention(RetentionPolicy.RUNTIME)   
public @interface Column {   
    public String name() default "fieldName";   
    public String setFuncName() default "setField";   
    public String getFuncName() default "getField";    
    public boolean defaultDBValue() default false;   
}

Column注解的的RetentionPolicy的屬性值是RUTIME,這樣注解處理器可以通過反射,獲取到該注解的屬性值,從而去做一些運行時的邏輯處理

@Documented:

@Documented用於描述其它類型的annotation應該被作為被標注的程序成員的公共API,因此可以被例如javadoc此類的工具文檔化。Documented是一個標記注解,沒有成員。

@Target(ElementType.FIELD)   
@Retention(RetentionPolicy.RUNTIME)   
@Documented
public @interface Column {   
    public String name() default "fieldName";   
    public String setFuncName() default "setField";   
    public String getFuncName() default "getField";    
    public boolean defaultDBValue() default false;   
}

@Inherited:

@Inherited 元注解是一個標記注解,@Inherited闡述了某個被標注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用於一個class,則這個annotation將被用於該class的子類。

注意:@Inherited annotation類型是被標注過的class的子類所繼承。類並不從它所實現的接口繼承annotation,方法並不從它所重載的方法繼承annotation。

當@Inherited annotation類型標注的annotation的Retention是RetentionPolicy.RUNTIME,則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時,反射代碼檢查將展開工作:檢查class和其父類,直到發現指定的annotation類型被發現,或者到達類繼承結構的頂層。

實例代碼:

/**   
 *    
 * @author peida   
 *   
 */
@Inherited
public @interface Greeting {   
    public enum FontColor{ BULE,RED,GREEN};   
    String name();   
    FontColor fontColor() default FontColor.GREEN;   
}

自定義注解:

使用@interface自定義注解時,自動繼承了java.lang.annotation.Annotation接口,由編譯程序自動完成其他細節。在定義注解時,不能繼承其他的注解或接口。@interface用來聲明一個注解,其中的每一個方法實際上是聲明了一個配置參數。方法的名稱就是參數的名稱,返回值類型就是參數的類型(返回值類型只能是基本類型、Class、String、enum)。可以通過default來聲明參數的默認值。

定義注解格式:

public @interface 注解名 {定義體}

注解參數的可支持數據類型:

1.所有基本數據類型(int,float,boolean,byte,double,char,long,short)

2.String類型

3.Class類型

4.enum類型

5.Annotation類型

6.以上所有類型的數組

Annotation類型裡面的參數該怎麼設定:

第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這裡把方法設為defaul默認類型;   

第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這裡的參數成員就為String;  

第三,如果只有一個參數成員,最好把參數名稱設為"value",後加小括號.例:下面的例子FruitName注解就只有一個參數成員。

簡單的自定義注解和使用注解實例:

package annotation;   
       
import java.lang.annotation.Documented;   
import java.lang.annotation.ElementType;   
import java.lang.annotation.Retention;   
import java.lang.annotation.RetentionPolicy;   
import java.lang.annotation.Target;   
       
/**   
 * 水果名稱注解   
 * @author peida   
 *   
 */
@Target(ElementType.FIELD)   
@Retention(RetentionPolicy.RUNTIME)   
@Documented
public @interface FruitName {   
    String value() default "";   
}
package annotation;   
       
import java.lang.annotation.Documented;   
import java.lang.annotation.ElementType;   
import java.lang.annotation.Retention;   
import java.lang.annotation.RetentionPolicy;   
import java.lang.annotation.Target;   
       
/**   
 * 水果顏色注解   
 * @author peida   
 *   
 */
@Target(ElementType.FIELD)   
@Retention(RetentionPolicy.RUNTIME)   
@Documented
public @interface FruitColor {   
    /**   
     * 顏色枚舉   
     * @author peida   
     *   
     */
    public enum Color{ BULE,RED,GREEN};   
           
    /**   
     * 顏色屬性   
     * @return   
     */
    Color fruitColor() default Color.GREEN;   
       
}

package annotation;   
       
import annotation.FruitColor.Color;   
       
public class Apple {   
           
    @FruitName("Apple")   
    private String appleName;   
           
    @FruitColor(fruitColor=Color.RED)   
    private String appleColor;   
           
           
           
           
    public void setAppleColor(String appleColor) {   
        this.appleColor = appleColor;   
    }   
    public String getAppleColor() {   
        return appleColor;   
    }   
           
           
    public void setAppleName(String appleName) {   
        this.appleName = appleName;   
    }   
    public String getAppleName() {   
        return appleName;   
    }   
           
    public void displayName(){   
        System.out.println("水果的名字是:蘋果");   
    }   
}

注解元素的默認值:

注解元素必須有確定的值,要麼在定義注解的默認值中指定,要麼在使用注解時指定,非基本類型的注解元素的值不可為null。因此, 使用空字符串或0作為默認值是一種常用的做法。這個約束使得處理器很難表現一個元素的存在或缺失的狀態,因為每個注解的聲明中,所有元素都存在,並且都具有相應的值,為了繞開這個約束,我們只能定義一些特殊的值,例如空字符串或者負數,一次表示某個元素不存在,在定義注解時,這已經成為一個習慣用法。例如:

package annotation;   
        
 import java.lang.annotation.Documented;   
 import java.lang.annotation.ElementType;   
 import java.lang.annotation.Retention;   
 import java.lang.annotation.RetentionPolicy;   
 import java.lang.annotation.Target;   
        
 /**   
  * 水果供應者注解   
  * @author peida   
  *   
  */
 @Target(ElementType.FIELD)   
 @Retention(RetentionPolicy.RUNTIME)   
 @Documented
 public @interface FruitProvider {   
     /**   
      * 供應商編號   
      * @return   
      */
     public int id() default -1;   
            
     /**   
      * 供應商名稱   
      * @return   
      */
     public String name() default "";   
            
     /**   
      * 供應商地址   
      * @return   
      */
     public String address() default "";   
 }

定義了注解,並在需要的時候給相關類,類屬性加上注解信息,如果沒有響應的注解信息處理流程,注解可以說是沒有實用價值。如何讓注解真真的發揮作用,主要就在於注解處理方法,下一步我們將學習注解信息的獲取和處理!

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved