1. 程式人生 > >javaee的幾個元註解

javaee的幾個元註解

元註解: 
  元註解的作用就是負責註解其他註解。Java5.0定義了4個標準的meta-annotation型別,它們被用來提供對其它 annotation型別作說明。Java5.0定義的元註解: 
    [email protected]
    [email protected]
    [email protected]
    [email protected] 
  這些型別和它們所支援的類在java.lang.annotation包中可以找到。下面我們看一下每個元註解的作用和相應分引數的使用說明。

    @Target:
  • 1
  • 2

   @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:
  • 1
  • 2

  @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型別被發現,或者到達類繼承結構的頂層。 
  例項程式碼: 
@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;

@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;

/** 
* 水果顏色註解 

*/ 
@Target(ElementType.FIELD) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented 
public @interface FruitColor { 
/** 
* 顏色列舉 

*/ 
public enum Color{ BULE,RED,GREEN};

/**
 * 顏色屬性
 * @return
 */
Color fruitColor() default Color.GREEN;
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6


複製程式碼 
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("水果的名字是:蘋果");
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28


複製程式碼 
註解元素的預設值: 
  註解元素必須有確定的值,要麼在定義註解的預設值中指定,要麼在使用註解時指定,非基本型別的註解元素的值不可為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;

/** 
* 水果供應者註解 

*/ 
@Target(ElementType.FIELD) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented 
public @interface FruitProvider { 
/** 
* 供應商編號 
* @return 
*/ 
public int id() default -1;

/** 
* 供應商名稱 
* @return 
*/ 
public String name() default “”;

複製程式碼 
定義了註解,並在需要的時候給相關類,類屬性加上註解資訊,如果沒有響應的註解資訊處理流程,註解可以說是沒有實用價值。如何讓註解真真的發揮作用,主要就在於註解資訊的獲取和處理!!!