TOMCAT源码分析(启动框架)

TOMCAT源码分析(启动框架)
前言：
   本文是我阅读了TOMCAT源码后的一些心得。 主要是讲解TOMCAT的系统框架， 以及启动流程。如有错漏之处，敬请批评指教！
建议：
   毕竟TOMCAT的框架仍是比较复杂的， 单是从文字上理解， 是不那么容易掌握TOMCAT的框架的。 因此得实践、实践、再实践。 建议下载一份TOMCAT的源码， 调试经过， 而后单步跟踪其启动过程。 若是有不明白的地方， 再来查阅本文， 看是否能获得帮助。 我相信这样效果以及学习速度都会好不少！
   
1. Tomcat的总体框架结构
   Tomcat的基本框架， 分为4个层次。
   Top Level Elements:
    Server
    Service   
   Connector
    HTTP
    AJP
   Container
   Engine
     Host
   Context
   Component  
    manager
   logger
   loader
   pipeline
   valve
         ...
   站在框架的顶层的是Server和Service
   Server:  其实就是BackGroud程序， 在Tomcat里面的Server的用处是启动和监听服务端事件（诸如重启、关闭等命令。 在tomcat的标准配置文件：server.xml里面， 咱们能够看到“<Server port="8005" shutdown="SHUTDOWN" debug="0">”这里的"SHUTDOWN"就是server在监听服务端事件的时候所使用的命令字）
   Service： 在tomcat里面， service是指一类问题的解决方案。  一般咱们会默认使用tomcat提供的：Tomcat-Standalone 模式的service。 在这种方式下的service既给咱们提供解析jsp和servlet的服务， 同时也提供给咱们解析静态文本的服务。
   
   Connector: Tomcat都是在容器里面处理问题的， 而容器又到哪里去取得输入信息呢？
Connector就是专干这个的。 他会把从socket传递过来的数据， 封装成Request, 传递给容器来处理。
   一般咱们会用到两种Connector,一种叫http connectoer， 用来传递http需求的。 另外一种叫AJP， 在咱们整合apache与tomcat工做的时候， apache与tomcat之间就是经过这个协议来互动的。 （说到apache与tomcat的整合工做， 一般咱们的目的是为了让apache 获取静态资源， 而让tomcat来解析动态的jsp或者servlet。）
   Container: 当http connector把需求传递给顶级的container: Engin的时候， 咱们的视线就应该移动到Container这个层面来了。
   在Container这个层， 咱们包含了3种容器： Engin, Host, Context.
   Engin: 收到service传递过来的需求， 处理后， 将结果返回给service( service 是经过 connector 这个媒介来和Engin互动的 ).
   Host: Engin收到service传递过来的需求后，不会本身处理， 而是交给合适的Host来处理。
Host在这里就是虚拟主机的意思， 一般咱们都只会使用一个主机，既“localhost”本地机来处理。 
   Context: Host接到了从Host传过来的需求后， 也不会本身处理， 而是交给合适的Context来处理。 
   好比： <http://127.0.0.1:8080/foo/index.jsp>
         <http://127.0.1:8080/bar/index.jsp>
   前者交给foo这个Context来处理， 后者交给bar这个Context来处理。
   很明显吧！ context的意思其实就是一个web app的意思。
   咱们一般都会在server.xml里面作这样的配置
   <Context path="/foo" docBase="D:/project/foo/web" />
   这个context容器，就是用来干咱们该干的事儿的地方的。
   
   Compenent: 接下来， 咱们继续讲讲component是干什么用的。
   咱们得先理解一下容器和组件的关系。
   需求被传递到了容器里面， 在合适的时候， 会传递给下一个容器处理。
   而容器里面又盛装着各类各样的组件， 咱们能够理解为提供各类各样的增值服务。
   manager: 当一个容器里面装了manager组件后，这个容器就支持session管理了， 事实上在tomcat里面的session管理， 就是靠的在context里面装的manager component.
   logger: 当一个容器里面装了logger组件后， 这个容器里所发生的事情， 就被该组件记录下来啦！ 咱们一般会在logs/ 这个目录下看见 catalina_log.time.txt 以及 localhost.time.txt 和localhost_examples_log.time.txt。 这就是由于咱们分别为：engin, host以及context(examples)这三个容器安装了logger组件， 这也是默认安装， 又叫作标配 ：）
   loader: loader这个组件一般只会给咱们的context容器使用， loader是用来启动context以及管理这个context的classloader用的。
    pipline: pipeline是这样一个东西， 当一个容器决定了要把从上级传递过来的需求交给子容器的时候， 他就把这个需求放进容器的管道(pipeline)里面去。 而需求傻呼呼得在管道里面流动的时候， 就会被管道里面的各个阀门拦截下来。 好比管道里面放了两个阀门。 第一个阀门叫作“access_allow_vavle”， 也就是说需求流过来的时候，它会看这个需求是哪一个IP过来的， 若是这个IP已经在黑名单里面了， sure, 杀！ 第二个阀门叫作“defaul_access_valve”它会作例行的检查， 若是经过的话，OK， 把需求传递给当前容器的子容器。 就是经过这种方式， 需求就在各个容器里面传递，流动， 最后抵达目的地的了。
    valve: 就是上面所说的阀门啦。
   Tomcat里面大概就是这么些东西， 咱们能够简单地这么理解tomcat的框架，它是一种自上而下， 容器里又包含子容器的这样一种结构。
