自JDK1.5引入註解後,他就成為了Java編程語言重要的組成部分,在開發過程中,我們也時常用到@Override、@ToString等這樣的註解。在這篇文章中,將介紹什麼是註解、為什麼引用註解、它是如何工作的、如何編寫自定義註解、以及如何測試自定義註解。 一、什麼是註解? 用一個詞就可以描述註解, ...
自JDK1.5引入註解後,他就成為了Java編程語言重要的組成部分,在開發過程中,我們也時常用到@Override、@ToString等這樣的註解。在這篇文章中,將介紹什麼是註解、為什麼引用註解、它是如何工作的、如何編寫自定義註解、以及如何測試自定義註解。 一、什麼是註解? 用一個詞就可以描述註解,那就是元數據,即一種描述數據的數據,可以理解為描述數據的一種標記。如以下代碼:
@Override
public void doSomething() {
System.out.println("覆寫了父類doSomething()!)");
}
總的來說,Annotation(註解)是一種應用於類、方法、參數、變數、構造器及包聲明中的特殊修飾符;Java註解是附加在代碼中的一些元信息,用於一些工具在編譯、運行時進行解析和使用,起到說明、配置的功能。註解不會也不能影響代碼的實際邏輯,僅僅起到輔助性的作用。包含在 java.lang.annotation 包中;它是一種由JSR-175標準選擇用來描述元數據的一種工具。
二、為什麼引入註解?
使用Annotation註解之前,XML被廣泛的應用於描述元數據。隨著項目的開發與維護,XML的表現越來越糟糕,此時,人們希望在一些場合使用緊耦合的方式進行代碼描述。當然,並不是說XML方式不好,兩者各有優勢:
假如你想為應用設置很多的常量或參數,這種情況下,XML是一個很好的選擇,因為它不會同特定的代碼相連;如果你想對代碼進行配置說明、編譯提示等時,那麼使用Annotation註解會更好一些。
註解的用處:
1、生成文檔。這是最常見的,也是java 最早提供的註解。常用的有@param @return 等
2、跟蹤代碼依賴性,實現替代配置文件功能。比如Dagger 2依賴註入,未來java開發,將大量註解配置,具有很大用處,比如現在的Springboot框架;
3、在編譯時進行格式檢查。如@override 放在方法前,如果你這個方法並不是覆蓋了超類方法,則編譯時就能檢查出。
開發時我們可以根據它的用處來權衡使用XML方式與使用Annotation註解的利弊來選擇是否使用Annotation註解。(參考:https://blog.csdn.net/PORSCHE_GT3RS/article/details/80304701 )
三、註解是如何工作的?
註解本質是一個繼承了Annotation的特殊介面,其具體實現類是Java運行時生成的動態代理類。而我們通過反射獲取註解時,返回的是Java運行時生成的動態代理對象$Proxy。通過代理對象調用自定義註解(介面)的方法,會最終調用AnnotationInvocationHandler的invoke方法。該方法會從memberValues這個Map中索引出對應的值。而memberValues的來源是Java常量池。
關於更詳細的瞭解可以參考這篇blog:https://blog.csdn.net/lylwo317/article/details/52163304。在這篇文章中詳細介紹瞭如何查看與獲取生產的代理對象的位元組碼文件,從而獲悉生產的代理對象的具體的代碼實現。
四、如何編寫自定義註解
編寫自定義的註解之前,首先得瞭解註解相關的基本概念——元註解。
元註解,專門註解其他的註解(在自定義註解的時候,需要使用到元註解),起到指定註解(自定義註解)的作用範圍、生命周期等作用。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指定了註解的生命周期——代碼運行時生效,自定義註解基本上都是使用該枚舉欄位聲明其生命周期。接下來,開始編寫測試註解的代碼:
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(),然後獲取註解子類對象。