java 註解的幾大做用及使用方法詳解

時間 2019-11-10

原文原文鏈接

Java 註解，從名字上看是註釋，解釋。但功能卻不只僅是註釋那麼簡單。註解（Annotation）爲咱們在代碼中添加信息提供了一種形式化的方法，是咱們能夠在稍後某個時刻方便地使用這些數據（經過解析註解來使用這些數據），常見的做用有如下幾種：php

生成文檔。這是最多見的，也是java 最先提供的註解。經常使用的有@see @param @return 等
跟蹤代碼依賴性，實現替代配置文件功能。比較常見的是spring 2.5 開始的基於註解配置。做用就是減小配置。如今的框架基本都使用了這種配置來減小配置文件的數量。也是
在編譯時進行格式檢查。如@Override 放在方法前，若是你這個方法並非覆蓋了超類方法，則編譯時就能檢查出。

包 java.lang.annotation 中包含全部定義自定義註解所需用到的原註解和接口。如接口 java.lang.annotation.Annotation 是全部註解繼承的接口,而且是自動繼承，不須要定義時指定，相似於全部類都自動繼承Object。java

該包同時定義了四個元註解，Documented,Inherited,Target(做用範圍，方法，屬性，構造方法等),Retention(生命範圍，源代碼，class,runtime)。下面將在實例中逐個講解他們的做用，及使用方法。spring

Inherited : 在您定義註解後並使用於程序代碼上時，預設上父類別中的註解並不會被繼承至子類別中，您能夠在定義註解時加上java.lang.annotation.Inherited 限定的Annotation，這讓您定義的Annotation型別被繼承下來。注意註解繼承只針對class 級別註解有效（這段建議看徹底文後在來回顧）。多說無益，下面就一步步從零開始建一個咱們本身的註解。編程

建第一個註解api

package com.tmser.annotation;
/**
*
*@interface用來聲明一個註解，其中的每個方法其實是聲明瞭一個配置參數。
*方法的名稱就是參數的名稱，返回值類型就是參數的類型。
*能夠經過default來聲明參數的默認值。
*在這裏能夠看到@Retention和@Target這樣的元註解，用來聲明註解自己的行爲。
*@Retention用來聲明註解的保留策略，有CLASS、RUNTIME和SOURCE這三種，
*分別表示註解保存在類文件、JVM運行時刻和源代碼中。
*只有當聲明爲RUNTIME的時候，纔可以在運行時刻經過反射API來獲取到註解的信息。
*@Target用來聲明註解能夠被添加在哪些類型的元素上，如類型、方法和域等。
*就能夠定義一個註解了，它將自動繼承Annotation
*/
public @interface TestA {
//這裏定義了一個空的註解，它能幹什麼呢。我也不知道，但他能用。
}

在下面這個程序中使用它：數組

package com.tmser.annotation;
import java.util.HashMap;
import java.util.Map;
/**
* 這個類專門用來測試註解使用
* @author tmser
*/
@TestA //使用了類註解
public class UserAnnotation {
@TestA //使用了類成員註解
private Integer age;
@TestA //使用了構造方法註解
public UserAnnotation(){
}
@TestA //使用了類方法註解
public void a(){
@TestA //使用了局部變量註解
Map m = new HashMap(0);
}
public void b(@TestA Integer a){ //使用了方法參數註解
}
}

編譯沒有報錯，ok，一個註解實驗完成。這個註解也太簡單了吧，好像什麼信息也不能傳遞。別急下面就來一步步完善它，也該四位元註解依次開始上場了。框架

四個元註解分別是：@Target,@Retention,@Documented,@Inherited ，再次強調下元註解是Java API提供，是專門用來定義註解的註解，其做用分別以下。

    @Target 表示該註解用於什麼地方，可能的值在枚舉類 ElemenetType 中，包括：
          ElemenetType.CONSTRUCTOR 構造器聲明
          ElemenetType.FIELD 域聲明（包括 enum 實例） eclipse

