startup.sh入手

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

PRG="$0"

while [ -h "$PRG" ] ; do
  ls=`ls -ld "$PRG"`
  link=`expr "$ls" : '.*-> \(.*\)$'`
  if expr "$link" : '/.*' > /dev/null; then
    PRG="$link"
  else
    PRG=`dirname "$PRG"`/"$link"
  fi
done

PRGDIR=`dirname "$PRG"`
EXECUTABLE=catalina.sh


if $os400; then
  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

exec "$PRGDIR"/"$EXECUTABLE" start "$@" 

整個(gè)腳本核心就是最后一句代碼， EXECUTABLE變量是catalina.sh， 代表執(zhí)行catalina.sh， 參數(shù)是start， 再去對(duì)比了shutdown.sh， 兩個(gè)腳本的核心都是調(diào)用catalina.sh傳遞的變量不同。

瀏覽catalina.sh腳本

整個(gè)腳本很長(zhǎng)，我這里之截圖了我們關(guān)心的腳本內(nèi)容。 這段代碼里， 除了能看到參數(shù)傳遞start， 最后會(huì)輸出Tomcat started外，能看到調(diào)用了org.apache.catalina.startup.Bootstrap， 也就是說(shuō)找到我們的程序入口，或者說(shuō)找到了我們的程序的main函數(shù)。

    shift
    eval $_NOHUP "\"$_RUNJAVA\"" "\"$CATALINA_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 \
      >> "$CATALINA_OUT" 2>&1 "&"

  else
    eval $_NOHUP "\"$_RUNJAVA\"" "\"$CATALINA_LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \
      -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \
      -classpath "\"$CLASSPATH\"" \
      -Dcatalina.base="\"$CATALINA_BASE\"" \
      -Dcatalina.home="\"$CATALINA_HOME\"" \
      -Djava.io.tmpdir="\"$CATALINA_TMPDIR\"" \
      org.apache.catalina.startup.Bootstrap "$@" start \
      >> "$CATALINA_OUT" 2>&1 "&"

  fi

  if [ ! -z "$CATALINA_PID" ]; then
    echo $! > "$CATALINA_PID"
  fi

  echo "Tomcat started."

看到這里我們做個(gè)小小的總結(jié)：Tomcat本質(zhì)上也是一個(gè)java程序，因此startup.sh會(huì)啟動(dòng)一個(gè)jvm來(lái)運(yùn)行tomcat的啟動(dòng)類(lèi)Bootstrap.java。

Bootstrap類(lèi)核心功能

• 靜態(tài)構(gòu)造器部分， 主要初始化了CATALINA_HOME和CATALINA_BASE兩個(gè)變量?jī)?nèi)容
• main函數(shù)方法部分一，創(chuàng)建和初始化daemon, 創(chuàng)建三個(gè)類(lèi)加載器
• main函數(shù)方法部分二，控制tomcat的啟動(dòng)和停止

從Bootstrap.main方法開(kāi)始

開(kāi)始main方法之前，首先看兩個(gè)關(guān)鍵屬性.

/*************
守護(hù)進(jìn)程對(duì)象
**********/
private static volatile Bootstrap daemon = null;

/***
守護(hù)程序用的catalina對(duì)象
***/
private Object catalinaDaemon = null;

