java 注解（Annotation）

注解

相當于一種标記，在程式中加入注解就是為程式打上了某種标記。加入标記後，Java編譯器可以利用反射機制來了解類和各種元素上有無任何标記，然後根據标記去做相應的事情。标記可以加在包、類、字段、方法、方法的參數以及局部變量上。

定義一個最簡單的注解：

1	public @interface MyAnnotation{ ... }

在類上寫注解：

1 2	@MyAnnotation public void AnnotationTest{ ... }

注解分類

Java中提供了四中元注解，專門用來注解其他的注解，分别如下：

@Retention元注解：表示在什麼級别儲存該注釋資訊（注解的生命周期）。

可選的參數包括：

1 2 3

@Retention(RetentionPolicy.SOURCE)：停留在Java源檔案，編譯器被丢掉。 @Retention(RetentionPolicy.CLASS)：停留在Class檔案中，但不會被VM丢棄。 @Retention(RetentionPolicy.RUNTIME)：記憶體中的位元組碼，VM在運作時也保留注解，是以通過反射機制可以讀取注解中的資訊。

@Target元注解：預設值為任何元素，表示該注解可以用于什麼地方。可選的參數包括：

1 2 3 4 5 6 7

@Target(ElementType.SOURCE)：構造器聲明 @Target(ElementType.FIELD)：成員變量、對象、屬性 @Target(ElementType.Local_VARIABLE)：局部變量聲明 @Target(ElementType.METHOD)：方法聲明 @Target(ElementType.PACKAGE)：包聲明 @Target(ElementType.PARAMETER)：參數聲明 @Target(ElementType.TYPE)：類，接口等的聲明

@Documented将注解包含在JavaDoc中

@Inheried允許子類繼承父類中的注解

舉例：

1 2

@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD, ElementType.TYPE}) public @interface MyAnnotation { //為注解添加屬性 String color(); String value() default"我是林計欽"; //為屬性提供預設值 int[] array() default {1, 2, 3}; Gender gender() default Gender.MAN; //添加一個枚舉 MetaAnnotation metaAnnotation() default @MetaAnnotation(birthday="我的出身日期為1988-2-18"); //添加枚舉屬性 }

注解寫完之後需要注解解析器來解析注解，要看注解聲明的地方，然後再調用不同的方法去解析。

注解标注在類上時：

1 2 3 4 5

if(AnnotationTest.class.isAnnotationPresent(MyAnnotation.class)){ //若存在就擷取注解 MyAnnotation annotation=(MyAnnotation)AnnotationTest.class.getAnnotation(MyAnnotation.class); System.out.println(annotation); }

注解标注在方法上的執行個體：

1 2 3 4 5 6

@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface PrivilegeInfo { String name() default ""; }

注解解析器：

解析目标類中的目标方法，傳回目标方法中注解的name的屬性值

1 2 3 4 5 6 7 8 9 10 11 12

public static String parse(Class serviceClass,String methodName) throws Exception{ //擷取目标方法的method形式 Method method = serviceClass.getMethod(methodName); String privilegeName = ""; //若存在就擷取注解 if(method.isAnnotationPresent(PrivilegeInfo.class)){ PrivilegeInfo privilegeInfo = method.getAnnotation(PrivilegeInfo.class); privilegeName = privilegeInfo.name(); } return privilegeName; }

總結

注解目前非常的流行，很多主流架構都支援注解，而且自己編寫代碼的時候也會盡量的去用注解，一時友善，而是代碼更加簡潔。

original  link： http://longliqiang88.github.io/2015/07/23/Java%E5%AD%A6%E4%B9%A0-%E6%B3%A8%E8%A7%A3/