ElemenetType.LOCAL_VARIABLE 局部變量聲明ide

ElemenetType.ANNOTATION_TYPE 做用於註解量聲明

ElemenetType.METHOD 方法聲明工具

          ElemenetType.PACKAGE 包聲明
          ElemenetType.PARAMETER 參數聲明
          ElemenetType.TYPE 類，接口（包括註解類型）或enum聲明

     @Retention 表示在什麼級別保存該註解信息。可選的參數值在枚舉類型 RetentionPolicy 中，包括：
          RetentionPolicy.SOURCE 註解將被編譯器丟棄
          RetentionPolicy.CLASS 註解在class文件中可用，但會被VM丟棄
          RetentionPolicy.RUNTIME VM將在運行期也保留註釋，所以能夠經過反射機制讀取註解的信息。

      @Documented 將此註解包含在 javadoc 中，它表明着此註解會被javadoc工具提取成文檔。在doc文檔中的內容會由於此註解的信息內容不一樣而不一樣。至關與@see,@param 等。

      @Inherited 容許子類繼承父類中的註解，例子中補充。

學習最忌好高騖遠，咱們就一個一個來實驗。

第一個：@Target，動手在前面咱們編寫的註解上加上元註解。

package com.tmser.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
/*
* 定義註解 Test
* 首先使用ElementType.TYPE
*/
@Target(ElementType.PACKAGE)
public @interface TestA {
}

ctrl+ s 保存，今天電腦比較給力，咱們的測試類那邊立馬出現了一堆錯誤，除了類註解。我想到這，聰明的你馬上明白了這個元註解的意義了。是否是想固然的偷起懶來了。？難道還有意外？細心的朋友應該發現了，咱們的測試類少了一個屬性沒用，就是ElemenetType.PACKAGE。在咱們的註解加上這個屬性的元註解後，咱們測試程序的元註解所有陣亡，不對，還有一個沒加呢，好加上。package 包，想固然是加載 package 前面。即

@TestA package com.tmser.annotation;

什麼也報錯。這就搞不明白了，不加在這加哪去呢。我也不知道了，不過這是編譯錯誤，咱們的eclipse 將錯誤給咱們指出了，就是

Package annotations must be in file package-info.java ，e 文雖然很差，但這個簡單的仍是難不倒幾我的的，package 註解必須定義在 package-info.java 中。package-info 又是什麼東西，好了爲節省大家的時間幫你百度好了，傳送門。ok,到此 target 元註解就所有完成了。

第二個元註解： @Retention 參數 RetentionPolicy。有了前面的經驗這個註解理解起來就簡單多了，而且幸運的是這個註解尚未特殊的屬性值。簡單演示下如何使用：

package com.tmser.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
/*
* 定義註解 Test
* 首先使用ElementType.TYPE
* 運行級別定爲運行時，以便後面測試解析
*/
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
}

第三和第四個元註解就再也不舉例了。比較簡單，也沒有值，相信看過上面的解釋也就清楚了。下面咱們仍是繼續來深刻的探討下註解的使用。上面的例子都很是簡單，註解連屬性都沒有。ok，下面咱們就來定義一個有屬性的註解，並在例子程序中獲取都註解中定義的值。

開始以前將下定義屬性的規則：

@interface用來聲明一個註解，其中的每個方法其實是聲明瞭一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。能夠經過default來聲明參數的默認值。

代碼：

/*
* 定義註解 Test
* 爲方便測試：註解目標爲類方法，屬性及構造方法
* 註解中含有三個元素 id ,name和 gid;
* id 元素有默認值 0
*/
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class<Long> gid();
}

下面改下咱們的測試類：

