當(dāng)前位置：首頁 > 编程语言 > java >内容正文

java

深入理解Java：注解

發(fā)布時間：2024/1/17 java 28 豆豆

生活随笔收集整理的這篇文章主要介紹了深入理解Java：注解小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.

注解作用：每當(dāng)你創(chuàng)建描述符性質(zhì)的類或者接口時,一旦其中包含重復(fù)性的工作，就可以考慮使用注解來簡化與自動化該過程。

Java提供了四種元注解，專門負(fù)責(zé)新注解的創(chuàng)建工作。

元注解

　　元注解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個標(biāo)準(zhǔn)的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可更加明晰其修飾的目標(biāo)。

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

　　取值(ElementType)有：

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

使用示例：

/***** 實體注解接口*/ @Target(value = {ElementType.TYPE}) @Retention(value = RetentionPolicy.RUNTIME) public @interface Entity {/**** 實體默認(rèn)firstLevelCache屬性為false* @return boolean*/boolean firstLevelCache() default false;/**** 實體默認(rèn)secondLevelCache屬性為false* @return boolean*/boolean secondLevelCache() default true;/**** 表名默認(rèn)為空* @return String*/String tableName() default "";/**** 默認(rèn)以""分割注解*/String split() default ""; }

@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:在運行時有效（即運行時保留）

使用示例：

/**** 字段注解接口*/ @Target(value = {ElementType.FIELD})//注解可以被添加在屬性上 @Retention(value = RetentionPolicy.RUNTIME)//注解保存在JVM運行時刻,能夠在運行時刻通過反射API來獲取到注解的信息 public @interface Column {String name();//注解的name屬性 }

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

@Documented

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

@Inherited

　　@Inherited 元注解是一個標(biāo)記注解，@Inherited闡述了某個被標(biāo)注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用于一個class，則這個annotation將被用于該class的子類。

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

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

自定義注解

　　使用@interface自定義注解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細(xì)節(jié)。在定義注解時，不能繼承其他的注解或接口。@interface用來聲明一個注解，其中的每一個方法實際上是聲明了一個配置參數(shù)。方法的名稱就是參數(shù)的名稱，返回值類型就是參數(shù)的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數(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)這兩個訪問權(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;　　
　　第三,如果只有一個參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號.例:下面的例子FruitName注解就只有一個參數(shù)成員。

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

示例1：

/****主鍵注解接口*/ @Target(value = {ElementType.FIELD}) @Retention(value = RetentionPolicy.RUNTIME) public @interface Id { }

示例2：

/**屬性不需要被持久化注解**/ @Target(value = {ElementType.FIELD}) @Retention(value = RetentionPolicy.RUNTIME) @Documented public @interface Transient { }

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

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

定義了注解，并在需要的時候給相關(guān)類，類屬性加上注解信息，如果沒有響應(yīng)的注解信息處理流程，注解可以說是沒有實用價值。如何讓注解真真的發(fā)揮作用，主要就在于注解處理方法，下一步我們將學(xué)習(xí)注解信息的獲取和處理！

如果沒有用來讀取注解的方法和工作，那么注解也就不會比注釋更有用處了。使用注解的過程中，很重要的一部分就是創(chuàng)建于使用注解處理器。Java SE5擴展了反射機制的API，以幫助程序員快速的構(gòu)造自定義注解處理器。

注解處理器類庫(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信息的能力。當(dāng)一個Annotation類型被定義為運行時的Annotation后，該注解才能是運行時可見，當(dāng)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)用和進一步加深對注解的各個知識點的理解和運用。

參考：

深入理解Java：注解（Annotation）--注解處理器