品Spring：能工巧匠們對註解的“加持”

問題的描述與方案的提出

在Spring從XML轉向註解時，為了自身的開發方便，對註解含義進行了擴充（具體參考本號上一篇文章）。

這個擴充直接導致了一個問題，就是需要從註解往元註解以及元元註解（即沿著從下向上的方向）裡傳遞資料。

為了更好的描述這個問題，請再看個示例：

@interface A {

    String a() default "";
}

@A
@interface B {

    String a() default "";
 

    String b() default "";
}

@B
@interface C {

    String a() default "";

    String b() default "";

    String c() default "";
}

@C(a = "a", b = "b", c = "c")
 
class D {

}

這裡共有三個註解@A、@B、@C。@A的級別最高，@C的級別最低，資料傳遞是從@C向@A，所以是從下向上。

溫馨提示，請務必明白註解級別的高低，什麼是高級別註解，什麼是低級別註解，本文會一直這樣稱呼。

我們最終設定的是註解@C的a、b、c三個屬性。同時急切期望的是註解@C能把a、b屬性傳遞給註解@B，註解@B能把a屬性傳遞給註解@A。

這個期望對Spring來說非常重要，可惜了，Java註解在這方面是空白的。不過Spring早已司空見慣，不必大驚小怪，沒有路就自己開一條。

首先要解決的就是一個對映的問題，總得知道哪個註解的哪個屬性對映到哪個註解的哪個屬性吧，其實就是需要再額外附加上一個對映資訊。

Spring給出的方案很簡單，就是用一個註解@AliasFor，把它標註在需要傳遞資料的屬性上，並指明傳遞給誰（哪個註解的哪個屬性）。

再次呼應一下上一篇文章的主題，要新增的對映資訊是額外附加資訊，這正是註解的功能所在呀，所以現在就是用註解去解決註解的問題。哈哈。

這樣一來的話，上面的示例就變為：

@interface A {

    String a() default "";
}

@A
@interface B {

    @AliasFor(annotation = A.class, attribute = "a")
    String a() default "";

    String b() default "";
}

@B
@interface C {

    @AliasFor(annotation = B.class, attribute = "a")
    String a() default "";

    @AliasFor(annotation = B.class, attribute = "b")
    String b() default "";

    String c() default "";
}

通過簡單的標註，就已經建立起了對映關係，可以說已經對上號了，至於程式碼如何實現則另當別論啦。

@AliasFor也有一些簡潔用法：

1）如果對映的屬性名稱一樣，則可以不指定屬性名，即attribute不用設定。

2）如果對映的是同一個註解裡的屬性名，則可以不指定註解，即annotation不用設定。

3）這個對映是可以跳級的，可以從註解跳過元註解直接對映到元元註解。

下面請再看下@AliasFor的原始碼：

public @interface AliasFor {

    @AliasFor("attribute")
    String value() default "";

    @AliasFor("value")
    String attribute() default "";

    Class<? extends Annotation> annotation() default Annotation.class;
}

@AliasFor註解的三種用法

一）註解內部的顯式別名

看下面這個註解：

@interface A {

    @AliasFor("y")
    String x() default "";

    @AliasFor("x")
    String y() default "";
}

在一個註解裡面，把一對屬性相互指定為對方的別名。

注意，只能是一對，即兩個，不能是三個及以上。

至於為什麼會有這種用法，我給出一個猜測吧。

Java註解規定：

當只需設定註解的一個屬性時，且屬性名稱是“value”，設定時可以省略屬性名稱。

看個示例：

@interface E {

    String value() default "";
}

在使用這個註解時有兩種寫法，@E(value = "abc") 和 @E("abc")，它倆是一回事，但後者要簡潔很多。

這裡有個問題，就是屬性名必須是“value”才行，但value這個名字很中性，不能很好的表達意圖。

所以很多時候，都會定義更有意義的屬性名，比如用“name”表示名稱要比value好得多，如下：

@interface E {

    String value() default "";

    String name() default "";
}

但是又想使用剛才那種簡潔的用法，咋辦呢？讓它倆互為別名即可，如下：

@interface E {

    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";
}

現在value和name已經互為對方的別名，所以@E("abc")、@E(name = "abc")都是一樣的，顯然前者更好看。

不知你是否注意到@AliasFor註解的原始碼本身就已經使用了這種方法。

二）元註解中屬性顯式別名

看個示例：

@E
@interface F {

