java自定義注解

深入理解Java：注解（Annotation）自定義注解入門

  • 要深入學(xué)習(xí)注解，我們就必須能定義自己的注解，并使用注解，在定義自己的注解之前，我們就必須要了解Java為我們提供的元注解和相關(guān)定義注解的語(yǔ)法。

元注解：

  • 解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型，它們被用來(lái)提供對(duì)其它 annotation類型作說(shuō)明。Java5.0定義的元注解：
    • .@Target,
    • 2.@Retention,
    • 3.@Documented,
    • 4.@Inherited

這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個(gè)元注解的作用和相應(yīng)分參數(shù)的使用說(shuō)明。

@Target：

  • @Target說(shuō)明了Annotation所修飾的對(duì)象范圍：Annotation可被用于 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構(gòu)造方法、成員變量、枚舉值）、方法參數(shù)和本地變量（如循環(huán)變量、catch參數(shù)）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)。

  • 作用：用于描述注解的使用范圍（即：被描述的注解可以用在什么地方）

  • 取值(ElementType)有：

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

使用實(shí)例：

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

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

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

@Retention：

==========================

  • @Retention定義了該Annotation被保留的時(shí)間長(zhǎng)短：某些Annotation僅出現(xiàn)在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略，而另一些在class被裝載時(shí)將被讀取（請(qǐng)注意并不影響class的執(zhí)行，因?yàn)锳nnotation與class在使用上是被分離的）。使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制。

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

  • 取值（RetentionPoicy）有：

    • 1.SOURCE:在源文件中有效（即源文件保留）
    • 2.CLASS:在class文件中有效（即class保留）
    • 3.RUNTIME:在運(yùn)行時(shí)有效（即運(yùn)行時(shí)保留）

  • Retention meta-annotation類型有唯一的value作為成員，它的取值來(lái)自java.lang.annotation.RetentionPolicy的枚舉類型值。具體實(shí)例如下：

@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,這樣注解處理器可以通過(guò)反射，獲取到該注解的屬性值，從而去做一些運(yùn)行時(shí)的邏輯處理

@Documented:

  • @Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個(gè)標(biāo)記注解，沒(méi)有成員。
@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 元注解是一個(gè)標(biāo)記注解，@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class，則這個(gè)annotation將被用于該class的子類。

  • 注意：@Inherited annotation類型是被標(biāo)注過(guò)的class的子類所繼承。類并不從它所實(shí)現(xiàn)的接口繼承annotation，方法并不從它所重載的方法繼承annotation。

  • 當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強(qiáng)了這種繼承性。如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí)，反射代碼檢查將展開(kāi)工作：檢查class和其父類，直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)，或者到達(dá)類繼承結(jié)構(gòu)的頂層。

  • 實(shí)例代碼：

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

自定義注解：

  • 使用@interface自定義注解時(shí)，自動(dòng)繼承了java.lang.annotation.Annotation接口，由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí)，不能繼承其他的注解或接口。@interface用來(lái)聲明一個(gè)注解，其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱，返回值類型就是參數(shù)的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過(guò)default來(lái)聲明參數(shù)的默認(rèn)值。
  • 定義注解格式：

public @interface 注解名 {定義體}
  • 注解參數(shù)的可支持?jǐn)?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或默認(rèn)(default)這兩個(gè)訪問(wèn)權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型；
  • 第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;
  • 第三,如果只有一個(gè)參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號(hào).例:下面的例子FruitName注解就只有一個(gè)參數(shù)成員。

簡(jiǎn)單的自定義注解和使用注解實(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 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("水果的名字是：蘋(píng)果");
    }
}

注解元素的默認(rèn)值：

注解元素必須有確定的值，要么在定義注解的默認(rèn)值中指定，要么在使用注解時(shí)指定，非基本類型的注解元素的值不可為null。因此, 使用空字符串或0作為默認(rèn)值是一種常用的做法。這個(gè)約束使得處理器很難表現(xiàn)一個(gè)元素的存在或缺失的狀態(tài)，因?yàn)槊總€(gè)注解的聲明中，所有元素都存在，并且都具有相應(yīng)的值，為了繞開(kāi)這個(gè)約束，我們只能定義一些特殊的值，例如空字符串或者負(fù)數(shù)，一次表示某個(gè)元素不存在，在定義注解時(shí)，這已經(jīng)成為一個(gè)習(xí)慣用法。例如：

 1 package annotation;
 2 
 3 import java.lang.annotation.Documented;
 4 import java.lang.annotation.ElementType;
 5 import java.lang.annotation.Retention;
 6 import java.lang.annotation.RetentionPolicy;
 7 import java.lang.annotation.Target;
 8 
 9 /**
10  * 水果供應(yīng)者注解
11  * @author peida
12  *
13  */
14 @Target(ElementType.FIELD)
15 @Retention(RetentionPolicy.RUNTIME)
16 @Documented
17 public @interface FruitProvider {
18     /**
19      * 供應(yīng)商編號(hào)
20      * @return
21      */
22     public int id() default -1;
23     
24     /**
25      * 供應(yīng)商名稱
26      * @return
27      */
28     public String name() default "";
29     
30     /**
31      * 供應(yīng)商地址
32      * @return
33      */
34     public String address() default "";
35 }
  • 定義了注解，并在需要的時(shí)候給相關(guān)類，類屬性加上注解信息，如果沒(méi)有響應(yīng)的注解信息處理流程，注解可以說(shuō)是沒(méi)有實(shí)用價(jià)值。如何讓注解真真的發(fā)揮作用，主要就在于注解處理方法，下一步我們將學(xué)習(xí)注解信息的獲取和處理！
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

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

  • 在很多框架中都使用了自定義注解，之前在項(xiàng)目中也用到了自定義注解來(lái)對(duì)代碼做一些解耦，今天就給大家介紹下自定義注解的使...
    monkey01閱讀 5,938評(píng)論 1贊 8
  • 一 簡(jiǎn)介注解是Java 1.5引入的，可以提供代碼的額外信息，目前正在被廣泛應(yīng)用。除了Java內(nèi)置注解，我們也可以...
    Diffey閱讀 9,818評(píng)論 1贊 11
  • 什么是注解（Annotation）：Annotation（注解）就是Java提供了一種元程序中的元素關(guān)聯(lián)任何信息和...
    九尾喵的薛定諤閱讀 3,216評(píng)論 0贊 2
  • 本文章涉及代碼已放到github上annotation-study 1.Annotation為何而來(lái) What：A...
    zlcook閱讀 29,284評(píng)論 15贊 116
  • 今天是清明節(jié)，王曉樺失戀了。 他在街上走著，不知道要去哪兒。昨晚喝了太多酒，腦袋到現(xiàn)在還漲漲的。 他抬頭看天，是綠...
    鹿在鳴閱讀 387評(píng)論 0贊 0