Tomcat 学习进阶历程之关闭钩子

使用JAVA的过程中，经常遇到程序启动时初始化一下资源，或生成一下临时文件，程序退出时要清除这些临时文件，或者程序退出时执行一下必要的其他操作。如果程序是通过我们提供的关闭/退出按钮正常退出的，一切还都好处理，但是如果用户直接关闭虚拟机运行的窗口，那一切就会变的比较复杂。

好在java提供了一种优雅的方式去解决这种问题。使得关闭的善后处理的代码能执行。java的关闭钩子能确保总是执行，无论用户如何终止应用程序。除非用户kill，这个是个死穴。

 

对java而言，虚拟机会对以下几种操作进行关闭：

(1)系统调用System.exit()方法

(2)程序最后一个守护线程退出时，应用程序正常退出。

(3)用户强行中断程序运行，比如ctrl+c等其他方式中断java程序

 

关闭钩子的生成：

1.创建Thread的子类

2.实现run方法，应用程序关闭时会调用该方法，不需要调用start方法

3.在应用中实例化关闭钩子类

4.使用Runtime注册关闭钩子

下面是一个使用关闭钩子的例子：

public class ShutDownHook extends Thread{ 
public static void main(String[] args){ 
Runtime.getRuntime().addShutdownHook(new ShutDownHook()); 
for(int i=0;i<10;i++){ 
System.out.println("i="+i); 
if(i==4){ 
System.exit(0); 
} 
try { 
Thread.sleep(1000); 
} catch (InterruptedException e) { 
// TODO Auto-generated catch block 
e.printStackTrace(); 
} 
} 
} 
public void run(){ 
System.out.println("hook shutdown!"); 
} 
}

使用Runtime.getRuntime().addShutdownHook方法注册钩子后，程序在非正常关闭是会执行钩子程序run方法中的相关代码。

Tomcat中的关闭钩子：

在Tomcat的Catalina类中有一个钩子内部类的定义：

protected class CatalinaShutdownHook extends Thread {
        public void run() {
            try {
                if (getServer() != null) {
                    Catalina.this.stop();
                }
            } catch (Throwable ex) {
                log.error(sm.getString("catalina.shutdownHookFail"), ex);
            } finally {
                // If JULI is used, shut JULI down *after* the server shuts down
                // so log messages aren't lost
                LogManager logManager = LogManager.getLogManager();
                if (logManager instanceof ClassLoaderLogManager) {
                    ((ClassLoaderLogManager) logManager).shutdown();
                }
            }
        }
    }

钩子程序因为是Catalina的内部类，所以它可以调用Catalina类中的相关方法。其调用了stop方法用于关闭相关服务组件。

在Catalina的start方法中将钩子进行了注册：

if (useShutdownHook) {
                if (shutdownHook == null) {
                    shutdownHook = new CatalinaShutdownHook();
                }
                Runtime.getRuntime().addShutdownHook(shutdownHook);

我们知道Tomcat启动时Catalina的Start方法会被调用，所以钩子在tomcat启动时就会被注册到虚拟机。