2. Tomcat的启动流程
   这篇文章是讲tomcat怎么启动的，既然咱们大致上了解了TOMCAT的框架结构了， 那么咱们能够望文生意地就猜到tomcat的启动， 会先启动父容器，而后逐个启动里面的子容器。 启动每个容器的时候， 都会启动安插在他身上的组件。 当全部的组件启动完毕， 全部的容器启动完毕的时候， tomcat自己也就启动完毕了。
   瓜熟蒂落地， 咱们一样能够猜到， tomcat的启动会分红两大部分， 第一步是装配工做。 第二步是启动工做。 
   装配工做就是为父容器装上子容器， 为各个容器安插进组件的工做。 这个地方咱们会用到digester模式， 至于digester模式什么， 有什么用， 怎么工做的. 请参考 <http://software.ccidnet.com/pub/article/c322_a31671_p2.html>
   启动工做是在装配工做以后， 一旦装配成功了， 咱们就只须要点燃最上面的一根导线， 整个tomcat就会被激活起来。 这就比如咱们要开一辆已经装配好了的汽车的时候同样，咱们只要把钥匙插进钥匙孔，一拧，汽车的引擎就会发动起来，空调就会开起来， 安全装置就会生效， 如此一来，汽车整个就发动起来了。（这个过程确实和TOMCAT的启动过程不谋而和， 让咱们不得不怀疑 TOMCAT的设计者是在GE作JAVA开发的）。
2.1 一些有意思的名称：
   Catalina
   Tomcat
   Bootstrap
   Engin
   Host
   Context
   他们的意思颇有意思：
   Catalina: 远程轰炸机
   Tomcat: 熊猫轰炸机 -- 轰炸机的一种（这让我想起了让国人引觉得豪的熊猫手机，是否是英文能够叫作tomcat??? ， 又让我想起了另外一则广告： 波导-手机中的战斗机、波音-客机中的战斗机 ）
   Bootstap: 引导
   Engin: 发动机
   Host: 主机，领土
   Context: 内容， 目标， 上下文
   
   ... 在许多许多年后， 现代人类已经灭绝。 后现代生物发现了这些单词零落零落在一块。 一个自觉得聪明的家伙把这些东西翻译出来了： 
   在地勤人员的引导(bootstrap)下， 一架轰炸架(catalina)腾空跃起， 远看是熊猫轰炸机(tomcat)， 近看仍是熊猫轰炸机！ 凭借着优秀的发动机技术(engin)， 这架熊猫轰炸机飞临了敌国的领土上空(host)， 对准目标(context)投下了毁天灭地的核弹头，波~ 现代生物就这么隔屁了~
 
   综上所述， 这又不得不让人联想到GE是否是也参与了军事设备的生产呢？
   反对美帝国主义！ 反对美霸权主义！ 和平万岁！ 自由万岁！
   
2.2  历史就是那么惊人的类似！ tomcat的启动就是从org.apache.catalina.startup.Bootstrap这个类悍然启动的！
   在Bootstrap里作了两件事：
   1. 指定了3种类型classloader:
      commonLoader: common/classes、common/lib、common/endorsed
      catalinaLoader: server/classes、server/lib、commonLoader
      sharedLoader：  shared/classes、shared/lib、commonLoader
   2. 引导Catalina的启动。
      用Reflection技术调用org.apache.catalina.startup.Catalina的process方法， 并传递参数过去。
   
