ShutdownHook原理

捉蟲大師發表於2021-10-22
Hook

微信搜尋“捉蟲大師”，點贊、關注是對我最大的鼓勵

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<Thread, Thread> hooks新增一個hook，hook本身是一個thread物件
  • 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) {
            }
        }
    }
}

用一副圖總結如下：
image

ShutdownHook觸發點

從Shutdown的runHooks順藤摸瓜，我們得出以下這個呼叫路徑
image

重點看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() {
            super.run();
            System.out.println("I'm shutdown hook ");
        }
    });
}

當main執行緒執行完了後，也能列印出I'm shutdown hook，反觀golang就做不到這一點（如果可以做到，可以私信告訴我，我是個golang新手）

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

image

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

總結

綜上，我們得出一些結論

  • 重寫捕獲訊號需要注意主動退出程式，否則程式可能永遠不會退出，捕獲訊號的執行是非同步的
  • 使用者級的ShutdownHook是繫結在系統級的ShutdownHook之上，且使用者級是非同步執行，系統級是同步順序執行，使用者級處於系統級執行順序的第二位
  • ShutdownHook 覆蓋的面比較廣，不論是手動呼叫介面退出程式，還是捕獲訊號退出程式，抑或是使用者執行緒執行完畢退出，都會執行ShutdownHook，唯一不會執行的就是kill -9

關於作者：公眾號"捉蟲大師"作者，專注後端的中介軟體開發，關注我，給推送你最純粹的技術乾貨

相關文章