注解學(xué)習(xí)筆記

元注解:

元注解的作用就是負責注解其他注解。Java5.0定義了4個標準的meta-annotation類型提佣,它們被用來提供對其它 annotation類型作說明。Java5.0定義的元注解:
    1.@Target,
    2.@Retention,
    3.@Documented,
    4.@Inherited
  這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個元注解的作用和相應(yīng)分參數(shù)的使用說明。


@Target:

@Target說明了Annotation所修飾的對象范圍:Annotation可被用于 packages桥滨、types(類、接口弛车、枚舉齐媒、Annotation類型)、類型成員(方法纷跛、構(gòu)造方法喻括、成員變量、枚舉值)贫奠、方法參數(shù)和本地變量(如循環(huán)變量双妨、catch參數(shù))。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標叮阅。

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

 取值(ElementType)有:

1.CONSTRUCTOR:用于描述構(gòu)造器
    2.FIELD:用于描述域
    3.LOCAL_VARIABLE:用于描述局部變量
    4.METHOD:用于描述方法
    5.PACKAGE:用于描述包
    6.PARAMETER:用于描述參數(shù)
    7.TYPE:用于描述類、接口(包括注解類型) 或enum聲明

使用實例:

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

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}

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


  @Retention:

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

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

 取值(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應(yīng)該被作為被標注的程序成員的公共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的子類所繼承。類并不從它所實現(xiàn)的接口繼承annotation夫椭,方法并不從它所重載的方法繼承annotation掸掸。

當@Inherited annotation類型標注的annotation的Retention是RetentionPolicy.RUNTIME,則反射API增強了這種繼承性蹭秋。如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時扰付,反射代碼檢查將展開工作:檢查class和其父類,直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)仁讨,或者到達類繼承結(jié)構(gòu)的頂層羽莺。

實例代碼:

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


自定義注解:

使用@interface自定義注解時,自動繼承了java.lang.annotation.Annotation接口洞豁,由編譯程序自動完成其他細節(jié)盐固。在定義注解時,不能繼承其他的注解或接口丈挟。@interface用來聲明一個注解刁卜,其中的每一個方法實際上是聲明了一個配置參數(shù)。方法的名稱就是參數(shù)的名稱曙咽,返回值類型就是參數(shù)的類型(返回值類型只能是基本類型蛔趴、Class、String例朱、enum)孝情。可以通過default來聲明參數(shù)的默認值洒嗤。

定義注解格式:
  public @interface 注解名 {定義體}

注解參數(shù)的可支持數(shù)據(jù)類型:

1.所有基本數(shù)據(jù)類型(int,float,boolean,byte,double,char,long,short)
    2.String類型
    3.Class類型
    4.enum類型
    5.Annotation類型
    6.以上所有類型的數(shù)組

Annotation類型里面的參數(shù)該怎么設(shè)定:

第一,只能用public或默認(default)這兩個訪問權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認類型箫荡;   
  第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;  
  第三,如果只有一個參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號.例:下面的例子FruitName注解就只有一個參數(shù)成員。

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

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 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作為默認值是一種常用的做法婉弹。這個約束使得處理器很難表現(xiàn)一個元素的存在或缺失的狀態(tài)睬魂,因為每個注解的聲明中,所有元素都存在镀赌,并且都具有相應(yīng)的值氯哮,為了繞開這個約束,我們只能定義一些特殊的值商佛,例如空字符串或者負數(shù)喉钢,一次表示某個元素不存在,在定義注解時良姆,這已經(jīng)成為一個習(xí)慣用法肠虽。例如:

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;

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

注解處理器類庫(java.lang.reflect.AnnotatedElement):

Java使用Annotation接口來代表程序元素前面的注解,該接口是所有Annotation類型的父接口玛追。除此之外税课,Java在java.lang.reflect 包下新增了AnnotatedElement接口,該接口代表程序中可以接受注解的程序元素痊剖,該接口主要有如下幾個實現(xiàn)類:

Class:類定義
  Constructor:構(gòu)造器定義
  Field:累的成員變量定義
  Method:類的方法定義
  Package:類的包定義

java.lang.reflect 包下主要包含一些實現(xiàn)反射功能的工具類韩玩,實際上,java.lang.reflect 包所有提供的反射API擴充了讀取運行時Annotation信息的能力陆馁。當一個Annotation類型被定義為運行時的Annotation后找颓,該注解才能是運行時可見,當class文件被裝載時被保存在class文件中的Annotation才會被虛擬機讀取叮贩。
  AnnotatedElement 接口是所有程序元素(Class击狮、Method和Constructor)的父接口,所以程序通過反射獲取了某個類的AnnotatedElement對象之后益老,程序就可以調(diào)用該對象的如下四個個方法來訪問Annotation信息:

方法1:<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的彪蓬、指定類型的注解,如果該類型注解不存在捺萌,則返回null寞焙。
  方法2:Annotation[] getAnnotations():返回該程序元素上存在的所有注解。
  方法3:boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判斷該程序元素上是否包含指定類型的注解互婿,存在則返回true,否則返回false.
  方法4:Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注釋辽狈。與此接口中的其他方法不同慈参,該方法將忽略繼承的注釋。(如果沒有注釋直接存在于此元素上刮萌,則返回長度為零的一個數(shù)組驮配。)該方法的調(diào)用者可以隨意修改返回的數(shù)組;這不會對其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響。

