ShutdownHook原理

微信搜索“捉虫大师”,点赞、关注是对我最大的鼓励

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

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zgyfyx.html