死磕Tomcat系列(3)——Tomcat如何做到一鍵式啟停的

在沒有SpringBoot內嵌有Tomcat之前，我們都是將專案打為War包放在Tomcat的webapp目錄下面，然後如果是Linux系統，執行命令start.sh、如果是Windows系統，執行命令start.bat以後就能啟動起來並訪問到頁面。如果是想要停止執行只需要執行shutdown.sh或者shutdown.bat就能將程式停止起來，那麼Tomcat是如何做到只需要一個命令就將所有容器啟動起來呢？

指令碼分析

start.sh和start.bat裡面的內容相同，所以這裡就主要分析start.sh的內容了。

os400=false
case "`uname`" in
OS400*) os400=true;;
esac

# resolve links - $0 may be a softlink
# PRG是指令碼路徑,如果當前指令碼檔案為軟連線,則會解析出PRG真正檔案所在的路徑
PRG="$0"

while [ -h "$PRG" ] ; do # 判斷是否為軟連線
  ls=`ls -ld "$PRG"`   # 如果是軟連線,輸出中含有lin -> source的字串
  link=`expr "$ls" : '.*-> \(.*\)$'` # 模式匹配出原始檔的路徑
  if expr "$link" : '/.*' > /dev/null; then # 正則匹配 /.* 這裡expr會輸出匹配個數,如果不為0,則說明$link包含目錄
    PRG="$link"
  else
    PRG=`dirname "$PRG"`/"$link" # 當不包含目錄,說明軟連線和原始檔在同一目錄
  fi
done

# 獲取指令碼目錄路徑
PRGDIR=`dirname "$PRG"`
EXECUTABLE=catalina.sh

# Check that target executable exists
if $os400; then
  # -x will Only work on the os400 if the files are:
  # 1. owned by the user
  # 2. owned by the PRIMARY group of the user
  # this will not work if the user belongs in secondary groups
  eval
else
  if [ ! -x "$PRGDIR"/"$EXECUTABLE" ]; then
    echo "Cannot find $PRGDIR/$EXECUTABLE"
    echo "The file is absent or does not have execute permission"
    echo "This file is needed to run this program"
    exit 1
  fi
fi

# 執行catalina.sh的start命令
exec "$PRGDIR"/"$EXECUTABLE" start "$@"

 

其實上面簡單來說就做了兩件事

1. 拿到指令碼的真正路徑
2. 執行catalina.sh的start命令

而shutdown.sh和start.sh命令一樣，只不過後面是執行catalina.sh的stop命令

catalina.sh指令碼

指令碼中重要的步驟有以下幾個

1. 設定兩個重要的環境變數，CATALINA_HOME、CATALINA_BASE

   	PRGDIR=`dirname "$PRG"`
   
   	[ -z "$CATALINA_HOME" ] && CATALINA_HOME=`cd "$PRGDIR/.." >/dev/null; pwd`
   
   	[ -z "$CATALINA_BASE" ] && CATALINA_BASE="$CATALINA_HOME"
   
    
   

2. 設定CLASSPATH變數，這裡注意，預設是沒有setenv.sh檔案的，可以自己新建一個並新增引數

   	CLASSPATH=
   
   	if [ -r "$CATALINA_BASE/bin/setenv.sh" ]; then
   	  . "$CATALINA_BASE/bin/setenv.sh"
   	elif [ -r "$CATALINA_HOME/bin/setenv.sh" ]; then
   	  . "$CATALINA_HOME/bin/setenv.sh"
   	fi
   
   

3. 將bootstrap.jar作為CLASSPATH

   變數傳進去

   	if [ ! -z "$CLASSPATH" ] ; then
   	  CLASSPATH="$CLASSPATH":
   	fi
   	CLASSPATH="$CLASSPATH""$CATALINA_HOME"/bin/bootstrap.jar
   
   	if [ -z "$CATALINA_OUT" ] ; then
   	  CATALINA_OUT="$CATALINA_BASE"/logs/catalina.out
   	fi
   
   

4. 執行指令碼引數，執行bootstrap.jar中的Bootstrap類中main方法，並傳入引數start

   	    shift
   	    eval exec "\"$_RUNJAVA\"" "\"$LOGGING_CONFIG\"" $LOGGING_MANAGER $JAVA_OPTS $CATALINA_OPTS \
   	      -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \
   	      -classpath "\"$CLASSPATH\"" \
   	      -Djava.security.manager \
   	      -Djava.security.policy=="\"$CATALINA_BASE/conf/catalina.policy\"" \
   	      -Dcatalina.base="\"$CATALINA_BASE\"" \
   	      -Dcatalina.home="\"$CATALINA_HOME\"" \
   	      -Djava.io.tmpdir="\"$CATALINA_TMPDIR\"" \
   	      org.apache.catalina.startup.Bootstrap "$@" start
   
   

