本文首發於 vivo互聯網技術 微信公衆號
鏈接:https://mp.weixin.qq.com/s/ZqkmoAR4JEYr0x0Suoq7QQ
作者:馬運傑
本文通過閱讀Tomcat啓動和關閉流程的源碼,深入分析不同的Tomcat關閉方式背後的原理,讓開發人員能夠了解在使用不同的關閉方式時需要注意的點,避免因JVM進程異常退出導致的各種非預見性錯誤。
一、 Tomcat的啓動過程
要了解Tomcat關閉的原理,首先需要關注下Tomcat是如何啓動的。這裏我們簡單介紹下。
Tomcat啓動的入口是Bootstrap類中的main方法,而後根據server.xml中的配置,對Server、Service、Enigin、Connector、Host、Context等組件進行初始化,之後便是啓動這些組件。我們重點來看下啓動之後,Tomcat做了哪些工作。
在Tomcat的各組件啓動完畢之後,main主線程會進入Catalina.out的await()方法,而此方法又是主要調用了Server組件的await()方法,從名字便可以看出,這個方法的目的是爲了阻塞當前線程(main主線程)。
分析await的源碼(源碼比較長,這裏截取了部分,全部的可以自行拉取Tomcat源碼進行閱讀)。
(StandardServer.await())
我們發現await()方法主要是根據server.xml中Server節點port屬性的設置做了以下幾種工作:
-
port爲-2時,函數直接退出,此時主線程不會阻塞。
-
port爲-1時,將等待線程設置爲當前線程,並且進入while循環,直到stopAwait標誌位置爲true
- port爲其他時,則會新建一個socket服務端,該socket綁定了當前服務器的ip以及port端口,隨後設置等待線程爲當前線程,並且socket進入阻塞監聽狀態,直到socket監聽到server.xml中預置的關閉字符串(默認是"SHUTDOWN")
在主線程退出等待後,就會進入Tomcat的關閉流程,進行各個組件的stop和destroy操作。從上述分析可以看出,要想停止Tomcat,就是要中斷main主線程的等待狀態。
下圖爲Tomcat的整個生命週期。
(Tomcat生命週期)
二、常見的關閉Tomcat的方式
1、我們下載的Tomcat壓縮包的bin目錄下,有一個由官方提供的腳本(shutdown.sh),可以用來結束Tomcat進程。
2、服務器上,我們還可以利用kill -x命令來結束Tomcat進程。
3、此外,代碼中的System.exit()以及OOM等異常情況的發生,也會導致Tomcat進程的關閉,但是這兩者都不是正常的運維手段,在此我們不做分析。
三、shutdown腳本
1、shutdown.sh的原理
查看分析官方的shutdown.sh腳本以及catalina.sh腳本,發現這兩個腳本最終是在調用Bootstrap類的main方法,和啓動Tomcat時調用的是同一個方法,差異在於傳入了"stop"作爲main方法的參數,而傳入了該參數的main方法,會調用Catalina類的stopServer()方法。在此我們抹去不需要關注的代碼,可以把整個stopServer()方法簡化爲如下4步:
其主要做了兩件事:
-
初始化Server組件,和Tomcat啓動時類似,這一步主要是解析server.xml文件,然後根據server.xml中的屬性初始化Tomcat組件的成員變量,這裏主要關注Server組件的幾個成員變量:port、address、shutdown,默認值分別爲8005、127.0.0.1、SHUTDOWN等,需要和啓動時讀取的server.xml保持一致。
- 往address port所監聽的Socket端口發生“SHUTDOWN”字符串。
至此,顯而易見的,這對應了第一小節中的第三種阻塞情況,"SHUTDOWN"字符串讓main主線程結束了等待狀態,並在接下來通過調用各組件的stop()和destroy()方法進行資源的釋放。
2、shutdown腳本的缺點
雖然shutdown腳本是由Tomcat官方出品,但是其在實際應用中並不廣泛,主要是由於下面兩個缺點:
-
從上述原理就可以分析出,shutdown腳本是基於啓動時監聽了相應的端口,這就允許任意人員,只要能夠發送"SHUTDOWN"字符串到相應的端口,就可以對Tomcat進程進行關閉,這對於生產環境是相當危險的。所以一般生產環境會將Server的port屬性設置爲-1
- shutdown腳本只是結束了main主線程的等待狀態,讓其正常的走下去。我們知道,JVM中的線程分爲守護線程和用戶線程兩種類型,守護線程會在所有用戶線程結束後,自動回收,進而導致JVM進程的退出。main主線程是一個用戶線程,但是隨着程序越來越複雜,可能會出現很多其他的用戶線程。比如我們平常開發過程中,常用的創建線程池的操作Executors.newFixedThreadPool(n) 便會創建n個用戶線程,這些線程在main主線程退出後,並不會自動回收,從而阻止了JVM的正常退出。所以經常會發生調用了shutdown腳本,但是Tomcat進程無法退出的場景。
四、kill -x
1、kill -9 or kill -15
Linux中的kill -x操作是向目標進程發送對應的信號量。可以用kill -l命令查看每個數值所代表的信號量的值。
(kill信號量)
這裏面,我們經常會使用kill-9這一命令,kill -9會立即強制結束當前進程,這個操作既方便,但同時也極具破壞性。在實際的環境中,我們可能有在running的任務,如果此時程序被強制關閉,便會導致當前任務數據的丟失,特別是時間特別長的任務,極有可能造成前功盡棄的局面。同時,如果程序設計不當,沒有相應的冪等操作,還有可能會造成實際環境中數據缺失或者髒數據的產生,對生產環境造成致命的問題。
相比kill -9, kill -15(15只是一個例子,Linux中還有其他的中斷信號)會相對優雅很多。kill -15是向進程發送一個TERM的中斷信號量,在JVM接收到該信號量後,會響應中斷,進而結束當前進程。而這一操作能夠優雅關閉Tomcat的原因在於,JVM在結束當前進程前,會啓動一系列名爲shutdownhook(關閉鉤子)的線程,而這些線程就會成爲我們進行風險控制的工具。接下來我們首先看看Tomcat中的關閉鉤子。
2、shutdownhook關閉鉤子
Tomcat的關閉鉤子的定義是在Catalina類中,有一個名爲CatalinaShutdownHook內部類,繼承了Thread類。跟着這個線程類中的run()方法往下看,其調用了Catalina的stop()方法,而此處stop方法,除了正常去停止各組件外,還會去中斷並快速結束main主線程(如果主線程還存在的話),最後再調用各組件的destroy()方法進行資源釋放。
(Tomcat中的shutdownhook)
除了Tomcat會使用關閉鉤子外,很多中間件也會使用到這一非常重要的功能。
我們在平常的開發過程中也可以使用關閉鉤子,可以在程序啓動或者運行階段通過調用Runtime.getRuntime().addShutdownHook(shutdownHook)方法進行鉤子的添加,但要注意的是,需要在關閉的流程中加入移除鉤子的代碼。
Spring中當然也有關閉鉤子的應用,並且還爲我們使用關閉鉤子提gong了更爲友好的編程體驗。
在Spring中,關閉鉤子是在AbstractApplicationContext.registerShutdownHook()方法中添加的(下圖中的代碼),而其關閉鉤子的run方法則會調用destroyBeans()方法,其對所有繼承了DisposableBean接口的類調用其destroy()方法。
讀到這裏我們就明白了,在平時開發時,如果有使用關閉鉤子的需求,可以通過繼承DisposableBean,並實現其destroy(),很方便的來達到我們回收資源,打掃戰場的目的。
3、shutdownhook的使用注意點
shutdownhook在使用中也並不是可以隨意亂用的,需要注意以下幾點:
-
shutdownhook的調用是不保證順序的
-
shutdownhook是JVM結束前調用的線程,所以該線程中的方法應儘量短,並且保證不能發生死鎖的情況,否則也會阻止JVM的正常退出
- shutdownhook中不能執行System.exit(),否則會導致虛擬機卡住,而不得不強行殺死進程
五、總結
本文對Tomcat兩種常用關閉方式的原理進行了解讀,從上述分析可以看出,用shutdown.sh腳本控制Tomcat關閉的方式存在權限的風險,並且也會由於開發中的線程操作導致Tomcat無法關閉,所以這種方法在實際應用中使用情況較少。
而kill -15則能夠安全的殺死Tomcat進程,並且由於JVM shutdownhook的存在,我們可以對整個程序關閉時進行更強有力的控制,退出過程也更爲優雅,所以使用較爲廣泛。