今天稍稍學習了下註解，關於註解，我想大家都不陌生，目前可能在hibernate配置中可能會用的多一點，在JPA中也會用到。我想說的是學習註解可以幫助我們更好的理解註解在框架中（比如hibernate和Spirng等）的應用。

    Annotation是JDK5版本以來的新特性。目前在JavaSE中的學習中可能會經常遇到集合未指定泛型、使用java.util.Date類中的過時方法，編譯器給出warning時，均可以採用增加註解如(SuppressWarnings("unchecked"))，Deprecated等來消除警告，這樣看起來會好看些。

    學習Annotation涉及到的java類包含：java.lang.annotation.Annotation。所有定義的annotation均預設實現了Annotation介面，但是要注意的是，實現Annotation介面的類並不是annotation。

    java中的annotation中包含的註解型別有Documented，Inherited，Retention，Target，其中常用的有Inherited（子類可以繼承父類的註解），Retention（註解型別要保留多久，可否利用反射機制呼叫等），Target（註解的作用物件，類，介面，方法，屬性等）。定義註解的關鍵字為@interface，關於JDK1.6自帶的註解比如SuppressWarnings("unchecked"))，Deprecated等我就不介紹了，相信有一定基礎的都遇到過。

    相信在諸如hibernate和spring等框架中，我相信這些框架是使用反射讀取的註解及註解中的引數，根據這些註解和引數通過一定的邏輯來對業務進行控制的。

    下面開始自定義一個註解並講解使用，具體步驟為：

    定義註解->寫測試類->進行測試

一、定義註解：

註解一：AnnotationTest

@Retention(RetentionPolicy.RUNTIME) // 將Retention的值設定為RetentionPolicy.RUNTIME，這樣就可以在程式執行期間可以用反射對註解進行解析，設定為CLASS何SOURCE均不能
public @interface AnnotationTest {
 String value() default "good";
 String value1() default "hello";
 EnumTest value2(); //列舉型別
}
/**
 * 自定義列舉類
 *
 * @author XiaoYun 2013-07-20
 */
enum EnumTest {
 HELLO, world, welcome
}

註解二：

MyAnnotation.java
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * 自定義註解
 *
 * @author XiaoYun 2013-07-20
 */
@Retention(RetentionPolicy.CLASS)//將Retention的值設定為RetentionPolicy.CLASS，程式執行的時候就不能通過反射解析
public @interface MyAnnotation {
 String value() default "hello";
 String hello();
 String world();
}

測試類(這裡為了少寫一個類，就把測試方法和類放到了一個類中)：MyTest.java

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

@AnnotationTest(value1="hello", value2=EnumTest.world)
@MyAnnotation(world="world", hello="hello")
public class MyTest {
 
 @MyAnnotation(world="world", hello="hello")
 private String field;
 
 @AnnotationTest(value1="hello", value2=EnumTest.world)
 @MyAnnotation(value="xiaoyun", hello="hello", world="world")
 private void method() {  
  System.out.println("field的值為:" + field + "\nmethod from MyTest!");
 }
 
 @Override
 public String toString() {
  return "MyTest [field=" + field + "]";
 }