package com.tmser.annotation;
import java.util.HashMap;
import java.util.Map;
/**
* 這個類專門用來測試註解使用
* @author tmser
*/
@TestA(name="type",gid=Long.class) //類成員註解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //類成員註解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//構造方法註解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //類方法註解
public void a(){
Map<String,String> m = new HashMap<String,String>(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //類方法註解
protected void b(){
Map<String,String> m = new HashMap<String,String>(0);
}
@TestA(name="private method",id=5,gid=Long.class) //類方法註解
private void c(){
Map<String,String> m = new HashMap<String,String>(0);
}
public void b(Integer a){
}
}

下面到了最重要的一步了，就是如何讀取咱們在類中定義的註解。只要讀取出來了使用的話就簡單了。

jdk1.5 既然增長了註解，確定就增長了相關讀取的api

在java.lang.reflect包中新增了AnnotatedElement接口，JDK源碼以下：

public interface AnnotatedElement {
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
<T extends Annotation> T getAnnotation(Class<T> annotationClass);
Annotation[] getAnnotations();
Annotation[] getDeclaredAnnotations();
}

isAnnotationPresent：判斷是否標註了指定註解
getAnnotation：獲取指定註解，沒有則返回null
getAnnotations：獲取全部註解，包括繼承自基類的，沒有則返回長度爲0的數組
getDeclaredAnnotations：獲取自身顯式標明的全部註解，沒有則返回長度爲0的數組

package com.tmser.annotation;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
public class ParseAnnotation {
/**
* 簡單打印出UserAnnotation 類中所使用到的類註解
* 該方法只打印了 Type 類型的註解
* @throws ClassNotFoundException
*/
public static void parseTypeAnnotation() throws ClassNotFoundException {
Class clazz = Class.forName("com.tmser.annotation.UserAnnotation");
Annotation[] annotations = clazz.getAnnotations();
for (Annotation annotation : annotations) {
TestA testA = (TestA)annotation;
System.out.println("id= \""+testA.id()+"\"; name= \""+testA.name()+"\"; gid = "+testA.gid());
}
}
/**
* 簡單打印出UserAnnotation 類中所使用到的方法註解
* 該方法只打印了 Method 類型的註解
* @throws ClassNotFoundException
*/
public static void parseMethodAnnotation(){
Method[] methods = UserAnnotation.class.getDeclaredMethods();
for (Method method : methods) {
/*
* 判斷方法中是否有指定註解類型的註解
*/
boolean hasAnnotation = method.isAnnotationPresent(TestA.class);
if (hasAnnotation) {
/*
* 根據註解類型返回方法的指定類型註解
*/
TestA annotation = method.getAnnotation(TestA.class);
System.out.println("method = " + method.getName()
+ " ; id = " + annotation.id() + " ; description = "
+ annotation.name() + "; gid= "+annotation.gid());
}
}
}
/**
* 簡單打印出UserAnnotation 類中所使用到的方法註解
* 該方法只打印了 Method 類型的註解
* @throws ClassNotFoundException
*/
public static void parseConstructAnnotation(){
Constructor[] constructors = UserAnnotation.class.getConstructors();
for (Constructor constructor : constructors) {
/*
* 判斷構造方法中是否有指定註解類型的註解
*/
boolean hasAnnotation = constructor.isAnnotationPresent(TestA.class);
if (hasAnnotation) {
/*
* 根據註解類型返回方法的指定類型註解
*/
TestA annotation =(TestA) constructor.getAnnotation(TestA.class);
System.out.println("constructor = " + constructor.getName()
+ " ; id = " + annotation.id() + " ; description = "
+ annotation.name() + "; gid= "+annotation.gid());
}
}
}
public static void main(String[] args) throws ClassNotFoundException {
parseTypeAnnotation();
parseMethodAnnotation();
parseConstructAnnotation();
}
}

先別說話，運行：

id= "0"; name= "type"; gid = class java.lang.Long
method = c ; id = 5 ; description = private method; gid= class java.lang.Long
method = a ; id = 3 ; description = public method; gid= class java.lang.Long
method = b ; id = 4 ; description = protected method; gid= class java.lang.Long
constructor = com.tmser.annotation.UserAnnotation ; id = 2 ; description = construct; gid= class java.lang.Long