spring-lifecycle.png

Lifecycle callbacks

Initialization callbacks、Destruction callbacks
要與容器的bean生命周期管理交互,即容器在啟動(dòng)后和容器在銷毀前對每個(gè)bean執(zhí)行操作，有如下三種方法:

1.實(shí)現(xiàn)Spring框架的InitializingBean和DisposableBean接口。容器為前者調(diào)用afterPropertiesSet()方法，為后者調(diào)用destroy()方法，以允許bean在初始化和銷毀bean時(shí)執(zhí)行某些操作。

public class HelloLifeCycle implements InitializingBean, DisposableBean {
    
    public void afterPropertiesSet() throws Exception {
        System.out.println("afterPropertiesSet 啟動(dòng)");
    }

    public void destroy() throws Exception {
        System.out.println("DisposableBean 停止");
    }
}

2.bean自定義初始化方法和銷毀方法,然后在定義bean時(shí)指定初始化方法和銷毀方法

 <bean id="helloLifeCycle" class="com.hzways.life.cycle.HelloLifeCycle" init-method="init3"
          destroy-method="destroy3"/>

3.JSR-250 @PostConstruct和@PreDestroy注解通常被認(rèn)為是在現(xiàn)代Spring應(yīng)用程序中接PostConstruct注解用于方法上，該方法在初始化的依賴注入操作之后被執(zhí)行。這個(gè)方法必須在class被放到service之后被執(zhí)行，這個(gè)注解所在的類必須支持依賴注入。

public class HelloLifeCycle {

    @PostConstruct
    private void init2() {
        System.out.println("PostConstruct 啟動(dòng)");
    }

    @PreDestroy
    private void destroy2() {
        System.out.println("PreDestroy 停止");
    }

}

Note：注意
PostConstruct注解用于方法上，該方法在初始化的依賴注入操作之后被執(zhí)行。因此,容器必須要開啟支持注解形式的依賴注入的功能,加入如下配置即可:

 <context:annotation-config/>

如果一個(gè)bean同時(shí)實(shí)現(xiàn)上述三種形式,調(diào)用順序?yàn)?

• 創(chuàng)建bean時(shí)

1. @PostConstruct 注解方式
2. InitializingBean 實(shí)現(xiàn)接口方式
3. custom init() 自定義初始化方法方式

• 銷毀bean時(shí)

1. @PreDestroy 注解方式
2. DisposableBean  實(shí)現(xiàn)接口方式
3. custom destroy() 自定義銷毀方法方式

Spring bean的生命周期

Startup and shutdown callbacks
結(jié)合生命周期機(jī)制,生命周期接口定義了任何具有自身生命周期需求的對象的基本方法(例如，啟動(dòng)和停止一些后臺過程):

Lifecycle 生命周期回調(diào)鉤子

public interface Lifecycle {
    /**
     * 啟動(dòng)當(dāng)前組件
     * <p>如果組件已經(jīng)在運(yùn)行，不應(yīng)該拋出異常
     * <p>在容器的情況下，這會(huì)將 開始信號 傳播到應(yīng)用的所有組件中去。
     */
    void start();
    /**
     * (1)通常以同步方式停止該組件，當(dāng)該方法執(zhí)行完成后,該組件會(huì)被完全停止。當(dāng)需要異步停    
         * 止行為時(shí)，考慮實(shí)現(xiàn)SmartLifecycle 和它的 stop(Runnable) 方法變體。

注意，此停止通知在銷毀前不能保證到達(dá):在*常規(guī)關(guān)閉時(shí)，{@code Lifecycle} bean將首先收到一個(gè)停止通知，然后才傳播*常規(guī)銷毀回調(diào);然而，在*上下文的生命周期內(nèi)的熱刷新或中止的刷新嘗試上，只調(diào)用銷毀方法

對于容器，這將把停止信號傳播到應(yīng)用的所有組件*
     */
    void stop();

    /**
      *  檢查此組件是否正在運(yùn)行。
      *  1. 只有該方法返回false時(shí)，start方法才會(huì)被執(zhí)行。
      *  2. 只有該方法返回true時(shí)，stop(Runnable callback)或stop()方法才會(huì)被執(zhí)行。
      */
    boolean isRunning();

}

LifeCycle定義Spring容器對象的生命周期，任何spring管理對象都可以實(shí)現(xiàn)該接口。
然后，當(dāng)ApplicationContext本身接收啟動(dòng)和停止信號(例如在運(yùn)行時(shí)停止/重啟場景)時(shí)，spring容器將在容器上下文中找出所有實(shí)現(xiàn)了LifeCycle及其子類接口的類，并一一調(diào)用它們實(shí)現(xiàn)的類。spring是通過委托給生命周期處理器LifecycleProcessor來實(shí)現(xiàn)這一點(diǎn)的。