 /**
  * 測試方法
  * @param args
  */
 public static void main(String[] args) throws Exception {
  // 例項化物件
  MyTest test = new MyTest();
  // 獲取Class型別
  Class cls = MyTest.class;
  // 根據方法名獲取方法
  Method method = cls.getDeclaredMethod("method", null);
  // 獲取屬性
  Field field = cls.getDeclaredField("field");
  // 判斷如果該方法中包含有MyAnnotation型別的註解，則進行如下操作
  if (method.isAnnotationPresent(AnnotationTest.class)) {
   // 取消Java訪問性檢查
   field.setAccessible(true);
   method.setAccessible(true);
   // 給test物件上的field屬性賦值，並執行method方法
   field.set(test, "我是肖雲，大家好！");
   method.invoke(test, null);
   
   // 根據註解型別獲取特定的註解並列印到控制檯
   Annotation annotation = method.getAnnotation(AnnotationTest.class);
   System.out.println(annotation.annotationType() + "\n" + annotation.annotationType().getName());
  }
  
  // 獲取所有的註解並逐次迭代(這需要註解中Retention中的value為RetentionPolicy.Runntime)
  Annotation[] annotations = method.getAnnotations();
  if (annotations.length > 0) {
   System.out.println("------------列印所有註解--------------");
   for (Annotation annotation : annotations) {
    System.out.println(annotation.annotationType().getCanonicalName());
   }
  }
 }
}
    上面一個例子主要說明的是java.lang.annotation.Annotation介面中的Retention屬性(JVM是否保留註釋，是否可用反射讀取)TargetAnnotationDemo ，接下來第二個例子用到了剩下的三個屬性(Documented(不是重點，生成API文件時用),Target,Inherited)，下面開始介紹：

首先還是定義註解：

TargetAnnotationDemo.java

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

/**
 * @Target註解
 *
 * @author XiaoYun 2013-07-20
 */
@Target({ElementType.TYPE, ElementType.METHOD})  //程式型別的元素有類、介面、列舉型別；方法
@Retention(RetentionPolicy.RUNTIME) //執行時可用反射呼叫
@Inherited //子類可以繼承父類的註解
@Documented //生成doc文件時顯示該註解
public @interface TargetAnnotationDemo {
 String value() default "hello";
 String value1();
}

第二步，寫測試用例：

@TargetAnnotationDemo(value1 = "good")
public class TargetTest {
 @TargetAnnotationDemo(value1 = "good")
 public int add(int a, int b) {
  return a + b;
 }
}

/**

*子類，繼承自TargetTest ，同時繼承父類的TargetAnnotationDemo

*@author xiaoyun 2013-07-21

*/
class TargetTestChild extends TargetTest {
 @Override
 public int add(int a, int b) {
  // TODO Auto-generated method stub
  return super.add(a, b);
 }
}

第三步：

寫測試類，TestTarget.java

import java.lang.annotation.Annotation;

public class TestTarget {
 public static void main(String[] args) {
  //例項化父類
  TargetTest parent = new TargetTest();
  //例項化子類
  TargetTestChild child = new TargetTestChild();
  //獲取父類的型別
  Class cls = TargetTest.class;
  //獲取子類的型別
  Class childCls = TargetTestChild.class;
  //獲取父類的註解
  Annotation[] pAnnotations = cls.getAnnotations();
  if (pAnnotations.length > 0) {
   System.out.println("父類的註解：");
   for (Annotation annotation : pAnnotations) {
    System.out.println(annotation.annotationType().getName());   
   }
  }
  //獲取子類的註解
  Annotation[] cAnnotations = childCls.getAnnotations();
  if (cAnnotations.length > 0) {
   System.out.println("子類的註解：");
   for (Annotation annotation : cAnnotations) {
    System.out.println(annotation.annotationType().getName());
   }
  }
 }
}

  該例子主要用到了java.lang.annotation.Annotation中的所有註解型別。對於Retention，Target，Inherited和Documented這是個註解型別，需要重點掌握前三個，第四個很少用到。

   這上面的兩個例子都能正常執行，我的環境依然是，JDK1.6。對於生成doc文件的問題，你也可以通過javadoc命令來生成，但是如果你的開發工具時myeclipse8.6的話，可以通過project->Generate Javadoc來生成doc文件，通過去掉和加上@Documented註解型別來觀察在文件中是否有對應的說明（當然去掉或加上後需要重新生成下）。

   這次先寫到這裡，關於註解在程式和框架中的應用案例，後面等我學習後會進行更新和發表，謝謝各位同行關注。

    歡迎各位同行和前輩們提出問題，對程式或者我組織的語言進行批評指導。