大公司程序员带你死磕Tomcat—Tomcat如何做到一键式启停

在没有SpringBoot内嵌有Tomcat之前，我们都是将项目打为War包放在Tomcat的webapp目录下面，然后如果是Linux系统，运行命令start.sh、如果是Windows系统，运行命令start.bat以后就能启动起来并访问到页面。如果是想要停止运行只需要运行shutdown.sh或者shutdown.bat就能将程序停止起来，那么Tomcat是如何做到只需要一个命令就将所有容器启动起来呢?

脚本分析

start.sh和start.bat里面的内容相同，所以这里就主要分析start.sh的内容了。

1. os400=false  
2. case "`uname`" in  
3. OS400*) os400=true;;  
4. esac  
5. # resolve links - $0 may be a softlink  
6. # PRG是脚本路径,如果当前脚本文件为软连接,则会解析出PRG真正文件所在的路径  
7. PRG="$0"  
8. while [ -h "$PRG" ] ; do # 判断是否为软连接  
9.  ls=`ls -ld "$PRG"` # 如果是软连接,输出中含有lin -> source的字符串  
10.  link=`expr "$ls" : '.*-> (.*)$'` # 模式匹配出源文件的路径  
11.  if expr "$link" : '/.*' > /dev/null; then # 正则匹配 /.* 这里expr会输出匹配个数,如果不为0,则说明$link包含目录  
12.  PRG="$link"  
13.  else  
14.  PRG=`dirname "$PRG"`/"$link" # 当不包含目录,说明软连接和源文件在同一目录  
15.  fi  
16. done  
17. # 获取脚本目录路径  
18. PRGDIR=`dirname "$PRG"`  
19. EXECUTABLE=catalina.sh  
20. # Check that target executable exists  
21. if $os400; then  
22.  # -x will Only work on the os400 if the files are:  
23.  # 1. owned by the user  
24.  # 2. owned by the PRIMARY group of the user  
25.  # this will not work if the user belongs in secondary groups  
26.  eval  
27. else  
28.  if [ ! -x "$PRGDIR"/"$EXECUTABLE" ]; then  
29.  echo "Cannot find $PRGDIR/$EXECUTABLE"  
30.  echo "The file is absent or does not have execute permission"  
31.  echo "This file is needed to run this program"  
32.  exit 1  
33.  fi  
34. fi  
35. # 执行catalina.sh的start命令  
36. exec "$PRGDIR"/"$EXECUTABLE" start "$@"  

其实上面简单来说就做了两件事

1. 拿到脚本的真正路径 
2. 执行catalina.sh的start命令 

而shutdown.sh和start.sh命令一样，只不过后面是执行catalina.sh的stop命令

catalina.sh脚本

脚本中重要的步骤有以下几个

1.设置两个重要的环境变量，CATALINA_HOME、CATALINA_BASE

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

设置CLASSPATH变量，这里注意，默认是没有setenv.sh文件的，可以自己新建一个并添加参数

1. CLASSPATH=  
2.   
3. if [ -r "$CATALINA_BASE/bin/setenv.sh" ]; then  
4.   
5. . "$CATALINA_BASE/bin/setenv.sh"  
6.   
7. elif [ -r "$CATALINA_HOME/bin/setenv.sh" ]; then  
8.   
9. . "$CATALINA_HOME/bin/setenv.sh"  
10.   
11. fi  

将bootstrap.jar作为CLASSPATH变量传进去

1. if [ ! -z "$CLASSPATH" ] ; then  
2.      CLASSPATH="$CLASSPATH":  
3.     fi  
4.     CLASSPATH="$CLASSPATH""$CATALINA_HOME"/bin/bootstrap.jar  
5.     if [ -z "$CATALINA_OUT" ] ; then  
6.      CATALINA_OUT="$CATALINA_BASE"/logs/catalina.out  
7.     fi  

执行脚本参数，执行bootstrap.jar中的Bootstrap类中main方法，并传入参数start