2.3 Catalina.java
   Catalina完成了几个重要的任务：
   1. 使用Digester技术装配tomcat各个容器与组件。
      1.1 装配工做的主要内容是安装各个大件。 好比server下有什么样的servcie。 Host会容纳多少个context。 Context都会使用到哪些组件等等。 
      1.2 同时呢， 在装配工做这一步， 还完成了mbeans的配置工做。 在这里，我简单地但不十分精确地描述一下mbean是什么，干什么用的。
          咱们本身生成的对象， 本身管理， 天经地义！ 可是若是咱们建立了对象了， 想让别人来管， 怎么办呢？ 我想至少得告诉别人咱们都有什么， 以及经过什么方法能够找到  吧！ JMX技术给咱们提供了一种手段。 JMX里面主要有3种东西。Mbean, agent, connector.
       Mbean： 用来映射咱们的对象。也许mbean就是咱们建立的对象， 也许不是， 但有了它， 就能够引用到咱们的对象了。
       Agent:  经过它， 就能够找到mbean了。
       Connector: 链接Agent的方式。 能够是http的， 也能够是rmi的，还能够直接经过socket。
      发生在tomcat 装配过程当中的事情:  GlobalResourcesLifecycleListener 类的初始化会被触发：
         protected static Registry registry = MBeanUtils.createRegistry();  会运行
         MBeanUtils.createRegistry()  会依据/org/apache/catalina/mbeans/mbeans-descriptors.xml这个配置文件建立 mbeans. Ok, 外界就有了条途径访问tomcat中的各个组件了。（有点像后门儿）
   2. 为top level 的server 作初始化工做。 实际上就是作一般会配置给service的两条connector.(http, ajp)
   3. 从server这个容器开始启动， 点燃整个tomcat.
   4. 为server作一个hook程序， 检测当server shutdown的时候， 关闭tomcat的各个容器用。
   5. 监听8005端口， 若是发送"SHUTDOWN"（默认培植下字符串）过来， 关闭8005serverSocket。
2.4 启动各个容器
   1. Server
      触发Server容器启动前(before_start)， 启动中(start)， 启动后(after_start)3个事件， 并运行相应的事件处理器。
      启动Server的子容器：Servcie. 
   2. Service
      启动Service的子容器：Engin
      启动Connector
   3. Engin
      到了Engin这个层次，以及如下级别的容器， Tomcat就使用了比较一致的启动方式了。
      首先，  运行各个容器本身特有一些任务
      随后，  触发启动前事件
      当即，  设置标签，就表示该容器已经启动
      接着，  启动容器中的各个组件： loader, logger, manager等等
      再接着，启动mapping组件。（注1）
      紧跟着，启动子容器。
      接下来，启动该容器的管道(pipline)
      而后，  触发启动中事件
      最后，  触发启动后事件。
 
      Engin大体会这么作， Host大体也会这么作， Context大体仍是会这么作。 那么很显然地， 咱们须要在这里使用到代码复用的技术。 tomcat在处理这个问题的时候， 漂亮地使用了抽象类来处理。 ContainerBase. 最后使得这部分完成复杂功能的代码显得干净利落， 干练爽快， 实在是使人以为叹为观止， 细细品来， 直觉如享佳珍， 另人齿颊留香， 留恋往返啊！
      
      Engin的触发启动前事件里， 会激活绑定在Engin上的惟一一个Listener：EnginConfig。
      这个EnginConfig类基本上没有作什么事情， 就是把EnginConfig的调试级别设置为和Engin至关。 另外就是输出几行文本， 表示Engin已经配置完毕， 并无作什么实质性的工做。
      注1: mapping组件的用处是， 当一个需求将要从父容器传递到子容器的时候， 而父容器又有多个子容器的话， 那么应该选择哪一个子容器来处理需求呢？ 这个由mapping 组件来定夺。
    
   4. Host
       同Engin同样， 也是调用ContainerBase里面的start()方法， 不过以前作了些自个儿的任务,就是往Host这个容器的通道（pipline）里面， 安装了一个叫作
 “org.apache.catalina.valves.ErrorReportValve”的阀门。
       这个阀门的用处是这样的：  需求在被Engin传递给Host后， 会继续传递给Context作具体的处理。 这里需求其实就是做为参数传递的Request, Response。 因此在context把需求处理完后， 一般会改动response。 而这个org.apache.catalina.valves.ErrorReportValve的做用就是检察response是否包含错误， 若是有就作相应的处理。
   5. Context
       到了这里， 就终于轮到了tomcat启动中真正的重头戏，启动Context了。
 StandardContext.start() 这个启动Context容器的方法被StandardHost调用.
 5.1 webappResources 该context所指向的具体目录
 5.2 安装defaultContex, DefaultContext 就是默认Context。 若是咱们在一个Host下面安装了DefaultContext，并且defaultContext里面又安装了一个数据库链接池资源的话。 那么其余全部的在该Host下的Context, 均可以直接使用这个数据库链接池， 而不用格外作配置了。
  5.3 指定Loader. 一般用默认的org.apache.catalina.loader.WebappLoader这个类。   Loader就是用来指定这个context会用到哪些类啊， 哪些jar包啊这些什么的。
 5.4 指定 Manager. 一般使用默认的org.apache.catalina.session. StandardManager 。 Manager是用来管理session的。
     其实session的管理也很好实现。 以一种简单的session管理为例。 当需求传递过来的时候， 在Request对象里面有一个sessionId 属性。 OK， 获得这个sessionId后， 咱们就能够把它做为map的key，而value咱们能够放置一个HashMap. HashMap里边儿， 再放咱们想放的东西。
 5.5 postWorkDirectory (). Tomcat下面有一个work目录。 咱们把临时文件都扔在那儿去。 这个步骤就是在那里建立一个目录。 通常说来会在%CATALINA_HOME%/work/Standalone/localhost/ 这个地方生成一个目录。
