java實作注解的底層原理和概念

• java注解是JDK1.5引入的一種注釋機制，java語言的類、方法、變數、引數和包都可以被注解標注，和Javadoc不同，java注解可以通過反射獲取標注內容
• 在編譯器生成.class檔案時，注解可以被嵌入位元組碼中，而jvm也可以保留注解的內容，在運行時獲取注解標注的內容資訊
• java提供的注解可以分成兩類：

作用在代碼上的功能注解（部分）:

讓給程式員開發自定義注解的元注解（和關鍵字@interface配合使用的注解）

• Annotation是所有注解類的共同介面，不用顯示實作，注解類使用@interface定義（代表它實作Annotation介面），搭配元注解使用，如下

package java.lang.annotation;
public interface Annotation {
    boolean equals(Object obj);
    int hashCode();
    String toString();
    // 回傳定義的注解型別，你在代碼宣告的@XXX,相當于該型別的一實體
    Class<? extends Annotation> annotationType();
}
-----自定義示例-----
@Retention( value = RetentionPolicy.RUNTIME)
@Target(value = ElementType.TYPE)
public @interface ATest {
	String hello() default  "siting";
}

ATest的位元組碼檔案，編譯器讓自定義注解實作了Annotation介面

public abstract @interface com/ATest implements java/lang/annotation/Annotation {
  // compiled from: ATest.java
  @Ljava/lang/annotation/Retention;(value=Ljava/lang/annotation/RetentionPolicy;.RUNTIME)
  @Ljava/lang/annotation/Target;(value={Ljava/lang/annotation/ElementType;.TYPE})
  // access flags 0x401
  public abstract hello()Ljava/lang/String;
    default="siting"
}

• 自定義注解型別時，一般需要用@Retention指定注解保留范圍RetentionPolicy，@Target指定使用范圍ElementType，RetentionPolicy保留范圍只能指定一個，ElementType使用范圍可以指定多個
• 注解資訊怎么和代碼關聯在一起，java所有事物都是類，注解也不例外，加入代碼System.setProperty("sum.misc.ProxyGenerator.saveGeneratedFiles","true"); 可生成注解相應的代理類
  
  在代碼里定義的注解，會被jvm利用反射技術生成一個代理類，然后和被注釋的代碼（類，方法，屬性等）關聯起來

五種元注解詳解

• @Retention：指定注解資訊保留階段，有如下三種列舉選擇，只能選其一

public enum RetentionPolicy {
    /** 注解將被編譯器丟棄，生成的class不包含注解資訊 */
    SOURCE,
    /** 注解在class檔案中可用，但會被JVM丟棄;當注解未定義Retention值時，默認值是CLASS */
    CLASS,
    /** 注解資訊在運行期(JVM)保留（.class也有），可以通過反射機制讀取注解的資訊,
      * 操作方法看AnnotatedElement(所有被注釋類的父類) */
    RUNTIME
}

• @Documented：作用是告訴JavaDoc工具，當前注解本身也要顯示在Java Doc中(不常用)
• @Target：指定注解作用范圍，可指定多個

public enum ElementType {
    /** 適用范圍：類、介面、注解型別，列舉型別enum */
    TYPE,
    /** 作用于類屬性 (includes enum constants) */
    FIELD,
    /** 作用于方法 */
    METHOD,
    /** 作用于引數宣告 */
    PARAMETER,
    /** 作用于建構式宣告 */
    CONSTRUCTOR,
    /** 作用于區域變數宣告 */
    LOCAL_VARIABLE,
    /** 作用于注解宣告 */
    ANNOTATION_TYPE,
    /** 作用于包宣告 */
    PACKAGE,
    /** 作用于型別引數（泛型引數）宣告 */
    TYPE_PARAMETER,
    /** 作用于使用型別的任意陳述句(不包括class) */
    TYPE_USE
}

TYPE_PARAMETER的用法示例

class D<@PTest T> { } // 注解@PTest作用于泛型T

TYPE_USE的用法示例

//用于父類或者介面 
class Test implements @Parent TestP {} 

//用于建構式
new @Test String("/usr/data")

//用于強制轉換和instanceof檢查,注意這些注解中用于外部工具
//它們不會對型別轉換或者instanceof的檢查行為帶來任何影響
String path=(@Test String)input;
if(input instanceof @Test String) //注解不會影響

//用于指定例外
public Person read() throws @Test IOException.

//用于通配符系結
List<@Test ? extends Data>
List<? extends @Test Data>

@Test String.class //非法，不能標注class

