[[394735]]

ShutdownHook介紹

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

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

有了ShutdownHook我們可以

• 在進程結束時做一些善后工作，例如釋放占用的資源，保存程序狀態等
• 為優雅(平滑)發布提供手段，在程序關閉前摘除流量

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

spring在application context被load時會注冊一個ShutdownHook。這個ShutdownHook會在進程退出前執行銷毀bean，發出ContextClosedEvent等動作。而dubbo在spring框架下正是監聽了ContextClosedEvent，調用dubboBootstrap.stop()來實現清理現場和dubbo的優雅發布，spring的事件機制默認是同步的，所以能在publish事件時等待所有監聽者執行完畢。

ShutdownHook原理

ShutdownHook的數據結構與執行順序

• 當我們添加一個ShutdownHook時，會調用ApplicationShutdownHooks.add(hook)，往ApplicationShutdownHooks類下的靜態變量private static IdentityHashMap
• ApplicationShutdownHooks類初始化時會把hooks添加到Shutdown的hooks中去，而Shutdown的hooks是系統級的ShutdownHook，并且系統級的ShutdownHook由一個數組構成，只能添加10個
• 系統級的ShutdownHook調用了thread類的run方法，所以系統級的ShutdownHook是同步有序執行的

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; 
            } 
        } 
    } 
} 

• 系統級的ShutdownHook的add方法是包可見，即我們不能直接調用它
• ApplicationShutdownHooks位于下標1處，且應用級的hooks，執行時調用的是thread類的start方法，所以應用級的ShutdownHook是異步執行的，但會等所有hook執行完畢才會退出。

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) { 
            } 
        } 
    } 
} 

用一副圖總結如下：

ShutdownHook觸發點

從Shutdown的runHooks順藤摸瓜，我們得出以下兩個調用路徑

重點看Shutdown.exit 和 Shutdown.shutdown

Shutdown.exit

跟進Shutdown.exit的調用方，發現有 Runtime.exit 和 Terminator.setup

• Runtime.exit 是代碼中主動結束進程的接口
• Terminator.setup 被 initializeSystemClass 調用，當第一個線程被初始化的時候被觸發，觸發后注冊一個信號監聽函數，捕獲kill發出的信號，調用Shutdown.exit結束進程

這樣覆蓋了代碼中主動結束進程和被kill殺死進程的場景。

主動結束進程不必介紹，這里說一下信號捕獲。在java中我們可以寫出如下代碼來捕獲kill信號，只需要實現SignalHandler接口以及handle方法，程序入口處注冊要監聽的信號即可，當然不是每個信號都能捕獲處理。

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); 
    } 
} 

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

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

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線程(非守護線程)結束時被JNI的DestroyJavaVM方法調用。

java中有兩類線程，用戶線程和守護線程，守護線程是服務于用戶線程，如GC線程，JVM判斷是否結束的標志就是是否還有用戶線程在工作。當最后一個用戶線程結束時，就會調用 Shutdown.shutdown。這是JVM這類虛擬機語言特有的"權利"，倘若是golang這類編譯成可執行的二進制文件時，當全部用戶線程結束時是不會執行ShutdownHook的。

舉個例子，當java進程正常退出時，沒有在代碼中主動結束進程，也沒有kill，就像這樣

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

當main線程運行完了后，也能打印出I'm shutdown hook，反觀golang就做不到這一點

通過如上兩個調用的分析，我們概括出如下結論：

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

總結

綜上，我們得出一些結論

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