5.6  Binding thread。到了这里， 就应该发生 class Loader 互换了。 以前是看得见tomcat下面全部的class和lib. 接下来须要看得见当前context下的class。 因此要设置contextClassLoader, 同时还要把旧的ClassLoader记录下来，由于之后还要用的。
5.7  启动 Loader. 指定这个Context具体要使用哪些classes， 用到哪些jar文件。 若是reloadable设置成了true, 就会启动一个线程来监视classes的变化， 若是有变化就从新启动Context。
5.8  启动logger
5.9  触发安装在它身上的一个监听器。
 lifecycle.fireLifecycleEvent(START_EVENT, null); 
 做为监听器之一，ContextConfig会被启动. ContextConfig就是用来配置web.xml的。 好比这个Context有多少Servlet， 又有多少Filter， 就是在这里给Context装上去的。
 5.9.1 defaultConfig. 每一个context都得配置 tomcat/conf/web.xml 这个文件。
 5.9.2 applicationConfig 配置本身的 WEB-INF/web.xml 文件
5.9.3 validateSecurityRoles 权限验证。 一般咱们在访问/admin 或者/manager的时候，须要用户要么是admin的要么是manager的， 才能访问。 并且咱们还能够限制那些资源能够访问， 而哪些不能。 都是在这里实现的。
5.9.4 tldScan: 扫描一下， 须要用到哪些标签(tag lab)
5.10 启动 manager
5.11 postWelcomeFiles() 咱们一般会用到的3个启动文件的名称：
index.html、index.htm、index.jsp 就被默认地绑在了这个context上
 5.12 listenerStart 配置listener
 5.13 filterStart 配置 filter
 5.14 启动带有<load-on-startup>1</load-on-startup>的Servlet.
  顺序是从小到大： 1,2,3… 最后是0
  默认状况下， 至少会启动以下3个的Servlet: 
  org.apache.catalina.servlets.DefaultServlet   
      处理静态资源的Servlet. 什么图片啊， html啊， css啊， js啊都找他
  org.apache.catalina.servlets.InvokerServlet
      处理没有作Servlet Mapping的那些Servlet.
  org.apache.jasper.servlet.JspServlet 
      处理JSP文件的.
       5.15  标识context已经启动完毕。
 走了多少个步骤啊， Context总算是启动完毕喽。
    OK! 走到了这里， 每一个容器以及组件都启动完毕。 Tomcat终于不辞辛劳地为人民服务了！
3. 参考文献：
    <http://jakarta.apache.org/tomcat/>
    <http://www.onjava.com/pub/a/onjava/2003/05/14/java_webserver.html>
    
4. 后记
    这篇文章是讲解tomcat启动框架的，还有篇文章是讲解TOMCAT里面的消息处理流程的细节的。 文章内容已经写好了， 如今正在整理阶段。 相信很快就能够作出来， 你们共同研究共同进步。
    这篇文章是独自分析TOMCAT源码所写的， 因此必定有地方是带有我的主观色彩， 不免会有片面之处。如有不当之处敬请批评指教，这样不只可使刚开始研究TOMCAT的兄弟们少走弯路， 我也能够学到东西。
    email: sojan_java@yahoo.com.cn

5. tomcat源码分析(消息处理)