• @Inherited：表示當前注解會被注解類的子類繼承，即在子類Class<T>通過getAnnotations()可獲取父類被@Inherited修飾的注解，而注解本身是不支持繼承

@Inherited
@Retention( value = RetentionPolicy.RUNTIME)
@Target(value = ElementType.TYPE)
public @interface ATest {  }
----被ATest注解的父類PTest----
@ATest
public class PTest{ }

---Main是PTest的子類----
public class Main extends PTest {
    public static void main(String[] args){
        Annotation an = Main.class.getAnnotations()[0];
  		//Main可以拿到父類的注解ATest，因為ATest被元注解@Inherited修飾
        System.out.println(an);
    }
}  
---result--
@com.ATest()  

• @Repeatable：JDK1.8新加入的，表明自定義的注解可以在同一個位置重復使用，在沒有該注解前，是無法在同一個型別上使用相同的注解多次

  //Java8前無法重復使用注解
  @FilterPath("/test/v2")
  @FilterPath("/test/v1")
  public class Test {}

使用動態代理機制處理注解

• 反射機制獲取注解資訊

--- 作用于注解的注解----
@Inherited
@Retention( value = RetentionPolicy.RUNTIME)
@Target(value = {ElementType.ANNOTATION_TYPE})
public @interface AnnotationTest {
    String value() default "AnnotationTest";
}
------父類-------
public class PTest {}
------被注解修飾的package-info.java------
//package-info.java
@AnTest("com-package-info")
package com;
-------------
@AnnotationTest("AnnotationTest")
@Inherited
@Retention( value = RetentionPolicy.RUNTIME)
@Target(value = {ElementType.TYPE_USE,ElementType.PACKAGE,ElementType.FIELD,
        ElementType.TYPE_PARAMETER,ElementType.CONSTRUCTOR,ElementType.LOCAL_VARIABLE})
public @interface AnTest  {
    String value() default  "siting";
}

運行示例

//注解類
@AnTest("mainClass")
//注解泛型引數                                       //注解繼承父類
public class Main<@AnTest("parameter") T > extends @AnTest("parent") PTest {
    @AnTest("constructor")  //注解建構式
    Main(){ }
    //注解欄位域
    private @AnTest("name") String name;
    //注解泛型欄位域
    private @AnTest("value") T value;
    //注解通配符
    private @AnTest("list")List<@AnTest("generic") ?>list;
    //注解方法
    @AnTest("method")                       //注解方法引數
    public String hello(@AnTest("methodParameter") String name)
            throws @AnTest("Exception") Exception { // 注解拋出例外
        //注解區域變數,現在運行時暫時無法獲取（忽略）
        @AnTest("result") String result;
        result = "siting";
        System.out.println(name);
        return  result;
    }

    public static void main(String[] args) throws Exception {

        Main<String>  main = new Main<> ();
        Class<Main<Object>> clazz = (Class<Main<Object>>) main.getClass();
        //class的注解
        Annotation[] annotations = clazz.getAnnotations();
        AnTest testTmp = (AnTest) annotations[0];
        System.out.println("修飾Main.class注解value: "+testTmp.value());
        //構造器的注解
        Constructor<Main<Object>> constructor = (Constructor<Main<Object>>) clazz.getDeclaredConstructors()[0];
        testTmp = constructor.getAnnotation(AnTest.class);
        System.out.println("修飾構造器的注解value: "+testTmp.value());
        //繼承父類的注解
        AnnotatedType annotatedType = clazz.getAnnotatedSuperclass();
        testTmp = annotatedType.getAnnotation(AnTest.class);
        System.out.println("修飾繼承父類的注解value: "+testTmp.value());
        //注解的注解
        AnnotationTest annotationTest = testTmp.annotationType().getAnnotation(AnnotationTest.class);
        System.out.println("修飾注解的注解AnnotationTest-value: "+annotationTest.value());
        //泛型引數 T 的注解
        TypeVariable<Class<Main<Object>>> variable = clazz.getTypeParameters()[0];
        testTmp = variable.getAnnotation(AnTest.class);
        System.out.println("修飾泛型引數T注解value: "+testTmp.value());
        //普通欄位域 的注解
        Field[] fields = clazz.getDeclaredFields();
        Field nameField = fields[0];
        testTmp = nameField.getAnnotation(AnTest.class);
        System.out.println("修飾普通欄位域name注解value: "+testTmp.value());
        //泛型欄位域 的注解
        Field valueField = fields[1];
        testTmp = valueField.getAnnotation(AnTest.class);
        System.out.println("修飾泛型欄位T注解value: "+testTmp.value());
        //通配符欄位域 的注解
        Field listField = fields[2];
        AnnotatedParameterizedType annotatedPType = (AnnotatedParameterizedType)listField.getAnnotatedType();
        testTmp = annotatedPType.getAnnotation(AnTest.class);
        System.out.println("修飾泛型注解value: "+testTmp.value());
        //通配符注解 的注解
        AnnotatedType[] annotatedTypes = annotatedPType.getAnnotatedActualTypeArguments();
        AnnotatedWildcardType annotatedWildcardType = (AnnotatedWildcardType) annotatedTypes[0];
        testTmp = annotatedWildcardType.getAnnotation(AnTest.class);
        System.out.println("修飾通配符注解value: "+testTmp.value());
        //方法的注解
        Method method = clazz.getDeclaredMethod("hello", String.class);
        annotatedType = method.getAnnotatedReturnType();
        testTmp = annotatedType.getAnnotation(AnTest.class);
        System.out.println("修飾方法的注解value: "+testTmp.value());
        //例外的注解
        annotatedTypes =  method.getAnnotatedExceptionTypes();
        testTmp = annotatedTypes[0].getAnnotation(AnTest.class);
        System.out.println("修飾方法拋出錯誤的注解value: "+testTmp.value());
        //方法引數的注解
        annotatedTypes = method.getAnnotatedParameterTypes();
        testTmp = annotatedTypes[0].getAnnotation(AnTest.class);
        System.out.println("修飾方法引數注解value: "+testTmp.value());
        //包的注解
        Package p = Package.getPackage("com");
        testTmp = p.getAnnotation(AnTest.class);
        System.out.println("修飾package注解value: "+testTmp.value());
        main.hello("hello");
    }
}

