ShutdownHook介绍

在java程序中，很容易在进程结束时添加一个钩子，即ShutdownHook。通常在程序启动时加入以下代码即可

1. Runtime.getRuntime().addShutdownHook(new Thread(){ 
2.     @Override 
3.     public void run() { 
4.         System.out.println("I'm shutdown hook…"); 
5.     } 
6. }); 

有了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是同步有序执行的

1. private static void runHooks() { 
2.     for (int i=0; i < MAX_SYSTEM_HOOKS; i++) { 
3.         try { 
4.             Runnable hook; 
5.             synchronized (lock) { 
6.                 // acquire the lock to make sure the hook registered during 
7.                 // shutdown is visible here. 
8.                 currentRunningHook = i; 
9.                 hook = hooks[i]; 
10.             } 
11.             if (hook != null) hook.run(); 
12.         } catch(Throwable t) { 
13.             if (t instanceof ThreadDeath) { 
14.                 ThreadDeath td = (ThreadDeath)t; 
15.                 throw td; 
16.             } 
17.         } 
18.     } 
19. } 

• 系统级的ShutdownHook的add方法是包可见，即我们不能直接调用它
• ApplicationShutdownHooks位于下标1处，且应用级的hooks，执行时调用的是thread类的start方法，所以应用级的ShutdownHook是异步执行的，但会等所有hook执行完毕才会退出。

1. static void runHooks() { 
2.     Collection<Thread> threads; 
3.     synchronized(ApplicationShutdownHooks.class) { 
4.         threads = hooks.keySet(); 
5.         hooks = null; 
6.     } 
7.  
8.     for (Thread hook : threads) { 
9.         hook.start(); 
10.     } 
11.     for (Thread hook : threads) { 
12.         while (true) { 
13.             try { 
14.                 hook.join(); 
15.                 break; 
16.             } catch (InterruptedException ignored) { 
17.             } 
18.         } 
19.     } 
20. } 

用一副图总结如下：

ShutdownHook触发点

从Shutdown的runHooks顺藤摸瓜，我们得出以下两个调用路径

重点看Shutdown.exit 和 Shutdown.shutdown

Shutdown.exit

跟进Shutdown.exit的调用方，发现有 Runtime.exit 和 Terminator.setup

• Runtime.exit 是代码中主动结束进程的接口
• Terminator.setup 被 initializeSystemClass 调用，当第一个线程被初始化的时候被触发，触发后注册一个信号监听函数，捕获kill发出的信号，调用Shutdown.exit结束进程

这样覆盖了代码中主动结束进程和被kill杀死进程的场景。