Java 注解（Annotation）

前言

注解是 Java 5 的一個新特性。注解是插入你代碼中的一種注釋或者說是一種元數(shù)據(jù)（meta data）。這些注解信息可以在編譯期使用預編譯工具進行處理（pre-compiler tools），也可以在運行期使用 Java 反射機制進行處理。

現(xiàn)在注解在越來越多的地方用到，在Android中非常著名的網(wǎng)絡請求框架 Retrofit 就是利用注解和動態(tài)代理很大程度上簡化了網(wǎng)絡請求的代碼。

元注解

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

1. @Target,
　　　2. @Retention,
　　　3. @Documented,
　　　4. @Inherited

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

@Target

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

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

取值(ElementType)有：

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

@Retention：

@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現(xiàn)在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機忽略，而另一些在class被裝載時將被讀?。ㄕ堊⒁獠⒉挥绊慶lass的執(zhí)行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。

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

取值（RetentionPoicy）有：

1. SOURCE : 在源文件中有效（即源文件保留）
　　　　2. CLASS : 在class文件中有效（即class保留）
　　　　3. RUNTIME : 在運行時有效（即運行時保留）

@Documented:

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

@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)，或者到達類繼承結構的頂層。

自定義注解

使用@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ù)該怎么設定:
　　第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為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ù)名稱設為"value",后加小括號.例:下面的例子FruitName注解就只有一個參數(shù)成員。

注解元素的默認值：

注解元素必須有確定的值，要么在定義注解的默認值中指定，要么在使用注解時指定，非基本類型的注解元素的值不可為null。因此, 使用空字符串或0作為默認值是一種常用的做法。這個約束使得處理器很難表現(xiàn)一個元素的存在或缺失的狀態(tài)，因為每個注解的聲明中，所有元素都存在，并且都具有相應的值，為了繞開這個約束，我們只能定義一些特殊的值，例如空字符串或者負數(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("水果的名字是：蘋果");
    }
}

Android內置注解

作為android程序員，我們還是了解一下android中自帶的注解，以及用法含義。

@SuppressLint： 指示lint檢查時忽略注解元素的警告信息。
　　@TargetApi:指示lint把當前這個注解元素的target api為指定值，而不是項目設置的target api。
　　@NonNull:表示一個成員變量，或者參數(shù)，或者方法返回值永遠不能為NULL。
　　@Nullable:標識一個成員變量，或者參數(shù)，方法返回值，可以為NULL。

參考

[深入理解Java：注解（Annotation）自定義注解入門] (http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html)

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容