結果

修飾Main.class注解value: mainClass
修飾構造器的注解value: constructor
修飾繼承父類的注解value: parent
修飾注解的注解AnnotationTest-value: AnnotationTest
修飾泛型引數T注解value: parameter
修飾普通欄位域name注解value: name
修飾泛型欄位T注解value: value
修飾泛型注解value: list
修飾通配符注解value: generic
修飾方法的注解value: method
修飾方法拋出錯誤的注解value: Exception
修飾方法引數注解value: methodParameter
修飾package注解value: com-package-info
hello

spring.AOP和注解機制

spring.AOP相當于動態代理和注解機制在spring框架的結合實作

• 前要知識：面向切面編程(AOP)和動態代理
  • C是面向程序編程的，java則是面向物件編程，C++則是兩者兼備，它們都是一種規范和思想，面向切面編程也一樣，可以簡單理解為：切面編程專注的是區域代碼，主要為某些點植入增強代碼
  • 考慮要區域加入增強代碼，使用動態代理則是最好的實作，在被代理方法呼叫的前后，可以加入需要的增強功能；因此spring的切面編程是基于動態代理的
  • 切面的概念

• spring.aop提供的切面注解

• spring的通知注解其實是通知+指定連接點組成，分五種（Before、After、After-returning、After-throwing、Around）

• 在spring切面基礎上，開發具有增強功能的自定義注解 (對注解進行切面)

新建spring-web + aop 專案；新建如下class
------ 目標Controller ------
@RestController
public class TestController {
    @STAnnotation
    @RequestMapping("/hello")
    public String hello(){  return "hello@csc";  }
}
------ Controller注解 -------
@Retention( value = RetentionPolicy.RUNTIME)
@Target(value = ElementType.METHOD)
public @interface STAnnotation {
    String value() default "注解hello!";
}
------ Controller切面 ------
@Aspect
@Component
public class ControllerAspect {
    //切點:注解指定關聯 (對注解進行切面)
    @Pointcut("@annotation(STAnnotation)")
    public void controllerX(){}
    //切點:路徑指定關聯
    @Pointcut("execution(public * com.example.demo.TestController.*(..))")
    public void controllerY(){}
    //在controllerY()切點執行之前的連接點加入通知
    @Before("controllerY()")
    public void yBefore(JoinPoint joinPoint) throws Throwable {
    	//可以加入增強代碼
        MethodSignature methodS = (MethodSignature)joinPoint.getSignature();
        Method method = methodS.getMethod();
        if (method.isAnnotationPresent(STAnnotation.class)) {
            STAnnotation annotation = method.getAnnotation(STAnnotation.class);
            System.out.println(annotation.value());
        }
        System.out.println("controllerY");
    }
    //controllerX()切點執行之后的連接點加入通知
    @After("controllerX()")
    public void xBefore(JoinPoint joinPoint) throws Throwable {
    	//可以加入增強代碼
        System.out.println("controllerX");
    }
}

