原文地址:https://yq.aliyun.com/articles/20169#comment 作者:楚岩
1.1、 问题思考
在阅读tomcat源码前,我们一般都会有如下几个疑问:
web容器和servlet容器的区别是什么;
在springMVC中的web.xml是什么时候加载到tomcat中的;
tomcat是怎么加载我们的web服务的;
tomcat是怎么实现的热部署;
一个http请求是怎么被tomcat监听到的,会有哪些处理;
为什么请求可以有需要通过nginx的,也可以不需要nginx的直接请求到tomcat上?……
如果你想知道答案,那么接下来的文章会告诉你。
1.2、 基本姿势
问题先放在一边,我们都知道Tomcat是一种web容器,用来接收http请求,并将请求得到的结果返回。那么如果要我们设计一个web容器,该怎么做?
很自然的会想到,要有一个网络连接通信维护者和一个请求处理者。通信维护者能够监听到请求并返回数据;请求处理者能够将请求进行分解处理,得到请求应该返回的数据。 如果你的思路是这样的,那么恭喜你,你看源码会简单很多,因为 Tomcat 的设计核心就是这样的,由两大组件组成:Connector 和 Container。Connector负责的是底层的网络通信的实现,而Container负责的是上层servlet业务的实现。
阅读源码前的准备工作:tomcat源码下载,http://tomcat.apache.org/download-70.cgi
下载好源码后导入eclipse。Tomcat7.0工程是用 ant 构建的,在导入eclipse的时候可以选择 file-new-project-java project from existing ant buildfile 导入即可。
也许你会猴急,希望快点知道 Connector 和 Container 是怎么设计和实现的,不过我要掉你胃口了,先得给你讲讲 Tomcat 启动过程,因为只有知道了 Tomcat 启动过程,才能对 Connector 和 Container 是怎么初始化的了然于胸,知道了 Connector 和 Container 的初始化才能准确的把握其结构。
二 Tomcat 启动2.1、 从main看起
我们从main入手看看到底做了什么
public static void main(String args[]) { if (daemon == null) { // Don't set daemon until init() has completed Bootstrap bootstrap = new Bootstrap(); // 1.创建当前的 Bootstrap 类型的对象 try { bootstrap.init(); // 2. 初始化整个系统中用到的几个 classLoader, 并设置父子关系, 创建 org.apache.catalina.startup.Catalina 对象, 设置其 parentClassLoader 为shareClassLoader, 为创建 WebappClassLoader 做准备 } catch (Throwable t) { handleThrowable(t); t.printStackTrace(); return; } daemon = bootstrap; // 3. 保存当前引用到静态变量 } else { // When running as a service the call to stop will be on a new // thread so make sure the correct class loader is used to prevent // a range of class not found exceptions. Thread.currentThread().setContextClassLoader(daemon.catalinaLoader); } // 4. 程序运行到这边时 Thread.currentThread().contextClassLoader 就是 catalinaClassLoader 了(在 bootstrap.init() 里面进行了设置), 下面的所有加载 class操作, 都是由这个 classloader 来进行加载 (PS: 则在 Tomcat 8.0.x 里面, 这里的 catalinaClassLoader 其实就是 commonClassLoader) try { String command = "start"; // 5. 默认命令参数 if (args.length > 0) { // 6. 这里可能是其他的参数, 但默认命令就是 start command = args[args.length - 1]; } if (command.equals("startd")) { // 7. 启动 Tomcat (PS: 这种方式, Tomcat 启动过后会立刻 关闭, 主要是 Catalina 里面的 await = false ) args[args.length - 1] = "start"; daemon.load(args); daemon.start(); } else if (command.equals("stopd")) { // 8. 停止 Tomcat args[args.length - 1] = "stop"; daemon.stop(); } else if (command.equals("start")) { daemon.setAwait(true); // 9. 通过更改 Catalina 里面的 await 值, 在 Tomcat start 执行时, 程序会 hold 住, 直到有向 Tomcat 发送 stop 命令, 程序才会停止 (详情见 Catalina.start() 方法最后那部分) daemon.load(args); // 10. 直接调用 Catalina.load 方法, 进行初始化 各个文件, 命名服务, 用 Digester 来解析 XML 文件, 并且 init Tomcat 容器里面的各个组件 daemon.start(); // 11. 启动当前 bootstrap 对象, 其实主要是通过反射调用前面生成的 org.apache.catalina.startup.Catalina 的 start 方法 } else if (command.equals("stop")) { // 12. 停止 Tomcat (最终还是调用 StandardServer.stop()) daemon.stopServer(args); } else if (command.equals("configtest")) { // 13. 这个只是 将 Tomcat 的配置文件加载进来, 通过反射调用 Catalina.init, 从而检测 程序对应的配置文件是否正确 daemon.load(args); if (null==daemon.getServer()) { System.exit(1); } System.exit(0); } else { log.warn("Bootstrap: command \"" + command + "\" does not exist."); } } catch (Throwable t) { // 抛出异常一直退出 // Unwrap the Exception for clearer error reporting if (t instanceof InvocationTargetException && t.getCause() != null) { t = t.getCause(); } handleThrowable(t); t.printStackTrace(); System.exit(1); }}
上面的 main 主要strong text做了3件事情:
创建 Bootstrap 对象
调用bootstrap做一些初始化的操作(主要是 classloader 的创建)
更具命令行传来的参数start -> 先后通过反射来调用 Catalina 类的 load, 与 start 方法.
2.2、实例化Boostrap对象
调用Boostrap的init方法主要完成三件事:
(1)初始化路径:设置HOME和Base路径,其中HOME是tomcat安装目录,Base是tomcat工作目录;如果我们想要运行Tomcat 的 多个实例,但是不想安装多个Tomcat软件副本。那么我们可以配置多个工作 目录,每个运行实例独占一个工作目录,但是共享同一个安装目录。
(2)初始化类加载器:初始化Tomcat类加载器:catalinaLoader、sharedLoader commonLoader无父加载器,catalinaLoader和sharedLoader的父加载器都是commonLoader,commonLoader的父加载器就是系统类加载器。其中若tomcat的配置文件没有配置:server.loader则catalinaLoader=commonLoader,同理,没配置shared.loader……,这三种都是URLClassLoader,使用Java 中的安全模型。 Tomcat 的类加载器体系如下结构所示:
(3)初始化Boostrap的Catalina对象:通过反射生成Catalina对象,并通过反射调用setParentClassLoader方法设置其父 ClassLoader为sharedLoader。为什么要用反射,不直接在声明的时候生成对象?使用反射来生成实例的原因是因为在tomcat的发展历史中可以不止Catalina一种启动方式,现在看代码已经没必要了。
(4)其他:主线程的classLoader设置为catalinaLoader,安全管理的classLoad设置为catalineLoader。
public void init() throws Exception { //设置系统变量CATALINA_HOME和CATALINA_BASE setCatalinaHome(); setCatalinaBase(); //初始化classLoader initClassLoaders(); Thread.currentThread().setContextClassLoader(catalinaLoader);//主线程的classLoader SecurityClassLoad.securityClassLoad(catalinaLoader); // Load our startup class and call its process() method if (log.isDebugEnabled()) log.debug("Loading startup class"); Class<?> startupClass = catalinaLoader.loadClass ("org.apache.catalina.startup.Catalina"); Object startupInstance = startupClass.newInstance(); //TODO:使用反射来生成实例的原因是因为在tomcat的发展历史中可以不止Catalina一种启动方式,现在看代码已经没必要了 // Set the shared extensions class loader if (log.isDebugEnabled()) log.debug("Setting startup class properties"); String methodName = "setParentClassLoader"; Class<?> paramTypes[] = new Class[1]; paramTypes[0] = Class.forName("java.lang.ClassLoader"); Object paramValues[] = new Object[1]; paramValues[0] = sharedLoader; Method method = startupInstance.getClass().getMethod(methodName, paramTypes); method.invoke(startupInstance, paramValues); //TODO:设置catalina的父classLoader为sharedLoader catalinaDaemon = startupInstance; }
2.3、Boostrap的load方法
调用Catalina的load方法。通过参数判断设置一些条件并判断是否立即加载,加载调用load方法主要做了4件事:
判断系统变量catalina设置HOME和Base路径是否设置,没有的话则设置一下(感觉像是烂代码啊,在Boostrap初始化的时候不是已经设置过一次吗?为什么不写在一起?)
初始化命名服务的基本配置
Digester类,默认将conf/server.xml解析成相应的对象,这个解析很重要,因为是他完成了Connector和Container的初始化工作。先mark下,接下来会详细的介绍Digester是怎么完成Connector和Container的初始化,现在我们只要知道是这里完成的就可以了。
Server调用init初始化声明周期,其父类LifecycleMBeanBase实现
//去掉了一些无用的代码public void load() { long t1 = System.nanoTime(); // CATALINA_BASE和CATALINA_HOME设置 initDirs(); // 初始化命名服务的基本配置 initNaming(); //Digester类,主要用于处理xml配置文件,将xml文件转换成对应的java对象(默认为conf/server.xml) Digester digester = createStartDigester(); InputSource inputSource = null; InputStream inputStream = null; File file = null; try { try { // 配置文件,由命令行参数-config指定,否则取默认值conf/server.xml file = configFile(); inputStream = new FileInputStream(file); inputSource = new InputSource(file.toURI().toURL().toString()); } try { inputSource.setByteStream(inputStream); //将cataline对象压栈,如果栈为空,则设置root为cataline对象 digester.push(this); //遇到相应的应用对对象赋值,相应的调用则调用 digester.parse(inputSource); } } getServer().setCatalina(this); // Stream redirection initStreams(); // Start the new server try { getServer().init(); } …… }
2.4、 Boostrap的start方法
调用Catalina的start方法:
Server加载:Server才是正真的tomcat服务执行者,包括Connector和Container。调用load方法;
调用Server的start方法,最终调用的是StandardServer的startInternal方法,调用自己所有的Service的start方法,启动connector和container、excutor的start方法,后文会继续扩展。
注册钩子
public void start() { try { //服务启动 getServer().start(); } …… // Register shutdown hook 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(); } }
可以看到,Boostrap调用Catalina的方法时,全部都用的是反射,包括生成Catalina对象。而tomcat的启动说白了其实就是初始化并启动Connector和Container。
转自公众号:JavaGuide