一個簡單的注解處理器:

/***********注解聲明***************/

/**
 * 水果名稱注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}

/**
 * 水果顏色注解
 * @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;

}

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

/***********注解使用***************/

public class Apple {
    
    @FruitName("Apple")
    private String appleName;
    
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    
    @FruitProvider(id=1,name="陜西紅富士集團",address="陜西省西安市延安路89號紅富士大廈")
    private String appleProvider;
    
    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 setAppleProvider(String appleProvider) {
        this.appleProvider = appleProvider;
    }
    public String getAppleProvider() {
        return appleProvider;
    }
    
    public void displayName(){
        System.out.println("水果的名字是:蘋果");
    }
}

/***********注解處理器***************/

public class FruitInfoUtil {
    public static void getFruitInfo(Class<?> clazz){
        
        String strFruitName=" 水果名稱:";
        String strFruitColor=" 水果顏色:";
        String strFruitProvicer="供應(yīng)商信息:";
        
        Field[] fields = clazz.getDeclaredFields();
        
        for(Field field :fields){
            if(field.isAnnotationPresent(FruitName.class)){
                FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
                strFruitName=strFruitName+fruitName.value();
                System.out.println(strFruitName);
            }
            else if(field.isAnnotationPresent(FruitColor.class)){
                FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
                strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
                System.out.println(strFruitColor);
            }
            else if(field.isAnnotationPresent(FruitProvider.class)){
                FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
                strFruitProvicer=" 供應(yīng)商編號:"+fruitProvider.id()+" 供應(yīng)商名稱:"+fruitProvider.name()+" 供應(yīng)商地址:"+fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
    }
}

/***********輸出結(jié)果***************/
public class FruitRun {

    /**
     * @param args
     */
    public static void main(String[] args) {
        
        FruitInfoUtil.getFruitInfo(Apple.class);
        
    }

}

====================================
 水果名稱:Apple
 水果顏色:RED
 供應(yīng)商編號:1 供應(yīng)商名稱:陜西紅富士集團 供應(yīng)商地址:陜西省西安市延安路89號紅富士大廈

Java注解的基礎(chǔ)知識點(見下面導(dǎo)圖)基本都過了一遍壮锻,下一篇我們通過設(shè)計一個基于注解的簡單的ORM框架琐旁,來綜合應(yīng)用和進一步加深對注解的各個知識點的理解和運用。


25200814-475cf2f3a8d24e0bb3b4c442a4b44734.jpg
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末猜绣,一起剝皮案震驚了整個濱河市灰殴,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌掰邢,老刑警劉巖牺陶,帶你破解...
    沈念sama閱讀 212,884評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異辣之,居然都是意外死亡掰伸,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,755評論 3 385
  • 文/潘曉璐 我一進店門怀估,熙熙樓的掌柜王于貴愁眉苦臉地迎上來狮鸭,“玉大人,你說我怎么就攤上這事多搀∑缃叮” “怎么了?”我有些...
    開封第一講書人閱讀 158,369評論 0 348
  • 文/不壞的土叔 我叫張陵酗昼,是天一觀的道長廊谓。 經(jīng)常有香客問我,道長麻削,這世上最難降的妖魔是什么蒸痹? 我笑而不...
    開封第一講書人閱讀 56,799評論 1 285
  • 正文 為了忘掉前任,我火速辦了婚禮呛哟,結(jié)果婚禮上叠荠,老公的妹妹穿的比我還像新娘。我一直安慰自己扫责,他們只是感情好榛鼎,可當我...
    茶點故事閱讀 65,910評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著鳖孤,像睡著了一般者娱。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上苏揣,一...
    開封第一講書人閱讀 50,096評論 1 291
  • 那天黄鳍,我揣著相機與錄音,去河邊找鬼平匈。 笑死框沟,一個胖子當著我的面吹牛藏古,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播忍燥,決...
    沈念sama閱讀 39,159評論 3 411
  • 文/蒼蘭香墨 我猛地睜開眼拧晕,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了梅垄?” 一聲冷哼從身側(cè)響起厂捞,我...
    開封第一講書人閱讀 37,917評論 0 268
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎哎甲,沒想到半個月后蔫敲,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,360評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡炭玫,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,673評論 2 327
  • 正文 我和宋清朗相戀三年奈嘿,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片吞加。...
    茶點故事閱讀 38,814評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡裙犹,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出衔憨,到底是詐尸還是另有隱情叶圃,我是刑警寧澤,帶...
    沈念sama閱讀 34,509評論 4 334
  • 正文 年R本政府宣布践图,位于F島的核電站掺冠,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏码党。R本人自食惡果不足惜德崭,卻給世界環(huán)境...
    茶點故事閱讀 40,156評論 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望揖盘。 院中可真熱鬧眉厨,春花似錦、人聲如沸兽狭。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,882評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽箕慧。三九已至服球,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間颠焦,已是汗流浹背斩熊。 一陣腳步聲響...
    開封第一講書人閱讀 32,123評論 1 267
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留蒸健,地道東北人座享。 一個月前我還...
    沈念sama閱讀 46,641評論 2 362
  • 正文 我出身青樓,卻偏偏與公主長得像似忧,于是被迫代替她去往敵國和親渣叛。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,728評論 2 351

推薦閱讀更多精彩內(nèi)容