啟動專案；執行curl http://127.0.0.1:8080/hello,控制臺輸出如下

（題外）@FunctionalInterface原理介紹

• Lambda 運算式的結構：（…args）-> { … code }
  • lambda在python,C++都對應的定義，java也有，lambda一般由入參，處理程序組成，如果處理代碼只有一行，中括號{} 可以省略，其實就是簡化的函式，在java里，lambda用函式式介面實作
• @FunctionalInterface作用于介面，介面可以接受lambda運算式作為右值，此類介面又叫函式式介面，其規定修飾的介面只能有一個抽象的方法（不包扣靜態方法和默認、私有方法），attention:不加@FunctionalInterface修飾，只定義一個抽象方法的介面默認也是函式式介面

@FunctionalInterface
public interface Func {  void hello(String name); }
---------------------
public static void main(String[] args) {
        Func func = (name) -> System.out.println(name);
        func.hello("siting");
    }

查看對應的Main.class位元組碼檔案 javap.exe -p -v -c Main.class

Constant pool:
   #1 = Methodref          #8.#28         // java/lang/Object."<init>":()V
   //常量值中前面的#0表示引導方法取BootstrapMethods屬性表的第0項(位元組碼在最下面)
   #2 = InvokeDynamic      #0:#33         // #0:hello:()Lcom/Func;
   #3 = String             #34            // siting
   #4 = InterfaceMethodref #35.#36        // com/Func.hello:(Ljava/lang/String;)V
   #5 = Fieldref           #37.#38        // java/lang/System.out:Ljava/io/PrintStream;
   #6 = Methodref          #39.#40        // java/io/PrintStream.println:(Ljava/lang/String;)V
   #7 = Class              #41            // com/Main
 .... // main執行位元組碼
 public static void main(java.lang.String[]);
    descriptor: ([Ljava/lang/String;)V
    flags: ACC_PUBLIC, ACC_STATIC
    Code:
      stack=2, locals=2, args_size=1
      	 // 動態獲得一個CallSite物件，該物件是一個內部類，實作了Func介面
         0: invokedynamic #2,  0              // InvokeDynamic #0:hello:()Lcom/Func;
         5: astore_1
         6: aload_1
         7: ldc           #3                  // String siting
         // 呼叫CallSite物件的hello方法
         9: invokeinterface #4,  2            // InterfaceMethod com/Func.hello:(Ljava/lang/String;)V
        14: return
.... //lambda運算式 會編譯出私有靜態類        
private static void lambda$main$0(java.lang.String);
    descriptor: (Ljava/lang/String;)V
    flags: ACC_PRIVATE, ACC_STATIC, ACC_SYNTHETIC
    Code:
      stack=2, locals=1, args_size=1
         0: getstatic     #5                  // Field java/lang/System.out:Ljava/io/PrintStream;
         3: aload_0
         4: invokevirtual #6                  // Method java/io/PrintStream.println:(Ljava/lang/String;)V
         7: return
.... //lambda運算式 會編譯出一個對應的內部類         
SourceFile: "Main.java"
InnerClasses:
     public static final #59= #58 of #62; //Lookup=class java/lang/invoke/MethodHandles$Lookup of class java/lang/invoke/MethodHandles
BootstrapMethods:
  0: #30 invokestatic java/lang/invoke/LambdaMetafactory.metafactory:(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;Ljava/lan
g/invoke/MethodType;Ljava/lang/invoke/MethodHandle;Ljava/lang/invoke/MethodType;)Ljava/lang/invoke/CallSite;
    Method arguments:
      #31 (Ljava/lang/String;)V
      //呼叫Main方法里的lambda$main$0靜態方法（真正執行lambda的邏輯的方法）
      #32 invokestatic com/Main.lambda$main$0:(Ljava/lang/String;)V
      #31 (Ljava/lang/String;)V

從上面的位元組碼可看出，1：lambda運算式會被編譯成一個私有靜態方法和一個內部類；2：內部類實作了函式式介面，而實作方法會呼叫一個Main.class里一靜態方法 3：靜態方法lambda$main$0里是我們自己寫的代碼邏輯，運行引數加上-Djdk.internal.lambda.dumpProxyClasses可以查看lambda對應內部類的具體資訊

• 常用函式式介面

歡迎指正文中錯誤

關注公眾號，一起交流

參考文章

• Annotation詳解
• Java注解（Annotation）原理詳解
• Java Lambda運算式 實作原理分析