




已閱讀5頁,還剩8頁未讀, 繼續(xù)免費閱讀
版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領
文檔簡介
Java Annotation入門 收藏 在開發(fā)Java代碼的時候,我們總是習慣于利用注釋來表達代碼中無法放置的一些東西,其中一些內容被JavaDoc用來產生幫助文檔。只有幫助文檔還是不夠的,在越來越多的情況下,注釋中的標記用來表達更多的含義。例如,在使用了xDoclet工具的項目中,特殊用途的各種xDoclet標記用于生成新的代碼和對應的配置文件, Hibernate也是借助于hibernate開頭的xDocle來生成代碼和文件的。在更多的情況下,單純在代碼中利用注釋部分添加標記的做法也顯得不夠用了,這時候我們通常會使用Java的屬性文件或一個在名稱或配置上相對應的XML文件來增加描述的能力。在Hiberanate中,使用了與名稱相對應的hbm映射文件。這些方式一方面使部分重復的工作自動化了,另一方面也使程序員的維護負擔加重了。原本只需要專注于代碼的工作被不同類型的標記和配置文件分了,而且一個項目中往往要同時照顧各種的文件。 J2SE 5.0增加的元數據功能使我們可以不必再把那些感興趣的信息放在帶“*“的注釋后面藏起來了。元數據實際上是在代碼中添加注釋的方法。J2SE 5O給出了一些注釋,但更重要的是J2SE 5.0設計支持了一種新的類型:注釋(Annotation)。開發(fā)者可以自己開發(fā)實現自己需求的注釋,然后支持其他程序在代碼中使用這些注釋,利用注釋,程序員可以把標準化的信息公開地寫在代碼中。J2SE 5.0的元數據目前為各種開發(fā)標準所支持,例如EJB 3o標準就是完全基于J2SE 5.0的元數據功能的。一改EJB 21之前版本的復雜性,利用元數據使開發(fā)過程簡捷了,代碼也易讀了很多。上面這兩段引用看來在Java 編程方面一個新的趨勢是使用元數據。簡單地說,元數據就是關于數據的數據。元數據可以用于創(chuàng)建文檔,跟蹤代碼中的依賴性,甚至執(zhí)行基本編譯時檢查。許多元數據工具,如開源工具XDoclet,這些功能已經添加到了核心Java 語言中。 現在關于這方面的資料網上還是不少啊,感覺下面轉載的cleverpig的這篇文章對于剛接觸JDK5.0新特性Annotation是個很好的入門,感謝作者為我們提供了這么好的學習資料。(轉載)摘要:本文針對java初學者或者annotation初次使用者全面地說明了annotation的使用方法、定義方式、分類。初學者可以通過以上的說明制作簡單的annotation程序,但是對于一些高級的annotation應用(例如使用自定義annotation生成javabean映射xml文件)還需要進一步的研究和探討。涉及到深入annotation的內容,作者將在后文Java Annotation高級應用中談到。同時,annotation運行存在兩種方式:運行時、編譯時。上文中討論的都是在運行時的annotation應用,但在編譯時的annotation應用還沒有涉及,一、為什么使用Annotation:在JAVA應用中,我們常遇到一些需要使用模版代碼。例如,為了編寫一個JAX-RPC web service,我們必須提供一對接口和實現作為模版代碼。如果使用annotation對遠程訪問的方法代碼進行修飾的話,這個模版就能夠使用工具自動生成。另外,一些API需要使用與程序代碼同時維護的附屬文件。例如,JavaBeans需要一個BeanInfo Class與一個Bean同時使用/維護,而EJB則同樣需要一個部署描述符。此時在程序中使用annotation來維護這些附屬文件的信息將十分便利而且減少了錯誤。二、Annotation工作方式:在5.0版之前的Java平臺已經具有了一些ad hoc annotation機制。比如,使用transient修飾符來標識一個成員變量在序列化子系統(tǒng)中應被忽略。而deprecated這個javadoc tag也是一個ad hoc annotation用來說明一個方法已過時。從Java5.0版發(fā)布以來,5.0平臺提供了一個正式的annotation功能:允許開發(fā)者定義、使用自己的annoatation類型。此功能由一個定義annotation類型的語法和一個描述annotation聲明的語法,讀取annotaion的API,一個使用annotation修飾的class文件,一個annotation處理工具(apt)組成。annotation并不直接影響代碼語義,但是它能夠工作的方式被看作類似程序的工具或者類庫,它會反過來對正在運行的程序語義有所影響。annotation可以從源文件、class文件或者以在運行時反射的多種方式被讀取。當然annotation在某種程度上使javadoc tag更加完整。一般情況下,如果這個標記對java文檔產生影響或者用于生成java文檔的話,它應該作為一個javadoc tag;否則將作為一個annotation。三、Annotation使用方法:1。類型聲明方式:通常,應用程序并不是必須定義annotation類型,但是定義annotation類型并非難事。Annotation類型聲明于一般的接口聲明極為類似,區(qū)別只在于它在interface關鍵字前面使用“”符號。annotation類型的每個方法聲明定義了一個annotation類型成員,但方法聲明不必有參數或者異常聲明;方法返回值的類型被限制在以下的范圍:primitives、String、Class、enums、annotation和前面類型的數組;方法可以有默認值。下面是一個簡單的annotation類型聲明:清單1:/* * Describes the Request-For-Enhancement(RFE) that led * to the presence of the annotated API element. */public interface RequestForEnhancement intid();String synopsis();String engineer() default unassigned; String date();default unimplemented; 代碼中只定義了一個annotation類型RequestForEnhancement。2。修飾方法的annotation聲明方式:annotation是一種修飾符,能夠如其它修飾符(如public、static、final)一般使用。習慣用法是annotaions用在其它的修飾符前面。annotations由“+annotation類型+帶有括號的成員-值列表”組成。這些成員的值必須是編譯時常量(即在運行時不變)。A:下面是一個使用了RequestForEnhancement annotation的方法聲明:清單2:RequestForEnhancement(id = 2868724,synopsis = Enable time-travel,engineer = Mr. Peabody,date = 4/1/3007)public static void travelThroughTime(Date destination) . B:當聲明一個沒有成員的annotation類型聲明時,可使用以下方式:清單3:/* * Indicates that the specification of the annotated API element * is preliminary and subject to change. */public interface Preliminary 作為上面沒有成員的annotation類型聲明的簡寫方式:清單4:Preliminary public class TimeTravel . C:如果在annotations中只有唯一一個成員,則該成員應命名為value:清單5:/* * Associates a copyright notice with the annotated API element. */public interface Copyright String value();更為方便的是對于具有唯一成員且成員名為value的annotation(如上文),在其使用時可以忽略掉成員名和賦值號(=):清單6:Copyright(2002 Yoyodyne Propulsion Systems)public class OscillationOverthruster . 3。一個使用實例:結合上面所講的,我們在這里建立一個簡單的基于annotation測試框架。首先我們需要一個annotation類型來表示某個方法是一個應該被測試工具運行的測試方法。清單7:import java.lang.annotation.*;/* * Indicates that the annotated method is a test method. * This annotation should be used only on parameterless static methods. */Retention(RetentionPolicy.RUNTIME)Target(ElementType.METHOD)public interface Test 值得注意的是annotaion類型聲明是可以標注自己的,這樣的annotation被稱為“meta-annotations”。在上面的代碼中,Retention(RetentionPolicy.RUNTIME)這個meta-annotation表示了此類型的annotation將被虛擬機保留使其能夠在運行時通過反射被讀取。而Target(ElementType.METHOD)表示此類型的annotation只能用于修飾方法聲明。下面是一個簡單的程序,其中部分方法被上面的annotation所標注:清單8:public class Foo Test public static void m1() public static void m2() Test public static void m3() throw new RuntimeException(Boom);public static void m4() Test public static void m5() public static void m6() Test public static void m7() throw new RuntimeException(Crash);public static void m8() Here is the testing tool:import java.lang.reflect.*;public class RunTests public static void main(String args) throws Exception int passed = 0, failed = 0;for (Method m : Class.forName(args0).getMethods() if (m.isAnnotationPresent(Test.class) try m.invoke(null); passed+; catch (Throwable ex) System.out.printf(Test %s failed: %s %n, m, ex.getCause(); failed+; System.out.printf(Passed: %d, Failed %d%n, passed, failed); 這個程序從命令行參數中取出類名,并且遍歷此類的所有方法,嘗試調用其中被上面的測試annotation類型標注過的方法。在此過程中為了找出哪些方法被annotation類型標注過,需要使用反射的方式執(zhí)行此查詢。如果在調用方法時拋出異常,此方法被認為已經失敗,并打印一個失敗報告。最后,打印運行通過/失敗的方法數量。下面文字表示了如何運行這個基于annotation的測試工具:清單9:$ java RunTests FooTest public static void Foo.m3() failed: java.lang.RuntimeException: Boom Test public static void Foo.m7() failed: java.lang.RuntimeException: Crash Passed: 2, Failed 2四、Annotation分類:根據annotation的使用方法和用途主要分為以下幾類:1。內建AnnotationJava5.0版在java語法中經常用到的內建Annotation:Deprecated用于修飾已經過時的方法;Override用于修飾此方法覆蓋了父類的方法(而非重載);SuppressWarnings用于通知java編譯器禁止特定的編譯警告。下面代碼展示了內建Annotation類型的用法:清單10:package com.bjinfotech.practice.annotation;/* * 演示如何使用java5內建的annotation * 參考資料: * /docs/books/tutorial/java/javaOO/annotations.html * /j2se/1.5.0/docs/guide/language/annotations.html * /jgloss/annotations.html * author cleverpig * */import java.util.List;public class UsingBuiltInAnnotation /食物類class Food/干草類class Hay extends Food/動物類class AnimalFood getFood()return null;/使用Annotation聲明Deprecated方法Deprecatedvoid deprecatedMethod()/馬類-繼承動物類class Horse extends Animal/使用Annotation聲明覆蓋方法OverrideHay getFood()return new Hay();/使用Annotation聲明禁止警告SuppressWarnings(deprecation,unchecked)void callDeprecatedMethod(List horseGroup)Animal an=new Animal();an.deprecatedMethod();horseGroup.add(an);2。開發(fā)者自定義Annotation:由開發(fā)者自定義Annotation類型。下面是一個使用annotation進行方法測試的sample:AnnotationDefineForTestFunction類型定義如下:清單11:package com.bjinfotech.practice.annotation;import java.lang.annotation.*;/* * 定義annotation * author cleverpig * */加載在VM中,在運行時進行映射Retention(RetentionPolicy.RUNTIME)/限定此annotation只能標示方法Target(ElementType.METHOD)public interface AnnotationDefineForTestFunction測試annotation的代碼如下:清單12:package com.bjinfotech.practice.annotation;import java.lang.reflect.*;/* * 一個實例程序應用前面定義的Annotation:AnnotationDefineForTestFunction * author cleverpig * */public class UsingAnnotation AnnotationDefineForTestFunction public static void method01()public static void method02()AnnotationDefineForTestFunction public static void method03()throw new RuntimeException(method03);public static void method04()throw new RuntimeException(method04);public static void main(String argv) throws Exceptionint pas
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
- 4. 未經權益所有人同意不得將文件中的內容挪作商業(yè)或盈利用途。
- 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
- 6. 下載文件中如有侵權或不適當內容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 暗管布線施工方案
- 砂巖整改施工方案
- 防火防毒施工方案
- 零售業(yè)務中介協(xié)議
- 家具定制環(huán)境友好材料協(xié)議
- 充電樁網絡建設項目實施方案(參考范文)
- 城鎮(zhèn)污泥處理設施工程規(guī)劃設計方案(參考范文)
- 避難場所標識工程可行性研究報告(僅供參考)
- 2025至2030年中國取暖爐行業(yè)投資前景及策略咨詢報告
- 2025年牛肉豆酥項目可行性研究報告
- 2023版毛概課后答案
- T∕CEEMA 003-2022 煤電機組鍋爐節(jié)能、供熱和靈活性改造技術導則
- (完整word版)環(huán)境監(jiān)測第四版奚旦立
- 歷史小劇場《萬隆會議》劇本
- 設備(材料)供應招標文件范本
- 國家開放大學《社區(qū)護理學(本)》形考任務1-5參考答案
- 220千伏線路無人機放線施工組織設計
- (完整版)培訓學校電話話術(初中)
- 注塑模具標準成型條件表
- 施工進度計劃網絡圖及橫道圖
- 大貓英語分級閱讀 二級2 Let's go shopping 課件
評論
0/150
提交評論