Java 注解学习笔记
生活随笔
收集整理的這篇文章主要介紹了
Java 注解学习笔记
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
轉自:http://wanqiufeng.blog.51cto.com/409430/458883
一、什么是java注解
注解,顧名思義,注解,就是對某一事物進行添加注釋說明,會存放一些信息,這些信息可能對以后某個時段來說是很有用處的。 Java注解又叫java標注,java提供了一套機制,使得我們可以對方法、類、參數、包、域以及變量等添加標準(即附上某些信息)。且在以后某個時段通過反射將標注的信息提取出來以供使用。二、自定義Java標注
1 為什么要自定義注解
Java從1.5版本以后默認內置三個標注:
但是,僅僅這三個標注是不能滿足我們開發時一些需求的。所以java允許我們自定義注解來使用。
2 如何自定義注解
自定義步驟大致分為兩步:
問題來了,什么是元注解?
3 什么是元注解
元注解,就是定義注解的注解,也就是說這些元注解是的作用就是專門用來約束其它注解的注解。
請區別上面那三個注解,他們也是通過元注解定義而來的。
元注解有哪些呢,主要有四個@Target,@Retention,@Documented,@Inherited?
1 元注解有:@Target,@Retention,@Documented,@Inherited 2 3 @Target 表示該注解用于什么地方,可能的 ElemenetType 參數包括: 4 ElemenetType.CONSTRUCTOR 構造器聲明 5 ElemenetType.FIELD 域聲明(包括 enum 實例) 6 ElemenetType.LOCAL_VARIABLE 局部變量聲明 7 ElemenetType.METHOD 方法聲明 8 ElemenetType.PACKAGE 包聲明 9 ElemenetType.PARAMETER 參數聲明 10 ElemenetType.TYPE 類,接口(包括注解類型)或enum聲明 11 12 @Retention 表示在什么級別保存該注解信息。可選的 RetentionPolicy 參數包括: 13 RetentionPolicy.SOURCE 注解將被編譯器丟棄 14 RetentionPolicy.CLASS 注解在class文件中可用,但會被VM丟棄 15 RetentionPolicy.RUNTIME VM將在運行期也保留注釋,因此可以通過反射機制讀取注解的信息。 16 17 @Documented 將此注解包含在 javadoc 中 18 19 @Inherited 允許子類繼承父類中的注解
4 自定義及使用注解示例
自定義一個類級別的標注Description
1 package lighter.javaeye.com; 2 import java.lang.annotation.Documented; 3 import java.lang.annotation.ElementType; 4 import java.lang.annotation.Retention; 5 import java.lang.annotation.RetentionPolicy; 6 import java.lang.annotation.Target; 7 8 @Target(ElementType.TYPE)//這個標注應用于類 9 @Retention(RetentionPolicy.RUNTIME)//標注會一直保留到運行時 10 @Documented//將此注解包含在javadoc中 11 public @interface Description { 12 String value(); 13 }再定義個方法級別的注解Name
1 package lighter.javaeye.com; 2 import java.lang.annotation.Documented; 3 import java.lang.annotation.ElementType; 4 import java.lang.annotation.Retention; 5 import java.lang.annotation.RetentionPolicy; 6 import java.lang.annotation.Target; 7 8 //注意這里的@Target與@Description里的不同,參數成員也不同 9 @Target(ElementType.METHOD) 10 @Retention(RetentionPolicy.RUNTIME) 11 @Documented 12 public @interface Name { 13 String originate(); 14 String community(); 15 }然后使用以上兩個注解
1 package lighter.javaeye.com; 2 3 @Description(value="javaeye,做最棒的軟件開發交流社區") 4 public class JavaEyer { 5 @Name(originate="創始人:robbin",community="javaEye") 6 public String getName() 7 { 8 return null; 9 } 10 11 @Name(originate="創始人:江南白衣",community="springside") 12 public String getName2() 13 { 14 return "借用兩位的id一用,寫這一個例子,請見諒!"; 15 } 16 } 17 18 說明:其中標注“@Description(value="javaeye,做最棒的軟件開發交流社區")”,可以寫成“@Description("javaeye,做最棒的軟件開發交流社區") ”,結果也是一樣的。因為Description標注定義的時候其參數(或者說屬性)為value。
而value比較特殊,它在被指定參數的時候可以不用顯示的寫出來。
當然如果定義的時候參數名不是value而是其它的比如des,那么使用注解的時候,必須顯示寫出參數名,然后再賦值:@Description(Des=”xxx”)*/
提取出注解的信息
1 package lighter.javaeye.com; 2 3 import java.lang.reflect.Method; 4 import java.util.HashSet; 5 import java.util.Set; 6 7 public class TestAnnotation { 8 /** 9 * author lighter 10 * 說明:具體關天Annotation的API的用法請參見javaDoc文檔 11 */ 12 public static void main(String[] args) throws Exception { 13 String CLASS_NAME = "lighter.javaeye.com.JavaEyer"; 14 Class test = Class.forName(CLASS_NAME); 15 Method[] method = test.getMethods(); 16 boolean flag = test.isAnnotationPresent(Description.class); 17 if(flag) 18 { 19 Description des = (Description)test.getAnnotation(Description.class); 20 System.out.println("描述:"+des.value()); 21 System.out.println("-----------------"); 22 } 23 24 //把JavaEyer這一類有利用到@Name的全部方法保存到Set中去 25 Set<Method> set = new HashSet<Method>(); 26 for(int i=0;i<method.length;i++) 27 { 28 boolean otherFlag = method[i].isAnnotationPresent(Name.class); 29 if(otherFlag) set.add(method[i]); 30 } 31 for(Method m: set) 32 { 33 Name name = m.getAnnotation(Name.class); 34 System.out.println(name.originate()); 35 System.out.println("創建的社區:"+name.community()); 36 } 37 } 38 } 注意事項: 所有的Annotation會自動繼承java.lang.annotation這一個接口,所以不能再去繼承別的類或是接口. ??? 最重要的一點,Annotation類型里面的參數該怎么設定: ?? ?第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為defaul默認類型. ?? ?第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String,Enum,Class,annotations等數據類型, 以及這一些類型的數組.例如,String value();這里的參數成員就為String. 參考資料:?http://www.javaeye.com/topic/36659# http://www.javaeye.com/topic/400085?
轉載于:https://www.cnblogs.com/yaowukonga/archive/2013/03/28/2987002.html
總結
以上是生活随笔為你收集整理的Java 注解学习笔记的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 报废面包车多少钱啊?
- 下一篇: bilibili电视版叫什么?