Tomcat启停脚本实现

问题

tomcat是一款非常实用强大的servlet container。但其停止过程一直让人困扰。由于$CATALINA_HOME/bin下的shutdown.sh必须等待所有处理线程退出才会生效，等待时间不可控，因此单靠shutdown.sh不能十分理想地关闭服务（至少在一段时间内不理想)。使得运维人员不得不频繁kill ps查看，造成重复操作。

我参考了startup.sh和shutdown.sh的写法，封装了下catalina.sh。

解决思路

简单谈谈解决思路，主要实现集中在关闭服务功能。shutdown_Tomcat函数首先调用catalina自带的shutdown.sh关闭服务，若返回失败，依次调用kill_Tomcat和Force_Tomcat函数。这两个函数内循环kill5次，每次间隔5s并检测存活与否，若是则返回0码。start_Tomcat先检测了当前tomcat实例，避免重复启动。

调用方法

cd $CATALINA_HOME/bin && sh tomcat_control.sh start
#cd $CATALINA_HOME/bin 不可省略

限制

1. 设定的是通过当前pwd来定位tomcat进程，因此一个启停脚本对应一个tomcat实例，且须放置在$CATALINA/bin下，也就是和catalina.sh同目录；
2. 使用tomcat_control.sh时，要先cd到$CATALINA_HOME下

技术点

1. heredoc实现多行注释；
2. set -u 防止使用未赋值的变量；set -o pipefail 检测并返回管道内部错误，而非默认的管道最后一个命令返回值
3. 判断进程是否存在的几个方法：kill -0 $pid 或 cat /proc/$pid/cmdline，不推荐用ps aux|grep $pid的做法
4. 远程调用bugfix：ssh user@host "cd $CATALINA_HOME/bin && sh tomcat_control.sh start"时，ps会额外返回记录："bash -c cd $CATALINA_HOME/bin && sh tomcat_control.sh start"，脚本内额外grep -v "$0"做了处理

环境

apache-tomcat-5.5.36

linux 2.6.9

实现

#!/bin/bash

set -o pipefail
set -u

#环境设置
TOMCAT_BIN=`pwd`
TOMCAT_EXEC=$TOMCAT_BIN/catalina.sh

#时间设置
START_WAIT=5
SHUT_WAIT=10
KILL_INTERVAL=5
KILL_TIMES=5

#返回码设置
RET_SUCCESS=0
RET_TOMCAT_DEAD=1
RET_ERROR_SHUT=2
RET_ERROR_START=3

#获取当前tomcat实例pid
PID=`ps -ef | grep -vE "grep $TOMCAT_BIN|$0" | grep $TOMCAT_BIN | awk '{print $2}'`

function usage(){
:<< \# 用heredoc实现多行注释
Purpose	:	This script encapsulates the catalina.sh and take care of the start/stop/restart process of tomcat, and just acts like a tomcat controller.
Usage	:	sh tomcat_control start|stop|restart
Date	:	2012.11
#
}

#检测tomcat:$pid是否存活
function is_Tomcat_Alive(){
#kill -0 : test process alived or not
if `kill -0 $PID 2>/dev/null` ; then
#0 stands for success in shell
return $RET_SUCCESS
else
return $RET_TOMCAT_DEAD
fi
}

function shutdown_Tomcat(){
if is_Tomcat_Alive ; then
echo -n "stopping $PID "
sh $TOMCAT_EXEC stop 1>/dev/null 2>&1
sleep_Wait $SHUT_WAIT
if is_Tomcat_Alive ; then
#if normally shutdown does not take effect in $KILL_WAIT secs
return $RET_ERROR_SHUT
else
#if shutdown works well
echo shutdown successfully
return $RET_SUCCESS
fi
else
echo "no need to shut"
return $RET_SUCCESS
fi
}

#正常kill
function kill_Tomcat(){
echo -n "killing $PID "
for((i=0;i<=$KILL_TIMES;i  ));do	#kill tomcat for KILL_TIMES, each with KILL_INTERVAL secs
kill $PID
sleep_Wait $KILL_INTERVAL
#check if kill of this round success
if ! is_Tomcat_Alive ; then
echo shutdown successfully
return $RET_SUCCESS
fi
done
return $RET_ERROR_SHUT
}

#-9 kill
function force_Tomcat(){
echo -n "force killing $PID "
for((i=0;i<=$KILL_TIMES;i  ));do
#kill tomcat for KILL_TIMES, each with KILL_INTERVAL secs
kill -9 $pid
sleep_Wait $KILL_INTERVAL
if ! is_Tomcat_Alive ; then
echo shutdown successfully	#check if force kill of this round success
return $RET_SUCCESS
fi
done
#now if pid still exists
echo shutdown failed, pls manually check
return $RET_ERROR_SHUT
}

#等待时间，加动画
function sleep_Wait(){
local sec=$1
for((i=1;i<=$sec;i  ));do
sleep 1
echo -n "."
done
echo
}

#启动
function startup_Tomcat(){
##This function enables the tomcat
if is_Tomcat_Alive; then
#ps -ef|grep $PID
echo no need to start, tomcat pid : $PID, exit
else
echo -n "starting "
sh $TOMCAT_EXEC start 1>/dev/null 2>&1
sleep_Wait $START_WAIT
local pid=`ps -ef | grep -vE "grep $TOMCAT_BIN|$0" | grep $TOMCAT_BIN | awk '{print $2}'`
#do not if [ `some cmd` ]
if `grep -q $TOMCAT_BIN /proc/$pid/cmdline` ; then
echo start successfully : $pid
return $RET_SUCCESS
else
echo start failed
return $RET_ERROR_START
fi
fi
}

#调度器
function dispatcher(){
local args=$1
case "$args" in
stop)
shutdown_Tomcat || kill_Tomcat || force_Tomcat
;;
kill)
kill_Tomcat || force_Tomcat
;;
force)
force_Tomcat
;;
start)
startup_Tomcat
;;
restart)
shutdown_Tomcat || kill_Tomcat || force_Tomcat && startup_Tomcat
;;
*)
usage
;;
esac
}

dispatcher "$@"
#END

验证

在生产环境中实测通过，小概率存在函数级联调用执行间隙，$pid已被kill而又被下一级函数复杀的问题，忽略即可。