摘要: 大家都知道註解是實現了java.lang.annotation.Annotation介面,眼見為實,耳聽為虛,有時候眼見也不一定是真實的。 元註解: 元註解 一般用於指定某個註解生命周期以及作用目標等信息。正如源碼的註釋一樣,如果自定義的註解沒有添加元註解就和平常的註釋沒有多大的區別,有了元 ...
摘要:
大家都知道註解是實現了java.lang.annotation.Annotation介面,眼見為實,耳聽為虛,有時候眼見也不一定是真實的。
/**
* The common interface extended by all annotation types. Note that an
* interface that manually extends this one does <i>not</i> define
* an annotation type. Also note that this interface does not itself
* define an annotation type.
*
* More information about annotation types can be found in section 9.6 of
* <cite>The Java™ Language Specification</cite>.
*
* The {@link java.lang.reflect.AnnotatedElement} interface discusses
* compatibility concerns when evolving an annotation type from being
* non-repeatable to being repeatable.
*
* @author Josh Bloch
* @since 1.5
*/
元註解:
元註解 一般用於指定某個註解生命周期以及作用目標等信息。正如源碼的註釋一樣,如果自定義的註解沒有添加元註解就和平常的註釋沒有多大的區別,有了元註解就會讓編譯器將信息編譯進位元組碼文件。
@Target
@Target
用於指明被修飾的註解最終可以作用的目標
ElementType
是一個枚舉類型
ElementType.TYPE:類,介面(包括註釋類型)或枚舉聲明
ElementType.FIELD:欄位聲明(包括枚舉常量)
ElementType.METHOD:方法聲明
ElementType.PARAMETER:正式參數聲明
ElementType.CONSTRUCTOR:構造器聲明
ElementType.LOCAL_VARIABLE:本地局部變數聲明
ElementType.ANNOTATION_TYPE:註解聲明
ElementType.PACKAGE:包聲明
ElementType.TYPE_PARAMETER:類型參數聲明 jdk1.8新增
ElementType.TYPE_USE:使用一種類型 jdk1.8新增
- @Retention
@Retention
用於指明當前註解的生命周期
RetentionPolicy
是一個枚舉類型
RetentionPolicy.SOURCE:編譯器將丟棄註釋。
RetentionPolicy.CLASS:註釋將由編譯器記錄在類文件中,但在運行時不需要由VM保留。
RetentionPolicy.RUNTIME:註釋將由編譯器記錄在類文件中並且在運行時由VM保留,因此可以反射性地讀取它們。
- @Documented
@Documented
表示具有類型的註釋將由javadoc記錄和預設的類似工具。 這種類型應該用來註釋註解影響註解使用的類型的聲明客戶的元素。 如果使用註解類型聲明記錄,其註解成為公共API的一部分註釋元素。
- @Inherited
@Inherited
表示自動繼承註解類型。 如果註解類型上存在繼承的元註解聲明,用戶查詢類的註解類型聲明,類聲明沒有此類型的註解,然後將自動查詢該類的超類註解類型。 將重覆此過程,直到為此註解找到類型,或類層次結構的頂部(對象)到達了。 如果沒有超類具有此類型的註解,那麼查詢將指示有問題的類沒有這樣的註解。請註意,如果帶註解,則此元註解類型無效type
用於註解除類之外的任何內容。 另請註意這個元註解只會導致註解被繼承來自超類; 已實現的介面上的註解沒有效果。
註解實現
- 如何自定義註解?
package com.github.dqqzj.springboot.annotation;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author qinzhongjian
* @date created in 2019-07-28 07:54
* @description: TODO
* @since JDK 1.8.0_212-b10
*/
@Target(value = {ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@Component
public @interface Hello {
@AliasFor(
annotation = Component.class
)
String value() default "hi" ;
}
如何獲取註解元素信息?
如上圖所示註解其實也是使用了代理,而且是JDK代理的。
註解原理分析
既然是運行時生成的代理類,我們就可以在啟動類上添加System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles","true")
或者
我們來分析一下生成的代理類
package com.sun.proxy;
import com.github.dqqzj.springboot.annotation.Hello;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class $Proxy1 extends Proxy implements Hello {
private static Method m1;
private static Method m2;
private static Method m4;
private static Method m0;
private static Method m3;
public $Proxy1(InvocationHandler var1) throws {
super(var1);
}
public final boolean equals(Object var1) throws {
try {
return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final String toString() throws {
try {
return (String)super.h.invoke(this, m2, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final Class annotationType() throws {
try {
return (Class)super.h.invoke(this, m4, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final int hashCode() throws {
try {
return (Integer)super.h.invoke(this, m0, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final String value() throws {
try {
return (String)super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m2 = Class.forName("java.lang.Object").getMethod("toString");
m4 = Class.forName("com.github.dqqzj.springboot.annotation.Hello").getMethod("annotationType");
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
m3 = Class.forName("com.github.dqqzj.springboot.annotation.Hello").getMethod("value");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
這裡的InvocationHandler
實際上是我們的AnnotationInvocationHandler
,這裡有一個memberValues
,它是一個Map
鍵值對,鍵是我們註解屬性名稱,值就是該屬性當初被賦上的值。接下來我調試代碼給大家分享一下奧秘。
Hello hello = TestAnnotation.class.getAnnotation(Hello.class)
這個部分的調試代碼我會忽略直接調試
AnnotationInvocationHandler
的相關方法。
註解奧秘的準備工作
- 反編譯註解文件,發現註解確實是實現了
Annotation
介面的
熟悉jdk規範的就會發現最底部的s#7RuntimeVisibleAnnotations
這個是運行時可訪問的註解信息,可供我們反射獲取。
虛擬機規範定義了一系列和註解相關的屬性表,無論是欄位、方法或是類本身,如果被註解修飾了,就可以被寫進位元組碼文件。屬性表有以下幾種:
RuntimeVisibleAnnotations:運行時可見的註解
RuntimeInVisibleAnnotations:運行時不可見的註解
RuntimeVisibleParameterAnnotations:運行時可見的方法參數註解
RuntimeInVisibleParameterAnnotations:運行時不可見的方法參數註解
AnnotationDefault:註解類元素的預設值`
註解奧秘調試
說明: 明明只有一個@Hello
註解為什麼左側會出現2個代理類的原因就在這個地方,會多出一個代理類
public final class $Proxy0 extends Proxy implements Retention {
//省略無關代碼.......
}
反射註解工作原理:
- 我們通過鍵值對的形式可以為註解屬性賦值,像這樣:
@Hello(value = "hi")
- 用註解修飾某個元素,編譯器將在編譯期掃描每個類或者方法上的註解,會做一個基本的檢查,你的這個註解是否允許作用在當前位置,最後會將註解信息寫入元素的屬性表
- 虛擬機把生命周期在
RUNTIME
的註解取出並通過動態代理機制生成一個實現註解介面的代理類
如何動態修改代理值?
我們已經知道了註解的值是存放在Map<String, Object> memberValues
中的,那麼我們就可以使用反射獲取並重新賦值。