Java中Annotation的使用

Annotation是Java五、6只後的新特徵（中文稱之爲註解），而且愈來愈多的獲得了應用，好比Spring、Hibernate三、Struts二、iBatis三、JPA、JUnit等等都獲得了普遍應用，經過使用註解，代碼的靈活性大大提升。

   這些都是使用別人定義的註解，通常註解的使用都是在一些基礎框架或者類庫中來定義的，所以不多見過有人本身去寫一個註解出來並使用在程序中，所以註解的使用經常給人感受很神祕，這就爲你揭開註解的面紗。

 

   註解的神祕之處在於：經過相似註釋的方式，能夠控制程序的一些行爲，運行時的狀態，能夠爲成員賦值，作配置信息等等，與常規編碼思惟截然不同。

   只用別人定義好的註解是搞不懂這些問題的，要想真正知道註解內部的祕密，要本身定義註解，而後在程序中獲取註解信息，拿到註解信息後，就能夠爲我所用了。

下面我簡單演示下三類註解的用法：類註解、方法註解、字段（也稱之域）註解的定義與適用，並看看如何獲取註解的信息。

1、定義註解

package lavasoft.anntest; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 類註解 * * @author leizhimin 2009-12-18 14:15:46 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface MyAnnotation4Class { public String msg(); }

package lavasoft.anntest; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 方法註解 * * @author leizhimin 2009-12-18 14:16:05 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface MyAnnotation4Method { public String msg1(); public String msg2(); }

package lavasoft.anntest; 

import java.lang.annotation.ElementType; 
import java.lang.annotation.Retention; 
import java.lang.annotation.RetentionPolicy; 
import java.lang.annotation.Target; 

/** 
* 字段註解 
* 
* @author leizhimin 2009-12-18 15:23:12 
*/ 
@Retention(RetentionPolicy.RUNTIME) 
@Target(ElementType.FIELD) 
public @interface MyAnnotation4Field { 
        public String commont(); 

        public boolean request(); 
}

2、寫一個類，用上這些註解

package lavasoft.anntest; /** * 一個普通的Java類 */ @MyAnnotation4Class(msg = "測試類註解信息") class TestClass { @MyAnnotation4Field(commont = "成員變量的註解信息", request = true) private String testfield; @MyAnnotation4Method(msg1 = "測試方法註解信息1", msg2 = "測試方法註解信息2") public void testMethod() { System.out.println("Hello World！"); } }

3、測試註解

package lavasoft.anntest; 

import java.lang.reflect.Field; 
import java.lang.reflect.Method; 

/** 
* 測試類 
* 
* @author leizhimin 2009-12-18 14:13:02 
*/ 
public class TestOptAnnotation { 
        public static void main(String[] args) throws NoSuchMethodException, NoSuchFieldException { 
                TestClass t = new TestClass(); 
                System.out.println("-----------MyAnnotation4Class註解信息---------"); 
                MyAnnotation4Class an4clazz = t.getClass().getAnnotation(MyAnnotation4Class.class); 
                System.out.println(an4clazz.msg()); 
                System.out.println("-----------MyAnnotation4Method註解信息---------"); 
                Method method = t.getClass().getMethod("testMethod", new Class[0]); 
                MyAnnotation4Method an4method = method.getAnnotation(MyAnnotation4Method.class); 
                System.out.println(an4method.msg1()); 
                System.out.println(an4method.msg2()); 
                System.out.println("-----------MyAnnotation4Field註解信息---------"); 
                Field field = t.getClass().getDeclaredField("testfield"); 
                MyAnnotation4Field an4field = field.getAnnotation(MyAnnotation4Field.class); 
                System.out.println(an4field.commont()); 
                System.out.println(an4field.request()); 
        } 
}

運行結果：

-----------MyAnnotation4Class註解信息--------- 
測試類註解信息 
-----------MyAnnotation4Method註解信息--------- 
測試方法註解信息1 
測試方法註解信息2 
-----------MyAnnotation4Field註解信息--------- 
成員變量的註解信息 
true 

Process finished with exit code 

4、總結

 

看完上面的測試過程，Annotation已經再也不神祕了，這裏總結下自定義註解的使用方法：

 

一、自定義註解，注意註解的時空範圍，簡單說就是註解針對的目標（類、方法、字段），以及註解的時效（運行時、或者源碼中有效）。

 

二、要獲取註解的信息，必須經過Java的反射技術來獲取Annotation對象，由於你除此以外沒有別的獲取註解對象的方法。

 

三、獲取了註解對象，就能夠調用註解的方法來獲取相對應的值了。爲基礎框架所用。

 

四、固然，註解也能夠沒有定義成員，這樣註解就成了一個標記符號了。

 

理解了這些，註解就再也不神祕了。