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

死磕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