ShutdownHook介紹

在java程序中，很容易在進(jìn)程結(jié)束時添加一個鉤子，即ShutdownHook。通常在程序啟動時加入以下代碼即可

Runtime.getRuntime().addShutdownHook(new Thread(){
    @Override
    public void run() {
        System.out.println("I'm shutdown hook...");
    }
});

有了ShutdownHook我們可以

• 在進(jìn)程結(jié)束時做一些善后工作，例如釋放占用的資源，保存程序狀態(tài)等
• 為優(yōu)雅（平滑）發(fā)布提供手段，在程序關(guān)閉前摘除流量
  

不少java中間件或框架都使用了ShutdownHook的能力，如dubbo、spring等。

spring中在application context被load時會注冊一個ShutdownHook。 這個ShutdownHook會在進(jìn)程退出前執(zhí)行銷毀bean，發(fā)出ContextClosedEvent等動作。 而dubbo在spring框架下正是監(jiān)聽了ContextClosedEvent，調(diào)用dubboBootstrap.stop()來實(shí)現(xiàn)清理現(xiàn)場和dubbo的優(yōu)雅發(fā)布，spring的事件機(jī)制默認(rèn)是同步的，所以能在publish事件時等待所有監(jiān)聽者執(zhí)行完畢。

ShutdownHook原理

ShutdownHook的數(shù)據(jù)結(jié)構(gòu)與執(zhí)行順序

• 當(dāng)我們添加一個ShutdownHook時，會調(diào)用ApplicationShutdownHooks.add(hook)，往ApplicationShutdownHooks類下的靜態(tài)變量private static IdentityHashMap<Thread, Thread> hooks添加一個hook，hook本身是一個thread對象
• ApplicationShutdownHooks類初始化時會把hooks添加到Shutdown的hooks中去，而Shutdown的hooks是系統(tǒng)級的ShutdownHook，并且系統(tǒng)級的ShutdownHook由一個數(shù)組構(gòu)成，只能添加10個
• 系統(tǒng)級的ShutdownHook調(diào)用了thread類的run方法，所以系統(tǒng)級的ShutdownHook是同步有序執(zhí)行的

private static void runHooks() {
    for (int i=0; i < MAX_SYSTEM_HOOKS; i++) {
        try {
            Runnable hook;
            synchronized (lock) {
                // acquire the lock to make sure the hook registered during
                // shutdown is visible here.
                currentRunningHook = i;
                hook = hooks[i];
            }
            if (hook != null) hook.run();
        } catch(Throwable t) {
            if (t instanceof ThreadDeath) {
                ThreadDeath td = (ThreadDeath)t;
                throw td;
            }
        }
    }
}

• 系統(tǒng)級的ShutdownHook的add方法是包可見，即我們不能直接調(diào)用它
• ApplicationShutdownHooks位于下標(biāo)1處，且應(yīng)用級的hooks，執(zhí)行時調(diào)用的是thread類的start方法，所以應(yīng)用級的ShutdownHook是異步執(zhí)行的，但會等所有hook執(zhí)行完畢才會退出。

static void runHooks() {
    Collection<Thread> threads;
    synchronized(ApplicationShutdownHooks.class) {
        threads = hooks.keySet();
        hooks = null;
    }

    for (Thread hook : threads) {
        hook.start();
    }
    for (Thread hook : threads) {
        while (true) {
            try {
                hook.join();
                break;
            } catch (InterruptedException ignored) {
            }
        }
    }
}

用一副圖總結(jié)如下：

ShutdownHook觸發(fā)點(diǎn)

從Shutdown的runHooks順藤摸瓜，我們得出以下這個調(diào)用路徑

Shutdown.exit

跟進(jìn)Shutdown.exit的調(diào)用方，發(fā)現(xiàn)有 Runtime.exit 和 Terminator.setup

• Runtime.exit 是代碼中主動結(jié)束進(jìn)程的接口
• Terminator.setup 被 initializeSystemClass 調(diào)用，當(dāng)?shù)谝粋€線程被初始化的時候被觸發(fā)，觸發(fā)后注冊了一個信號監(jiān)控函數(shù)，捕獲kill發(fā)出的信號，調(diào)用Shutdown.exit結(jié)束進(jìn)程
  

這樣覆蓋了代碼中主動結(jié)束進(jìn)程和被kill殺死進(jìn)程的場景。