1. hift  
2.   
3. eval exec ""$_RUNJAVA"" ""$LOGGING_CONFIG"" $LOGGING_MANAGER $JAVA_OPTS $CATALINA_OPTS   
4.   
5. -D$ENDORSED_PROP=""$JAVA_ENDORSED_DIRS""   
6.   
7. -classpath ""$CLASSPATH""   
8.   
9. -Djava.security.manager   
10.   
11. -Djava.security.policy==""$CATALINA_BASE/conf/catalina.policy""   
12.   
13. -Dcatalina.base=""$CATALINA_BASE""   
14.   
15. -Dcatalina.home=""$CATALINA_HOME""   
16.   
17. -Djava.io.tmpdir=""$CATALINA_TMPDIR""   
18.   
19. org.apache.catalina.startup.Bootstrap "$@" start  

在上面脚本中我们可以看出最后执行的都是从Bootstrap的main方法作为入口的，所以我们打开Tomcat源码进去Bootstrap类中看它到底做了什么。

启动类分析

作为Tomcat的入口类，我们先看看Bootstrap中做了什么。这里只贴出main方法中重要的代码。

1. //初始化类加载器并且将Catalina文件加载进内存中  
2. bootstrap.init();  
3. String command = "start";  
4. if (args.length > 0) {  
5.  command = args[args.length - 1];  
6. }  
7. if (command.equals("startd")) {  
8.  args[args.length - 1] = "start";  
9.  //调用Catalina.java的load方法  
10.  daemon.load(args);  
11.  //调用Catalina.java的start  
12.  daemon.start();  
13. } else if (command.equals("stopd")) {  
14.  args[args.length - 1] = "stop";  
15.  //调用Catalina.java的stop  
16.  daemon.stop();  
17. } else if (command.equals("start")) {  
18.  daemon.setAwait(true);  
19.  daemon.load(args);  
20.  daemon.start();  
21.  if (null == daemon.getServer()) {  
22.  System.exit(1);  
23.  }  
24. } else if (command.equals("stop")) {  
25.  daemon.stopServer(args);  
26. } else if (command.equals("configtest")) {  
27.  daemon.load(args);  
28.  if (null == daemon.getServer()) {  
29.  System.exit(1);  
30.  }  
31.  System.exit(0);  
32. } else {  
33.  log.warn("Bootstrap: command "" + command + "" does not exist.");  
34. }  

这里是根据脚本中传入的不同命令，调用Catalina不同的方法。由于我们主要分析的Tomcat如何做到一键式启停的，所以我们主要分析Catalina的start方法。

在Catalina的satrt方法中我们看到了这一句

1. getServer().start();  

随后经过Debug都是经过了Lifecycle的start方法，我们把Lifecycle的方法列出来

1. public interface Lifecycle {  
2.  public void addLifecycleListener(LifecycleListener listener);  
3.  public LifecycleListener[] findLifecycleListeners();  
4.  public void removeLifecycleListener(LifecycleListener listener);  
5.  public void init() throws LifecycleException;  
6.  public void start() throws LifecycleException;  
7.  public void stop() throws LifecycleException;  
8.  public void destroy() throws LifecycleException;  
9.  public LifecycleState getState();  
10.  public String getStateName();  
11.  public interface SingleUse {  
12.  }  
13. }  

然后再看它的实现类，我们发现我们前面所讲的整体架构中的组件都实现了此类。而在它的子类LifecycleBase实现了start、init、stop等方法，并且里面都相应调用了startInternal、initInternal、stopInternal方法，这里我们如果对于设计模式了解的话，应该会想到这里运用了模板设计模式，抽象出所有子类的公有的代码，然后重新定义一个内部抽象方法，其子类实现自己的定制化的操作。

在Server.xml中我们发现第一个层级也是Server，然后Catalina的satrt方法中第一个启动的也是Server。

上面表示了Tomcat所有模块的层级结构，只要是带有层级的结构，我们应该能够立马想到组合设计模式，从这个层级结构中我们能够得到模块之间的关系，有大有小，有内有外。

• 有大有小：大组件管理小组件，例如Server管理Service，Service管理连接器和容器
• 有内有外：连接器控制对外的连接，而外层组件调用内层组件完成业务功能。即请求处理的过程是由外层组件驱动的。

那么根据上面的两条，我们知道，有小才有大，有内才有外。这也就是整个层级的加载顺序，先加载小组件再加载大组件，先加载内层组件再加载外层组件。此时我们应该就明白了Tomcat是如何做到一键式启停的了。通过层级结构，加载的优先级。层层迭代进行启动。而停止和启动差不多。也是层层迭代进行停止。