Java应用中使用ShutdownHook友好地清理现场
在线上Java程序中经常遇到进程程挂掉,一些状态没有正确的保存下来,这时候就需要在JVM关掉的时候执行一些清理现场的代码。Java中得ShutdownHook提供了比较好的方案。
JDK在1.3之后提供了Java Runtime.addShutdownHook(Thread hook)方法,可以注册一个JVM关闭的钩子,这个钩子可以在以下几种场景被调用:
- 1)程序正常退出
- 2)使用System.exit()
- 3)终端使用Ctrl+C触发的中断
- 4)系统关闭
- 5)使用Kill pid命令干掉进程
注:在使用kill -9 pid是不会JVM注册的钩子不会被调用。
在JDK中方法的声明:
public void addShutdownHook(Thread hook)
参数
hook -- 一个初始化但尚未启动的线程对象,注册到JVM钩子的运行代码。
异常
IllegalArgumentException -- 如果指定的钩已被注册,或如果它可以判定钩已经运行或已被运行
IllegalStateException -- 如果虚拟机已经是在关闭的过程中
SecurityException -- 如果存在安全管理器并且它拒绝的RuntimePermission(“shutdownHooks”)
代码示例:
使用Timer模拟一个工作线程,该线程重复工作十次,使用System.exit()退出,在清理现场代码CleanWorkThread 中,取消timer运行,并输出必要的日志信息。
1 package com.netease.test.java.lang; 2 3 import java.util.Timer; 4 import java.util.TimerTask; 5 import java.util.concurrent.atomic.AtomicInteger; 6 7 /** 8 * Date: 14-6-18 9 * Time: 11:01 10 * 测试ShutdownHook 11 */ 12 public class TestShutdownHook { 13 14 //简单模拟干活的 15 static Timer timer = new Timer("job-timer"); 16 17 //计数干活次数 18 static AtomicInteger count = new AtomicInteger(0); 19 20 /** 21 * hook线程 22 */ 23 static class CleanWorkThread extends Thread{ 24 @Override 25 public void run() { 26 System.out.println("clean some work."); 27 timer.cancel(); 28 try { 29 Thread.sleep(2 * 1000);//sleep 2s 30 } catch (InterruptedException e) { 31 e.printStackTrace(); 32 } 33 } 34 } 35 public static void main(String[] args) throws InterruptedException { 36 //将hook线程添加到运行时环境中去 37 Runtime.getRuntime().addShutdownHook(new CleanWorkThread()); 38 System.out.println("main class start ..... "); 39 //简单模拟 40 timer.schedule(new TimerTask() { 41 @Override 42 public void run() { 43 count.getAndIncrement(); 44 System.out.println("doing job " + count); 45 if (count.get() == 10) { //干了10次退出 46 System.exit(0); 47 } 48 } 49 }, 0, 2 * 1000); 50 51 } 52 }
运行后,可以模拟以上五种场景进行测试,只有kill -9 pid不会执行Hook里面的代码。