LifecycleProcessor 生命周期處理器

請注意，LifecycleProcessor本身就是LifeCycle接口的擴(kuò)展。它還添加了另外兩個(gè)方法來響應(yīng)spring容器上下文的刷新(onRefresh)和關(guān)閉(close)。

public interface LifecycleProcessor extends Lifecycle {
    /**
     * 響應(yīng)Spring容器上下文 refresh
     */
    void onRefresh();

    /**
     * 響應(yīng)Spring容器上下文 close
     */
    void onClose();
}

Lifecycle 生命周期的不足

常規(guī)的LifeCycle接口只是在容器上下文顯式的調(diào)用start()/stop()方法時(shí)，才會(huì)去回調(diào)LifeCycle的實(shí)現(xiàn)類的start stop方法邏輯。并不意味著在上下文刷新時(shí)自動(dòng)啟動(dòng)。

我們可以定義一個(gè)類實(shí)現(xiàn)Lifecycle

public class HelloLifeCycle implements Lifecycle {
    private volatile boolean running = false;

    public HelloLifeCycle() {
        System.out.println("構(gòu)造方法!!!");
    }

   
    @Override
    public void start() {
        System.out.println("lifycycle start");
        running = true;

    }
   @Override
    public void stop() {
        System.out.println("lifycycle stop");
        running = false;
    }

    @Override
    public boolean isRunning() {
        return running;
    }
}

寫一個(gè)測試類并在main方法里面啟動(dòng)spring容器，這里沒有顯示的調(diào)用context的start()和close()方法

public static void main(String[] args) throws InterruptedException {
        ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath*:services.xml");
}

結(jié)果是，控制臺沒有任何輸出,容器并沒有調(diào)用生命周期的回調(diào)方法.

當(dāng)我們將啟動(dòng)容器的類，顯式的加上start和stop方法后:

public static void main(String[] args) throws InterruptedException {
        ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath*:services.xml");
        applicationContext.start();
        applicationContext.close();
}

這時(shí)我們看控制臺,spring容器回調(diào)了生命周期的方法

lifycycle.png

SmartLifecycle 自動(dòng)的生命周期擴(kuò)展

那么,如果Spring容器上下文沒有顯式的調(diào)用start和destory(或者close,stop)等方法時(shí)，我們也需要做到生命周期回調(diào)，怎么做?

于是SmartLifecycle可以做到這一點(diǎn),它繼承自Lifecycle接口，新增了如下幾個(gè)方法:

public interface SmartLifecycle extends Lifecycle, Phased {

    /**
      * 如果該`Lifecycle`類所在的上下文在調(diào)用`refresh`時(shí),希望能夠自己自動(dòng)進(jìn)行回調(diào)，則返回`true`* ,
      * false的值表明組件打算通過顯式的start()調(diào)用來啟動(dòng)，類似于普通的Lifecycle實(shí)現(xiàn)。
     */
    boolean isAutoStartup();

    /**
     * Indicates that a Lifecycle component must stop if it is currently running.
     * <p>The provided callback is used by the {@link LifecycleProcessor} to support
     * an ordered, and potentially concurrent, shutdown of all components having a
     * common shutdown order value. The callback <b>must</b> be executed after
     * the {@code SmartLifecycle} component does indeed stop.
     * <p>The {@link LifecycleProcessor} will call <i>only</i> this variant of the
     * {@code stop} method; i.e. {@link Lifecycle#stop()} will not be called for
     * {@code SmartLifecycle} implementations unless explicitly delegated to within
     * the implementation of this method.
     * @see #stop()
     * @see #getPhase()
     */
    void stop(Runnable callback);

}

SmartLifecycle用于細(xì)粒度控制特定bean的自動(dòng)啟動(dòng)(包括啟動(dòng)階段)。另外，請注意，stop通知在銷毀前不能保證到達(dá)，在常規(guī)關(guān)閉時(shí)，所有生命周期bean將首先收到停止通知，然后才傳播一般的銷毀回調(diào);但是，在上下文生命周期內(nèi)的熱刷新或中止刷新嘗試時(shí)，只調(diào)用銷毀方法。

容器中實(shí)現(xiàn)了Lifecycle的多個(gè)類如果希望有順序的進(jìn)行回調(diào)時(shí)，那么啟動(dòng)和關(guān)閉調(diào)用的順序可能很重要。如果任何兩個(gè)對象之間存在依賴關(guān)系，那么依賴方將在依賴后開始，在依賴前停止。然而，有時(shí)直接依賴關(guān)系是未知的。您可能只知道某個(gè)類型的對象應(yīng)該在另一個(gè)類型的對象之前開始。在這些情況下，SmartLifecycle接口定義了另一個(gè)選項(xiàng)，即在其超接口上定義的getPhase()方法。

