自JDK1.5引入註解後,他就成爲了Java編程語言重要的組成部分,在開發過程當中,咱們也時經常使用到@Override、@ToString等這樣的註解。在這篇文章中,將介紹什麼是註解、爲何引用註解、它是如何工做的、如何編寫自定義註解、以及如何測試自定義註解。
1、什麼是註解?
用一個詞就能夠描述註解,那就是元數據,即一種描述數據的數據,能夠理解爲描述數據的一種標記。如如下代碼:
@Override
public void doSomething() { System.out.println("複寫了父類doSomething()!)"); }
總的來講,Annotation(註解)是一種應用於類、方法、參數、變量、構造器及包聲明中的特殊修飾符;Java註解是附加在代碼中的一些元信息,用於一些工具在編譯、運行時進行解析和使用,起到說明、配置的功能。註解不會也不能影響代碼的實際邏輯,僅僅起到輔助性的做用。包含在 java.lang.annotation 包中;它是一種由JSR-175標準選擇用來描述元數據的一種工具。
2、爲何引入註解?
使用Annotation註解以前,XML被普遍的應用於描述元數據。隨着項目的開發與維護,XML的表現愈來愈糟糕,此時,人們但願在一些場合使用緊耦合的方式進行代碼描述。固然,並非說XML方式很差,二者各有優點:
假如你想爲應用設置不少的常量或參數,這種狀況下,XML是一個很好的選擇,由於它不會同特定的代碼相連;若是你想對代碼進行配置說明、編譯提示等時,那麼使用Annotation註解會更好一些。
註解的用處:
一、生成文檔。這是最多見的,也是java 最先提供的註解。經常使用的有@param @return 等
二、跟蹤代碼依賴性,實現替代配置文件功能。好比Dagger 2依賴注入,將來java開發,將大量註解配置,具備很大用處,好比如今的Springboot框架;
三、在編譯時進行格式檢查。如@override 放在方法前,若是你這個方法並非覆蓋了超類方法,則編譯時就能檢查出。
3、註解是如何工做的?
註解本質是一個繼承了Annotation的特殊接口,其具體實現類是Java運行時生成的動態代理類。而咱們經過反射獲取註解時,返回的是Java運行時生成的動態代理對象$Proxy。經過代理對象調用自定義註解(接口)的方法,會最終調用AnnotationInvocationHandler的invoke方法。該方法會從memberValues這個Map中索引出對應的值。而memberValues的來源是Java常量池。
4、如何編寫自定義註解
編寫自定義的註解以前,首先得了解註解相關的基本概念——元註解。
元註解,專門註解其餘的註解(在自定義註解的時候,須要使用到元註解),起到指定註解(自定義註解)的做用範圍、生命週期等做用。java.lang.annotation提供了四種元註解:
1)@Documented——註解是否將包含在JavaDoc中,一個簡單的Annotations標記註解,表示是否將註解信息添加在java文檔中
2)@Retention ——何時使用該註解,定義該註解的生命週期
3)@Target? ——註解用於什麼地方。若是不明確指出,該註解能夠放在任何地方。如下是一些可用的參數。須要說明的是:屬性的註解是兼容的,若是你想給7個屬性都添加註解,僅僅排除一個屬性,那麼你須要在定義target包含全部的屬性。
ElementType.TYPE:用於描述類、接口或enum聲明
ElementType.FIELD:用於描述實例變量
ElementType.METHOD:用於描述實例方法
ElementType.PARAMETER:用於描述實例方法參數
ElementType.CONSTRUCTOR:用於描述實例的構造函數
ElementType.LOCAL_VARIABLE:用於描述局部變量
ElementType.ANNOTATION_TYPE 另外一個註釋
ElementType.PACKAGE 用於記錄java文件的package信息
4)@Inherited —— 是否容許子類繼承該註解
可是從JDK1.8開始,又新增長了兩個元註解:
@Native——指示可從本機代碼引用定義常量值的字段。
@Repeatable——用於指示其聲明(元)註釋的註釋類型是可重複的。
下面咱們開始編寫自定義註解。語法以下,使用@interface來代表聲明的是一個註解
public @interface 註解名稱 {
//String weather() default "";//註解中能夠沒有屬性,而且在註解中屬性是以方法的形式存在
}
可是,編寫註解的時候僅僅作到如上代碼的樣子還遠遠不夠,一般,還須要爲他們指定註解的做用範圍、生命週期等,這時候就須要用到元註解對咱們定義的註解進行註解(標識說明)了。
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface WeatherAnnotation { String weather() default ""; }
以上註解經過ElementType.FIELD限制了該註解只能標識屬性,經過RetentionPolicy.RUNTIME指定了註解的生命週期——代碼運行時生效,自定義註解基本上都是使用該枚舉字段聲明其生命週期。接下來,開始編寫測試註解的代碼:javascript
package com.wyfx.nio.annotation;
public class Today { @WeatherAnnotation(weather="hello,今天是晴天") private String dayWeather; public String getDayWeather() { return dayWeather; } public void setDayWeather(String dayWeather) { this.dayWeather = dayWeather; } @Override public String toString() { return "Today{" + "dayWeather='" + dayWeather + '\'' + '}'; } }
import java.lang.reflect.Field;
public class Test { public static void main(String[] args){ /*Annotation annotations=new Today().getClass().getAnnotation(WeatherAnnotation.class);*/ try { Class aClass=Class.forName("com.wyfx.nio.annotation.Today"); Field[] fields= aClass.getDeclaredFields(); String weather=""; for (Field field : fields) { if(field.isAnnotationPresent(WeatherAnnotation.class)){ WeatherAnnotation weatherAnnotation=field.getAnnotation(WeatherAnnotation.class); weather= weatherAnnotation.weather(); } } System.out.println("--annotation---:"+weather); }catch (Exception e){ e.printStackTrace(); } } }
以上代碼順利打印出「hello,今天是晴天」,說明自定義註解成功了,值得注意的是,註解的做用域是屬性,因此在經過反射進行測試的時候,必須在Field的基礎上去判斷是不是Annotation接口的子類(field.isAnnotationPresent(),而後獲取註解子類對象。java