死磕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運作腳本及啟動過程分析--catalina.sh