在上面指令碼中我們可以看出最後執行的都是從Bootstrap的main方法作為入口的，所以我們開啟Tomcat原始碼進去Bootstrap類中看它到底做了什麼。

啟動類分析

作為Tomcat的入口類，我們先看看Bootstrap中做了什麼。這裡只貼出main方法中重要的程式碼。

//初始化類載入器並且將Catalina檔案載入進記憶體中
bootstrap.init();
String command = "start";
if (args.length > 0) {
    command = args[args.length - 1];
}

if (command.equals("startd")) {
    args[args.length - 1] = "start";
    //呼叫Catalina.java的load方法
    daemon.load(args);
    //呼叫Catalina.java的start
    daemon.start();
} else if (command.equals("stopd")) {
    args[args.length - 1] = "stop";
    //呼叫Catalina.java的stop
    daemon.stop();
} else if (command.equals("start")) {
    daemon.setAwait(true);
    daemon.load(args);
    daemon.start();
    if (null == daemon.getServer()) {
        System.exit(1);
    }
} else if (command.equals("stop")) {
    daemon.stopServer(args);
} else if (command.equals("configtest")) {
    daemon.load(args);
    if (null == daemon.getServer()) {
        System.exit(1);
    }
    System.exit(0);
} else {
    log.warn("Bootstrap: command \"" + command + "\" does not exist.");
}

這裡是根據指令碼中傳入的不同命令，呼叫Catalina不同的方法。由於我們主要分析的Tomcat如何做到一鍵式啟停的，所以我們主要分析Catalina的start方法。

在Catalina的satrt方法中我們看到了這一句

getServer().start();

隨後經過Debug都是經過了Lifecycle的start方法，我們把Lifecycle的方法列出來

public interface Lifecycle {

    public void addLifecycleListener(LifecycleListener listener);

    public LifecycleListener[] findLifecycleListeners();

    public void removeLifecycleListener(LifecycleListener listener);

    public void init() throws LifecycleException;

    public void start() throws LifecycleException;

    public void stop() throws LifecycleException;

    public void destroy() throws LifecycleException;

    public LifecycleState getState();

    public String getStateName();

    public interface SingleUse {
    }
}

然後再看它的實現類，我們發現我們前面所講的整體架構中的元件都實現了此類。而在它的子類LifecycleBase實現了start、init、stop等方法，並且裡面都相應呼叫了startInternal、initInternal、stopInternal方法，這裡我們如果對於設計模式瞭解的話，應該會想到這裡運用了模板設計模式，抽象出所有子類的公有的程式碼，然後重新定義一個內部抽象方法，其子類實現自己的定製化的操作。

在Server.xml中我們發現第一個層級也是Server，然後Catalina的satrt方法中第一個啟動的也是Server。

上面表示了Tomcat所有模組的層級結構，只要是帶有層級的結構，我們應該能夠立馬想到組合設計模式，從這個層級結構中我們能夠得到模組之間的關係，有大有小，有內有外。

• 有大有小：大元件管理小元件，例如Server管理Service，Service管理聯結器和容器
• 有內有外：聯結器控制對外的連線，而外層元件呼叫內層元件完成業務功能。即請求處理的過程是由外層元件驅動的。

那麼根據上面的兩條，我們知道，有小才有大，有內才有外。這也就是整個層級的載入順序，先載入小元件再載入大元件，先載入內層元件再載入外層元件。此時我們應該就明白了Tomcat是如何做到一鍵式啟停的了。通過層級結構，載入的優先順序。層層迭代進行啟動。而停止和啟動差不多。也是層層迭代進行停止。

往期文章

如何斷點除錯Tomcat原始碼

死磕Tomcat系列(1)——整體架構

死磕Tomcat系列(2)——EndPoint原始碼解析

一次奇怪的StackOverflowError問題查詢之旅

徒手擼一個簡單的RPC框架

徒手擼一個簡單的RPC框架(2)——專案改造

參考文章

• expr命令例項
• Tomcat執行指令碼及啟動過程分析--c