Spring是如何處理註解的

Yujiaao發表於2019-01-19
Spring

如果你看到了註解,那麼一定有什麼程式碼在什麼地方處理了它.

Alan Hohn

我教Java課程時強調的一點是註解是惰性的。換句話說，它們只是標記，可能具有某些屬性，但沒有自己的行為。因此，每當你在一段Java程式碼上看到一個註解時，就意味著必須有一些其他的Java程式碼來尋找那個註解幷包含真正的智慧來做一些有用的東西。

不幸的是，這種推理的問題在於，確切地確定哪一段程式碼正在處理註解是非常困難的，特別是如果它在庫中。處理註解的程式碼可能會令人困惑，因為它使用反射並且必須以非常抽象的方式編寫。所以我認為值得看看一個做得很好的例子來看看它是如何執行的。

我們詳細研究一下 Spring 框架中的 InitDestroyAnnotationBeanPostProcessor 類是如何工作的。選擇這個，因為它相對簡單，只做了一些相對容易解釋的事情, 碰巧和我手頭的工作相關。

Spring Bean 的後處理

首先，我想首先解釋一下 Spring 的用途。Spring 框架所做的一件事就是“依賴注入”。這改變了我們以往用程式碼將模組串在一起的方式。例如，假設我們編寫了一些需要連線資料庫的應用程式邏輯, 但並想將提供該連線的特定硬類編碼到應用程式邏輯中，我們可以在建構函式或setter方法中將其表示為依賴項：

class MyApplication {
    private DataConnection data;
    ...
    public void setData(DataConnection data) {
        this.data = data;
    }
    ...
}

當然，如果想的話, 我們可以自己編寫一個簡單的庫完成這種依賴注入，從而避免新增對 Spring 的依賴項。但是如果我們在編寫一個複雜的應用程式, 想將各模組連線在一起，那麼Spring可以非常方便。

既然沒有什麼神祕的，如果我們要讓 Spring 為我們注入這些依賴，那麼就會有一個權衡。Spring 需要“知道”依賴關係以及應用程式中的類和物件。Spring 處理這個問題的方法多是由 Spring 框架對物件進行例項化; 從而可以在稱為”應用程式上下文”的大資料結構中跟蹤管理這此物件。

後處理和初始化

而且這裡是 InitDestroyBeanPostProcessor 進入的地方 。如果 Spring 要處理例項化，那麼在物件例項化完成之後，但是在應用程式開始真正的執行之前，需要進行一些“額外工作”。需要做的一件“額外工作”就是呼叫物件來告訴他們什麼時候完全設定好，這樣他們就可以進行任何需要的額外初始化。如果我們使用“setter”注入，如上所述，便通過呼叫setXxx() 方法注入依賴項，這一點尤其重要，因為在呼叫物件的建構函式時這些依賴項並不可用。所以 Spring 需要允許使用者指定在初始化物件後才應該呼叫的某個方法的名稱。

Spring 一直支援使用XML配置檔案來定義由 Spring 來例項化的物件，在這種情況下，有一個 `init-method` 屬性可以用來指定初始化的方法。顯然，在這種情況下，它仍然需要反射來實際查詢並呼叫該方法。自Java 5起, 增加了註解，所以Spring 也支援帶註解的標記方法，將它們標識為Spring應該例項化的物件，識別需要注入的依賴項，以及識別應該呼叫的初始化和銷燬​​方法。

最後一項 InitDestroyBeanPostProcessor 由其子類或其中一個子類處理。後處理器是一種特殊的物件，由Spring例項化，實現後處理器介面。因為它實現了這個介面，所以Spring會在每個Spring例項化的物件上呼叫一個方法，允許它修改甚至替換該物件。這是Spring採用模組化架構方法的一部分，可以更輕鬆地擴充套件功能。

這是怎麼運作的?

事實上， JSR-250 確定了一些“常見”註解，包括 @PostConstruct, 用於標記初始化方法,@PreDestroy 註解, 用於註解銷燬方法的。不同的是，InitDestroyBeanPostProcessor 被設計成可以處理任何註解集，因此它提供了識別註解的方法：

    public void setInitAnnotationType(Class<? extends Annotation> initAnnotationType) {
        this.initAnnotationType = initAnnotationType;
    }
...
    public void setDestroyAnnotationType(Class<? extends Annotation> destroyAnnotationType) {
        this.destroyAnnotationType = destroyAnnotationType;
    }

請注意，這些是普通的 setter 方法，因此這個物件本身可以使用 Spring 進行設定。就我而言，我使用Spring 的 StaticApplicationContext，見我以前的文章。

一旦 Spring 例項化了各種物件並注入了所有依賴項，它就會在所有後處理器上為每個物件呼叫 postProcessBeforeInitialization 方法 。這使後處理器有機會在初始化之前修改或替換物件。因為已經注入了依賴項，所以這是 InitDestroyAnnotationBeanPostProcessor 呼叫初始化方法的地方。

    LifecycleMetadata metadata = findLifecycleMetadata(bean.getClass());
    try {
        metadata.invokeInitMethods(bean, beanName);
    }

由於我們對程式碼如何處理註解感興趣，我們感興趣 findLifecycleMetadata() 方法，因為這是對類進行檢查的地方。該方法檢查快取，該快取用於避免執行超過必要的反射，因為它可能很昂貴。如果尚未檢查該類，則呼叫 buildLifecycleMetadata() 方法。該方法的內容如下：

ReflectionUtils.doWithLocalMethods(targetClass, new ReflectionUtils.MethodCallback() {
    @Override
    public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {
        if (initAnnotationType != null) {
            if (method.getAnnotation(initAnnotationType) != null) {
                LifecycleElement element = new LifecycleElement(method);
                currInitMethods.add(element);
            }
        }
        ...
    }
});

這裡 ReflectionUtils 是一個方便的類，簡化了反射的使用。除此之外，它還將經過反射的眾多已檢查異常轉換為未經檢查的異常(?)，從而使事情變得更容易。此特定方法僅迭代本地方法（即不是繼承的方法），併為每個方法呼叫回撥。

完成所有設定之後，檢查註解的部分非常無聊; 它只是呼叫Java反射方法來檢查註解，如果找到它，則將該方法儲存為初始化方法。

總結

事實上，這裡最終發生的事情很簡單，這就是我在教反射時所要做的事情。除錯使用註解來控制行為的程式碼可能具有挑戰性，因為從外部來看它非常不透明，所以很難想象發生了什麼（或者沒有發生）和什麼時候發生。但最終，正在發生的事情只是Java程式碼; 它可能不會立即顯現出程式碼的位置，但它就在那裡。

相關文章