Bootstrap#main

 public static void main(String args[]) {
	synchronized (daemonLock) {
		if (daemon == null) {
			//初始化完成之前，不要對(duì)daemon賦值
			Bootstrap bootstrap = new Bootstrap();
			try {
			    //調(diào)用初始化方法, 完成加載器的配置和初始化器的準(zhǔn)備
				bootstrap.init();
			} catch (Throwable t) {
				handleThrowable(t);
				t.printStackTrace();
				return;
			}
			daemon = bootstrap;
		} else {
			//當(dāng)作為服務(wù)正在運(yùn)行時(shí)，如果調(diào)用停止方法，這將在一個(gè)新線程上進(jìn)行，以確保使用正確的類(lèi)加載器，防止出現(xiàn)未找到類(lèi)的異常
			Thread.currentThread().setContextClassLoader(daemon.catalinaLoader);
		}
	}

	String command = "start";
	if (args.length > 0) {
		command = args[args.length - 1];
	}

	if (command.equals("startd")) {
		args[args.length - 1] = "start";
		daemon.load(args);
		daemon.start();
	} else if (command.equals("stopd")) {
		args[args.length - 1] = "stop";
		daemon.stop();
	} else if (command.equals("start")) {
		daemon.setAwait(true);
        //Bootstrap加載
		daemon.load(args);
        //Bootstrap啟動(dòng)
		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 {
		
	}      
}

//Bootstrap.init
public void init() throws Exception {
    //初始化類(lèi)的三個(gè)加載器
	initClassLoaders();
	//設(shè)置線程類(lèi)加載器， 將容器的加載器傳入
	Thread.currentThread().setContextClassLoader(catalinaLoader);
	//加載安全類(lèi)加載器
	SecurityClassLoad.securityClassLoad(catalinaLoader);
	//通過(guò)反射加載catalina
	Class<?> startupClass = catalinaLoader.loadClass("org.apache.catalina.startup.Catalina");
	//創(chuàng)建對(duì)象
	Object startupInstance = startupClass.getConstructor().newInstance();

	String methodName = "setParentClassLoader";
	Class<?> paramTypes[] = new Class[1];
	//將類(lèi)加載器作為參數(shù)傳遞
	paramTypes[0] = Class.forName("java.lang.ClassLoader");
	Object paramValues[] = new Object[1];
	paramValues[0] = sharedLoader; //共享加載器
	Method method = startupInstance.getClass().getMethod(methodName, paramTypes); //對(duì)類(lèi)加載器進(jìn)行初始化賦值
	//調(diào)用catalina類(lèi)內(nèi)部的setParentClassLoader方法對(duì)catalina類(lèi)內(nèi)部的類(lèi)加載賦值
	method.invoke(startupInstance, paramValues);
	//將創(chuàng)建好的startupInstance對(duì)象賦值給catalinaDaemon
	catalinaDaemon = startupInstance;
}

Catalina#load

Catalina類(lèi)的load方法核心就解析config/server.xml并創(chuàng)建Server組件實(shí)例， 也就是我們?cè)趖omcat整體架構(gòu)章節(jié)里了解的一個(gè)tomcat只有一個(gè)Server實(shí)例。 這部分代碼塊，我刪掉了注釋代碼，try...catch， 只留下了核心業(yè)務(wù)代碼。

public void load() {
	loaded = true;
	long t1 = System.nanoTime();
	initDirs();
	initNaming();
    //利用digester類(lèi)解析server.xml，得到容器的配置
	Digester digester = createStartDigester();

	InputSource inputSource = null;
	InputStream inputStream = null;
	File file = null;
	
	file = configFile();
	inputStream = new FileInputStream(file);
	inputSource = new InputSource(file.toURI().toURL().toString());
	
	if (inputStream == null) {
		inputStream = getClass().getClassLoader().getResourceAsStream(getConfigFile());
		inputSource = new InputSource(getClass().getClassLoader().getResource(getConfigFile()).toString());	
	}

	if (inputStream == null) {
		inputStream = getClass().getClassLoader().getResourceAsStream("server-embed.xml");
		inputSource = new InputSource(getClass().getClassLoader().getResource("server-embed.xml").toString());
	}

	if (inputStream == null || inputSource == null) {
		return;
	}

	try {
		inputSource.setByteStream(inputStream);
		digester.push(this);
		digester.parse(inputSource);
	} catch (SAXParseException spe) {
		return;
	} catch (Exception e) {
		return;
	}
	
	getServer().setCatalina(this);
	getServer().setCatalinaHome(Bootstrap.getCatalinaHomeFile());
	getServer().setCatalinaBase(Bootstrap.getCatalinaBaseFile());

	initStreams();
    //服務(wù)器執(zhí)行初始化 開(kāi)始調(diào)用的Server的初始化方法注意Server是一個(gè)接口
	getServer().init();
}

Catalina#start

