spring之SmartLifecycle

有些場景咱們須要在Spring 全部的bean 完成初始化後緊接着執行一些任務或者啓動須要的異步服務

常見有幾種解決方案

• j2ee 註解 啓動前@PostConstruct 銷燬前@PreDestroy
• springboot 的 org.springframework.boot.CommandLineRunner
• spring org.springframework.context.SmartLifecycle

這裏搞一下第三種 SmartLifecycle

 

import org.springframework.context.SmartLifecycle;
import org.springframework.stereotype.Component;

/**
 * SmartLifecycle測試
 *
 * 
 * 
 */
@Component
public class TestSmartLifecycle implements SmartLifecycle {

    private boolean isRunning = false;

    /**
     * 1. 咱們主要在該方法中啓動任務或者其餘異步服務，好比開啓MQ接收消息<br/>
     * 2. 當上下文被刷新（全部對象已被實例化和初始化以後）時，將調用該方法，默認生命週期處理器將檢查每一個SmartLifecycle對象的isAutoStartup()方法返回的布爾值。
     * 若是爲「true」，則該方法會被調用，而不是等待顯式調用本身的start()方法。
     */
    @Override
    public void start() {
        System.out.println("start");

        // 執行完其餘業務後，能夠修改 isRunning = true
        isRunning = true;
    }

    /**
     * 若是工程中有多個實現接口SmartLifecycle的類，則這些類的start的執行順序按getPhase方法返回值從小到大執行。<br/>
     * 例如：1比2先執行，-1比0先執行。 stop方法的執行順序則相反，getPhase返回值較大類的stop方法先被調用，小的後被調用。
     */
    @Override
    public int getPhase() {
        // 默認爲0
        return 0;
    }

    /**
     * 根據該方法的返回值決定是否執行start方法。<br/> 
     * 返回true時start方法會被自動執行，返回false則不會。
     */
    @Override
    public boolean isAutoStartup() {
        // 默認爲false
        return true;
    }

    /**
     * 1. 只有該方法返回false時，start方法纔會被執行。<br/>
     * 2. 只有該方法返回true時，stop(Runnable callback)或stop()方法纔會被執行。
     */
    @Override
    public boolean isRunning() {
        // 默認返回false
        return isRunning;
    }

    /**
     * SmartLifecycle子類的纔有的方法，當isRunning方法返回true時，該方法纔會被調用。
     */
    @Override
    public void stop(Runnable callback) {
        System.out.println("stop(Runnable)");

        // 若是你讓isRunning返回true，須要執行stop這個方法，那麼就不要忘記調用callback.run()。
        // 不然在你程序退出時，Spring的DefaultLifecycleProcessor會認爲你這個TestSmartLifecycle沒有stop完成，程序會一直卡着結束不了，等待必定時間（默認超時時間30秒）後纔會自動結束。
        // PS：若是你想修改這個默認超時時間，能夠按下面思路作，固然下面代碼是springmvc配置文件形式的參考，在SpringBoot中天然不是配置xml來完成，這裏只是提供一種思路。
        // <bean id="lifecycleProcessor" class="org.springframework.context.support.DefaultLifecycleProcessor">
        //      <!-- timeout value in milliseconds -->
        //      <property name="timeoutPerShutdownPhase" value="10000"/>
        // </bean>
        callback.run();

        isRunning = false;
    }

    /**
     * 接口Lifecycle的子類的方法，只有非SmartLifecycle的子類纔會執行該方法。<br/>
     * 1. 該方法只對直接實現接口Lifecycle的類才起做用，對實現SmartLifecycle接口的類無效。<br/>
     * 2. 方法stop()和方法stop(Runnable callback)的區別只在於，後者是SmartLifecycle子類的專屬。
     */
    @Override
    public void stop() {
        System.out.println("stop");

        isRunning = false;
    }

}