在線上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里面的代碼。