    @AliasFor(annotation = E.class, attribute = "name")
    String id() default "";
}

這樣就把註解@F的id屬性對映為元註解@E的name屬性了。

三）註解內部的隱式別名

看個示例：

@F
@interface G {

    @AliasFor(annotation = F.class, attribute = "id")
    String a() default "";

    @AliasFor(annotation = F.class, attribute = "id")
    String b() default "";

    @AliasFor(annotation = E.class, attribute = "name")
    String c() default "";
}

屬性a和b都對映為註解@F的id屬性，所以它倆指向一處，因此互為別名。

註解@F的id屬性又對映為註解@E的name屬性，這恰好又和屬性c的對映一樣。

因此屬性a、b和c三者互相互為別名。因為它們雖然殊途但是同歸。

由此也可以看出，對映是具有傳遞性的。X -> Y -> Z，可以推匯出X -> Z。

這個對映的建立是有前提條件的：

1）屬性的返回型別必須是同一個

2）屬性必須要有預設值

3）屬性的預設值必須是同一個

在使用時也是有限制的：

1）互為別名的屬性只需設定其中任何一個即可

2）如果設定了其中多個，設定的值必須一樣。

這些其實很好理解，就像不管是大名、小名、筆名或曾用名，最後指向的必須是同一個人才行。

這就是Spring給出的方案，既簡單又直白，所見即所得啊，個人覺得這是上等的方案，也是鄙人的追求。

終於還是要走到該思索如何實現這一步，就像不管什麼樣的媳婦兒最終都要見公婆。那就勇敢面對吧。

不過可以預見的是，實現起來應該比較麻煩。因為不可能既有魔鬼身材又有天使面孔。

好事不會都讓一個人佔完，上帝對誰都是公平的。

長得帥的學習差，學習好的長的醜。哈哈哈哈。

從簡單處入手，先撿軟柿子捏

從Java語言規範中得知，註解就是一個介面（多了個@而已），註解的屬性就是介面方法，而且方法必須是無參的，返回值必須不能為void。

這些方法就相當於“getter”方法，啥意思呢？只讀的唄。明白了吧，就是註解的屬性值在執行時是無法修改的。

因此，我們在向上傳遞屬性值的時候，是不能像普通Java bean那樣，去設定屬性值的。所以只能想別的辦法。

先從最簡單的情況入手，看個示例：

@interface H {

    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";
}

@H("程式設計新說")
class K {

}

來讀取下註解的屬性看看，如下：

H h = K.class.getAnnotation(H.class);

h.value(); //"程式設計新說"

h.name(); //""

value屬性的值就是“程式設計新說”，因為我們設定的就是它，這毋庸置疑。

name屬性的值是空字串，因為我們沒有顯式設定它，所以是它的預設值。

這就是Java註解的表現行為，是正常合理的。

Spring想做的大家都知道了，就是標上@AliasFor註解後，name屬性也能返回“程式設計新說”，即使站在Java註解的角度來看，name屬性並沒有被設定。

品Spring：能工巧匠們對註解的“加持”

品Spring：能工巧匠們對註解的“加持”

品Spring：註解之王@Configuration和它的一眾“小弟們”

品Spring：對@PostConstruct和@PreDestroy註解的處理方法

品Spring：對@Resource註解的處理方法

品Spring：對@Autowired和@Value註解的處理方法

Spring：依賴注入（註解方式）、泛型依賴注入

Spring MVC 深入及對註解的詳細講解

品Spring：帝國的基石

品Spring：bean定義上梁山

品Spring：實現bean定義時採用的“先進生產力”

品Spring：SpringBoot和Spring到底有沒有本質的不同？

品Spring：負責bean定義註冊的兩個“排頭兵”

品Spring：SpringBoot輕鬆取勝bean定義註冊的“第一階段”

品Spring：SpringBoot發起bean定義註冊的“二次攻堅戰”

品Spring：bean工廠後處理器的呼叫規則

品Spring：詳細解說bean後處理器

品Spring：真沒想到，三十步才能完成一個bean例項的建立

品Spring：關於@Scheduled定時任務的思考與探索，結果尷尬了

######Spring第5天ssh整合(註解版)難理解知識點：【自定義方法加註解的方式】給dao注入sessionFactory屬性+【搞清@Autowared和@Resource含義】

day39-Spring 08-Spring的AOP：基於AspectJ的註解

品Spring：能工巧匠們對註解的“加持”

相關推薦