在你的应用中添加关闭钩子

概述

启动一个服务通常很容易. 但是, 有时我们需要在停止应用之前执行一个钩子函数,以便优雅的关闭我们的应用. 本文中我们将研究JVM应用程序终止的不同方式. 然后, 我们将使用 Java APIs 管理 JVM shutdown hooks. 在本文中，我们将研究JVM应用程序可以终止的不同方式。然后，我们将使用Java API管理JVM关闭挂钩。

JVM Shutdown

可以通过两种不同的方式关闭JVM：

1、正常退出

2、异常退出

在以下任一情况下，程序将正常退出JVM：

最后一个非守护程序线程终止. 例如, 当main 线程退出时, the JVM 开始其关闭过程.
从操作系统发送中断信号。例如，通过按 Ctrl + C 或注销操作系统
Java代码调用System.exit()

尽管我们努力实现正常关闭，但有时JVM可能会以突然而意外的方式关闭. 在以下情况下, JVM突然意外关闭:

从操作系统发送终止信号. 例如, 通过执行 kill -9 <jvm_pid>
Java代码调用Runtime.getRuntime().halt()
主机OS意外宕机, 例如, 电源故障或其他系统紧急故障

Shutdown Hooks

JVM 允许在关闭之前执行其注册的功能. 这些功能通常用来释放资源或其他类似的任务. 在JVM 术语中, 这些功能被称之为 hutdown hooks . Shutdown hooks 基本上是已初始化但未启动的线程. 当开始其关闭过程时, 它将启动所有已注册的hooks(无顺序性). 运行玩所有钩子程序, JVM然后停止其进程.

添加 Hooks

想要增加一个shutdown hook, 我们可以使用 Runtime.getRuntime().addShutdownHook() 方法:

Thread printingHook = new Thread(() -> System.out.println("In the middle of a shutdown"));
Runtime.getRuntime().addShutdownHook(printingHook);

在这里,我们只是在JVM关闭之前将一些内容打印到标准输出中. 如果我们像下面那样关闭JVM:

> System.exit(129);
In the middle of a shutdown

然后，我们将看到该钩子实际上将消息打印到标准输出。

JVM负责启动hook线程. 因此, 如果给定的hook 已经启动, 则Java将引发异常:

Thread longRunningHook = new Thread(() -> {
    try {
        Thread.sleep(300);
    } catch (InterruptedException ignored) {}
});
longRunningHook.start();
 
assertThatThrownBy(() -> Runtime.getRuntime().addShutdownHook(longRunningHook))
  .isInstanceOf(IllegalArgumentException.class)
  .hasMessage("Hook already running");

显然，我们也不能多次注册同一个钩子：

Thread unfortunateHook = new Thread(() -> {});
Runtime.getRuntime().addShutdownHook(unfortunateHook);
 
assertThatThrownBy(() -> Runtime.getRuntime().addShutdownHook(unfortunateHook))
  .isInstanceOf(IllegalArgumentException.class)
  .hasMessage("Hook previously registered");

删除Hooks

Java 提供了一种孪生的remove 方法，用于在注册后删除特定的 shutdown hook :

Thread willNotRun = new Thread(() -> System.out.println("Won't run!"));
Runtime.getRuntime().addShutdownHook(willNotRun);
 
assertThat(Runtime.getRuntime().removeShutdownHook(willNotRun)).isTrue();

removeShutdownHook() 方法在成功删除shutdown hook 后返回true .

注意事项

JVM 仅在正常终止的情况下运行shutdown hooks . 因此, 当外部突然强制杀死 JVM 进程时, JVM 没有机会执行shutdown hooks. 另外, 使用Java代码关停JVM也将具有相同的效果(不会执行shutdown hooks):

Thread haltedHook = new Thread(() -> System.out.println("Halted abruptly"));
Runtime.getRuntime().addShutdownHook(haltedHook);
         
Runtime.getRuntime().halt(129);

halt 方法强制终止当前正在运行的 JVM. 因此, 已注册的shutdown hooks 将无法被执行.

结语

在本文中, 我们研究了JVM应用程序可能被终止的不同方式. 然后, 我们使用了常用运行时 APIs 来注册和注销 shutdown hooks. 和以前一样, 代码已经上传至 GitHub.