當(dāng)開始時(shí)，getPhase()返回值最小的對象先開始，當(dāng)停止時(shí)，遵循相反的順序。因此，實(shí)現(xiàn)SmartLifecycle的對象及其getPhase()方法返回Integer.MIN_VALUE將在第一個(gè)開始和最后一個(gè)停止。相反，MAX_VALUE將指示對象應(yīng)該在最后啟動(dòng)并首先停止(可能是因?yàn)樗蕾囉谝\(yùn)行的其他進(jìn)程)。

SmartLifecycle對象的默認(rèn)phase是0。因此，任何實(shí)現(xiàn)類的phase的值為負(fù)數(shù)時(shí)都表明一個(gè)對象應(yīng)該在這些標(biāo)準(zhǔn)的生命周期回調(diào)之前進(jìn)行執(zhí)行，反之亦然。

如您所見，SmartLifecycle定義的stop方法接受一個(gè)回調(diào)。在實(shí)現(xiàn)的關(guān)閉過程完成之后，任何實(shí)現(xiàn)都必須調(diào)用回調(diào)的run()方法。這允許在必要時(shí)進(jìn)行異步關(guān)閉，因?yàn)?code>LifecycleProcessor接口，即DefaultLifecycleProcessor，的默認(rèn)實(shí)現(xiàn)，將等待每個(gè)階段中的對象組的超時(shí)值來調(diào)用這個(gè)回調(diào)。默認(rèn)的每個(gè)階段超時(shí)為30秒。您可以通過在上下文中定義一個(gè)名為lifecycleProcessor的bean來覆蓋默認(rèn)的生命周期處理器實(shí)例。如果您只想修改超時(shí)，那么定義以下內(nèi)容就足夠了:

<bean id="lifecycleProcessor" class="org.springframework.context.support.DefaultLifecycleProcessor">
    <!-- timeout value in milliseconds -->
    <property name="timeoutPerShutdownPhase" value="10000"/>
</bean>

如前所述，LifecycleProcessor接口也定義了用于刷新和關(guān)閉上下文的回調(diào)方法。后者將簡單地驅(qū)動(dòng)關(guān)機(jī)過程，就好像已經(jīng)顯式地調(diào)用了stop()一樣，但它將在上下文關(guān)閉時(shí)發(fā)生。另一方面，refresh回調(diào)支持SmartLifecycle bean的另一個(gè)特性。當(dāng)刷新上下文(在所有對象實(shí)例化和初始化之后)時(shí)，將調(diào)用這個(gè)回調(diào)，此時(shí)，默認(rèn)的生命周期處理器將檢查每個(gè)SmartLifecycle對象的isAutoStartup()方法返回的布爾值。如果是true，那么該對象將在此時(shí)啟動(dòng)，而不是等待上下文或其自己的start()方法的顯式調(diào)用(與上下文刷新不同，上下文啟動(dòng)不會(huì)自動(dòng)發(fā)生在標(biāo)準(zhǔn)上下文實(shí)現(xiàn)中)?！半A段”值以及任何“依賴”關(guān)系將以如上所述的方式確定啟動(dòng)順序。

總結(jié)

Lifecycle接口是為啟動(dòng)或停止生命周期,控制定義方法的通用接口。
*這方面的典型用例是控制異步處理。
<b>注意:此接口不包含特定的auto-startup(自動(dòng)啟動(dòng)) 語義。
考慮為此目的實(shí)現(xiàn){@link SmartLifecycle}。</b>

<p>可以由兩個(gè)組件(通常是在* Spring上下文中定義的Spring bean)和容器(通常是Spring {@link ApplicationContext} *本身)實(shí)現(xiàn)。

容器將把開始/停止信號傳播到每個(gè)容器中*應(yīng)用的所有組件，例如在運(yùn)行時(shí)的停止/重啟場景。

可用于直接調(diào)用或通過JMX進(jìn)行管理操作。在后一種情況下，{@link org.springframework.jmx.export。mbeanexports} 通常是用一個(gè) {@link org.springframework.jmx.export.assembler來定義的。InterfaceBasedMBeanInfoAssembler} *將活動(dòng)控制的組件的可見性限制在Lifecycle 接口。 * * <p>

注意，<b>生命周期接口僅支持top-level 并且單例的 bean </b>。

在任何其他組件上，生命周期接口將保持未被檢測到的*，因此將被忽略。

另外，請注意擴(kuò)展的{@link SmartLifecycle}接口*提供了與應(yīng)用程序上下文的啟動(dòng)和關(guān)閉階段的集成

Shutting down the Spring IoC container gracefully in non-web applications