public void start() {
	if (getServer() == null) {
		load();
	}

	if (getServer() == null) {
		return;
	}

	long t1 = System.nanoTime();

	//開(kāi)始一個(gè)Server實(shí)例
	try {
		getServer().start();
	} catch (LifecycleException e) {
		log.fatal(sm.getString("catalina.serverStartFail"), e);
		try {
			getServer().destroy();
		} catch (LifecycleException e1) {
			log.debug("destroy() failed for failed Server ", e1);
		}
		return;
	}

	long t2 = System.nanoTime();
	if(log.isInfoEnabled()) {
		log.info("Server startup in " + ((t2 - t1) / 1000000) + " ms");
	}

	if (useShutdownHook) {
		if (shutdownHook == null) {
			shutdownHook = new CatalinaShutdownHook();
		}
		Runtime.getRuntime().addShutdownHook(shutdownHook);

		LogManager logManager = LogManager.getLogManager();
		if (logManager instanceof ClassLoaderLogManager) {
			((ClassLoaderLogManager) logManager).setUseShutdownHook(false);
		}
	}

	if (await) {
		await();
		stop();
	}
}

從Bootstrap#createStartDigester方法中可以看到Server接口的實(shí)現(xiàn)類(lèi)是StandardServer.

digester.addObjectCreate("Server","org.apache.catalina.core.StandardServer","className");

Server接口繼承了Lifecycle接口

StandardServer類(lèi)繼承了抽象類(lèi)LifecycleMBeanBase，同時(shí)實(shí)現(xiàn)了Server接口

LifecycleMBeanBase抽象類(lèi)又繼承了抽象類(lèi)LifecycleBase， 而LifecycleBase抽象類(lèi)又實(shí)現(xiàn)了Lifecycle接口

通過(guò)前面的調(diào)用鏈看出來(lái)Catalina.start會(huì)調(diào)用Server接口的start方法，而StandardServer實(shí)現(xiàn)類(lèi)的start方法就追溯到了LifeCycleBase抽象的start方法， 這個(gè)類(lèi)里定義了抽象方法startInternal讓子類(lèi)去實(shí)現(xiàn)。 在start方法中也調(diào)用了startInternal方法。

StandardServer類(lèi)圖

StandardServer#startInternal

protected void startInternal() throws LifecycleException {
	fireLifecycleEvent(CONFIGURE_START_EVENT, null);
	setState(LifecycleState.STARTING);

	globalNamingResources.start();

	synchronized (servicesLock) {
	    //這里啟動(dòng)定義的多個(gè)service
		for (Service service : services) {
			service.start();
		}
	}
}

根據(jù)Server的實(shí)現(xiàn)類(lèi)StandardServer類(lèi)，我順便查看了其所在包， 看到了整個(gè)tomcat用到的核心組件的實(shí)現(xiàn)類(lèi)都在這里了，比如StandardEngine， StandardService，StandardHost， 可以查看其他的實(shí)現(xiàn)類(lèi)結(jié)構(gòu)。

總結(jié)

結(jié)合上面的兩張圖片，以及上述的源碼分析，我們就能總結(jié)出來(lái)整個(gè)startup.sh過(guò)程中完成的任務(wù)

1. Tomcat本質(zhì)上是一個(gè)java程序，因此startup腳本會(huì)啟動(dòng)一個(gè)jvm來(lái)運(yùn)行tomcat的啟動(dòng)類(lèi)Bootstrap.
2. Bootstrap的主要任務(wù)就是初始化tomcat的類(lèi)加載器，并且創(chuàng)建Catalina.
3. Catalina是一個(gè)啟動(dòng)類(lèi)，通過(guò)解析Server.xml創(chuàng)建相應(yīng)組件，通過(guò)調(diào)用Server接口實(shí)現(xiàn)類(lèi)去啟動(dòng)Server.
4. StandardServer通過(guò)調(diào)用父類(lèi)LifecycleBase的start方法，并且重寫(xiě)startInternal方法來(lái)啟動(dòng)Server和啟動(dòng)Service.
5. Service組件的職責(zé)就是管理連接器和頂層容器，他會(huì)調(diào)用連接器和頂層容器的start方法.
6. 容器組件負(fù)責(zé)啟動(dòng)管理子容器，并且調(diào)用Host的start方法， 將各層容器啟動(dòng)起來(lái)。

參考資料

https://juejin.cn/post/7155750621864263716

https://2i3i.com/tomcat-code-3.html

https://juejin.cn/post/7082681444182523934

https://time.geekbang.org/column/article/97603

https://zhuanlan.zhihu.com/p/344635709