主動結(jié)束進(jìn)程不必介紹，這里說一下信號捕獲。在java中我們可以寫出如下代碼來捕獲kill信號，只需要實(shí)現(xiàn)SignalHandler接口以及handle方法，程序入口處注冊要監(jiān)聽的相應(yīng)信號即可，當(dāng)然不是每個信號都能捕獲處理。

public class SignalHandlerTest implements SignalHandler {

    public static void main(String[] args) {

        Runtime.getRuntime().addShutdownHook(new Thread() {
            @Override
            public void run() {
                System.out.println("I'm shutdown hook ");
            }
        });

        SignalHandler sh = new SignalHandlerTest();
        Signal.handle(new Signal("HUP"), sh);
        Signal.handle(new Signal("INT"), sh);
        //Signal.handle(new Signal("QUIT"), sh);// 該信號不能捕獲
        Signal.handle(new Signal("ABRT"), sh);
        //Signal.handle(new Signal("KILL"), sh);// 該信號不能捕獲
        Signal.handle(new Signal("ALRM"), sh);
        Signal.handle(new Signal("TERM"), sh);

        while (true) {
            System.out.println("main running");
            try {
                Thread.sleep(2000L);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    }

    @Override
    public void handle(Signal signal) {
        System.out.println("receive signal " + signal.getName() + "-" + signal.getNumber());
        System.exit(0);
    }
}

要注意的是通常來說，我們捕獲信號，做了一些個性化的處理后需要主動調(diào)用System.exit，否則進(jìn)程就不會退出了，這時只能使用kill -9來強(qiáng)制殺死進(jìn)程了。

而且每次信號的捕獲是在不同的線程中，所以他們之間的執(zhí)行是異步的。

Shutdown.shutdown

這個方法可以看注釋

/* Invoked by the JNI DestroyJavaVM procedure when the last non-daemon
  * thread has finished.  Unlike the exit method, this method does not
  * actually halt the VM.
  */

翻譯一下就是該方法會在最后一個非daemon線程（非守護(hù)線程）結(jié)束時被JNI的DestroyJavaVM方法調(diào)用。

java中有兩類線程，用戶線程和守護(hù)線程，守護(hù)線程是服務(wù)于用戶線程，如GC線程，JVM判斷是否結(jié)束的標(biāo)志就是是否還有用戶線程在工作。 當(dāng)最后一個用戶線程結(jié)束時，就會調(diào)用 Shutdown.shutdown。這是JVM這類虛擬機(jī)語言特有的"權(quán)利"，倘若是golang這類編譯成可執(zhí)行的二進(jìn)制文件時，當(dāng)全部用戶線程結(jié)束時是不會執(zhí)行ShutdownHook的。

舉個例子，當(dāng)java進(jìn)程正常退出時，沒有在代碼中主動結(jié)束進(jìn)程，也沒有kill，就像這樣

public static void main(String[] args) {

    Runtime.getRuntime().addShutdownHook(new Thread() {
        @Override
        public void run() {
            super.run();
            System.out.println("I'm shutdown hook ");
        }
    });
}

當(dāng)main線程運(yùn)行完了后，也能打印出I'm shutdown hook，反觀golang就做不到這一點(diǎn)（如果可以做到，可以私信告訴我，我是個golang新手）

通過如上兩個調(diào)用的分析，我們概括出如下結(jié)論：

我們能看出java的ShutdownHook其實(shí)覆蓋的非常全面了，只有一處無法覆蓋，即當(dāng)我們殺死進(jìn)程時使用了kill -9時，由于程序無法捕獲處理，進(jìn)程被直接殺死，所以無法執(zhí)行ShutdownHook。

總結(jié)

綜上，我們得出一些結(jié)論

• 重寫捕獲信號需要注意主動退出進(jìn)程，否則進(jìn)程可能永遠(yuǎn)不會退出，捕獲信號的執(zhí)行是異步的
• 用戶級的ShutdownHook是綁定在系統(tǒng)級的ShutdownHook之上，且用戶級是異步執(zhí)行，系統(tǒng)級是同步順序執(zhí)行，用戶級處于系統(tǒng)級執(zhí)行順序的第二位
• ShutdownHook 覆蓋的面比較廣，不論是手動調(diào)用接口退出進(jìn)程，還是捕獲信號退出進(jìn)程，抑或是用戶線程執(zhí)行完畢退出，都會執(zhí)行ShutdownHook，唯一不會執(zhí)行的就是kill -9

以上就是Java ShutdownHook原理詳解的詳細(xì)內(nèi)容，更多關(guān)于Java ShutdownHook原理的資料請關(guān)注腳本之家其它相關(guān)文章！