tomcat生命周期和初始化及启动

　　tomcat初始化及启动
　　前面有一篇提到过下面的截图
　　这里可以看到启动的类为 org.apache.catalina.startup.Bootstrap 调用的是start方法。
　　那我们下载下来tomcat源码之后直接运行这个方法来看下执行日志(源码可以去官网下载，如果需要可以私信或留下邮箱) 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Bootstrap init 信息: Bootstrap--------init() 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Bootstrap load 信息: Bootstrap--------load() 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Catalina load 信息: Catalina--------load() 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Catalina load 警告: Unable to load server configuration from [D:workspacemyProject	omcat8confserver.xml] 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Bootstrap start 信息: Bootstrap--------start() 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Catalina start 信息: Catalina--------start() 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Catalina load 信息: Catalina--------load() 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Catalina load 警告: Unable to load server configuration from [D:workspacemyProject	omcat8confserver.xml] 十月 18, 2021 3:32:15 下午 org.apache.catalina.startup.Catalina start
　　由上面的日志可以看出来一个大体的执行顺序
　　Bootstrap-init() => Bootstrap-load() => Catalina-load() => Bootstrap-start()=> Catalina-start()=> Catalina-load() Tomcat运行入口类/**  * Tomcat运行入口类  */ public static void main(String args[]) {    //初始化阶段  init()     if (daemon == null) {         // Don＂t set daemon until init() has completed         Bootstrap bootstrap = new Bootstrap();         try {             bootstrap.init();         } catch (Throwable t) {             handleThrowable(t);             t.printStackTrace();             return;         }         daemon = bootstrap;     } 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);     }    //运行阶段  start()     try {         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);             daemon.load(args);             daemon.start();         } 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.＂);         }     } 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);     } }init阶段
　　从最开始进行跟进查看Bootstrap.init()
　　Bootstrap.init() public void init(String[] arguments)     throws Exception {     init();     load(arguments); }
　　init // Bootstrap  init public void init() throws Exception {     log.info(＂Bootstrap--------init()＂);     // 初始化 classLoader     // commonLoader、catalinaLoader、sharedLoader，     initClassLoaders();      Thread.currentThread().setContextClassLoader(catalinaLoader);      SecurityClassLoad.securityClassLoad(catalinaLoader);      // Load our startup class and call its process() method     if (log.isDebugEnabled())         log.debug(＂Loading startup class＂);     // 反射获取 Catalina 类对象     Class<?> startupClass =         catalinaLoader.loadClass         (＂org.apache.catalina.startup.Catalina＂);     Object startupInstance = startupClass.newInstance();      // 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;      // 反射执行方法 setParentClassLoader 方法，设置其 parentClassLoader 为 sharedLoader     Method method =         startupInstance.getClass().getMethod(methodName, paramTypes);     method.invoke(startupInstance, paramValues);      // 设置守护对象     catalinaDaemon = startupInstance; }
　　load private void load(String[] arguments) throws Exception {     log.info(＂Bootstrap--------load()＂);     // Call the load() method     String methodName = ＂load＂;     Object param[];     Class<?> paramTypes[];     if (arguments==null || arguments.length==0) {         paramTypes = null;         param = null;     } else {         paramTypes = new Class[1];         paramTypes[0] = arguments.getClass();         param = new Object[1];         param[0] = arguments;     }      // 反射获取方法 load  catalinaDaemon 在init中赋值了为 Catalina     Method method =         catalinaDaemon.getClass().getMethod(methodName, paramTypes);     if (log.isDebugEnabled())         log.debug(＂Calling startup class ＂ + method);     // 执行方法即 Catalina.load     method.invoke(catalinaDaemon, param);  }
　　Catalina.load public void load() {     log.info(＂Catalina--------load()＂);     long t1 = System.nanoTime();      // 初始化一个dir  java.io.tmpdir. 失败打日志，不影响后面执行     initDirs();      // Before digester - it may be needed     initNaming();      // 获取带有配置的 Digester 对象     Digester digester = createStartDigester();      InputSource inputSource = null;     InputStream inputStream = null;     File file = null;     try {         try {             // 读取 conf/server.xml             file = configFile();             inputStream = new FileInputStream(file);             inputSource = new InputSource(file.toURI().toURL().toString());         } catch (Exception e) {             if (log.isDebugEnabled()) {                 log.debug(sm.getString(＂catalina.configFail＂, file), e);             }         }         if (inputStream == null) {             try {                 inputStream = getClass().getClassLoader()                     .getResourceAsStream(getConfigFile());                 inputSource = new InputSource                     (getClass().getClassLoader()                      .getResource(getConfigFile()).toString());             } catch (Exception e) {                 if (log.isDebugEnabled()) {                     log.debug(sm.getString(＂catalina.configFail＂,                                            getConfigFile()), e);                 }             }         }          // This should be included in catalina.jar         // Alternative: don＂t bother with xml, just create it manually.         if (inputStream == null) {             try {                 inputStream = getClass().getClassLoader()                     .getResourceAsStream(＂server-embed.xml＂);                 inputSource = new InputSource                     (getClass().getClassLoader()                      .getResource(＂server-embed.xml＂).toString());             } catch (Exception e) {                 if (log.isDebugEnabled()) {                     log.debug(sm.getString(＂catalina.configFail＂,                                            ＂server-embed.xml＂), e);                 }             }         }          if (inputStream == null || inputSource == null) {             if  (file == null) {                 log.warn(sm.getString(＂catalina.configFail＂,                                       getConfigFile() + ＂] or [server-embed.xml]＂));             } else {                 log.warn(sm.getString(＂catalina.configFail＂,                                       file.getAbsolutePath()));                 if (file.exists() && !file.canRead()) {                     log.warn(＂Permissions incorrect, read permission is not allowed on the file.＂);                 }             }             return;         }          try {             inputSource.setByteStream(inputStream);             digester.push(this);             // 解析server.xml的配置，告诉Digester哪个xml标签应该解析成什么类，如果我们要改变server.xml的某个属性值(比如优化tomcat线程池)，             // 直接查看对应实现类的setXXX方法即可             digester.parse(inputSource);         } catch (SAXParseException spe) {             log.warn(＂Catalina.start using ＂ + getConfigFile() + ＂: ＂ +                      spe.getMessage());             return;         } catch (Exception e) {             log.warn(＂Catalina.start using ＂ + getConfigFile() + ＂: ＂ , e);             return;         }     } finally {         if (inputStream != null) {             try {                 inputStream.close();             } catch (IOException e) {                 // Ignore             }         }     }      // 设置 Catalina 信息     getServer().setCatalina(this);     // Catalina目录     getServer().setCatalinaHome(Bootstrap.getCatalinaHomeFile());     // 工作目录     getServer().setCatalinaBase(Bootstrap.getCatalinaBaseFile());      // Stream redirection     initStreams();      // 最后调用server的init方法      try {         getServer().init();     } catch (LifecycleException e) {         if (Boolean.getBoolean(＂org.apache.catalina.startup.EXIT_ON_INIT_FAILURE＂)) {             throw new java.lang.Error(e);         } else {             log.error(＂Catalina.start＂, e);         }     }      long t2 = System.nanoTime();     if(log.isInfoEnabled()) {         log.info(＂Initialization processed in ＂ + ((t2 - t1) / 1000000) + ＂ ms＂);     } }
　　可以看到在Catalina.load 中调用了 调用server的init方法。这个server实例是哪个类呢？ // 获取带有配置的 Digester 对象 Digester digester = createStartDigester();
　　查看createStartDigester这个方法: ... // Server信息 digester.addObjectCreate(＂Server＂,                          ＂org.apache.catalina.core.StandardServer＂,                          ＂className＂); digester.addSetProperties(＂Server＂); digester.addSetNext(＂Server＂,                     ＂setServer＂,                     ＂org.apache.catalina.Server＂); ...
　　所以我们接着看StandardServer的init方法 /** * Tomcat中Server的初始化方法 */ @Override protected void initInternal() throws LifecycleException {     log.info(＂StandardServer--------init()＂);     super.initInternal();      onameStringCache = register(new StringCache(), ＂type=StringCache＂);      MBeanFactory factory = new MBeanFactory();     factory.setContainer(this);     onameMBeanFactory = register(factory, ＂type=MBeanFactory＂);      globalNamingResources.init();      if (getCatalina() != null) {         ClassLoader cl = getCatalina().getParentClassLoader();         while (cl != null && cl != ClassLoader.getSystemClassLoader()) {             if (cl instanceof URLClassLoader) {                 URL[] urls = ((URLClassLoader) cl).getURLs();                 for (URL url : urls) {                     if (url.getProtocol().equals(＂file＂)) {                         try {                             File f = new File (url.toURI());                             if (f.isFile() &&                                 f.getName().endsWith(＂.jar＂)) {                                 ExtensionValidator.addSystemResource(f);                             }                         } catch (URISyntaxException e) {                             // Ignore                         } catch (IOException e) {                             // Ignore                         }                     }                 }             }             cl = cl.getParent();         }     }     // 初始化我们定义的服务     for (int i = 0; i < services.length; i++) {         services[i].init();     } }
　　上面可以看到 Server.init里面又调用了 service的init。沿着上面的思路进行跟踪初始化的源码（我下面就不展示了）。 start阶段
　　在运行入口类中我们就可以看到启动相关的代码 if (command.equals(＂startd＂)) {     args[args.length - 1] = ＂start＂;     // 初始化     daemon.load(args);     // 启动  这个daemnon在初始化的时候已经知道就是Catalina     daemon.start(); }
　　Catalina.start public void start() {     log.info(＂Catalina--------start()＂);     // 如果没有server就先调用一遍初始化     if (getServer() == null) {         load();     }      if (getServer() == null) {         log.fatal(＂Cannot start server. Server instance is not configured.＂);         return;     }      long t1 = System.nanoTime();      // Start the new server     try {         // 调用server的start方法，         // 初始化的时候已经可以看到 server 是 standardServer         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＂);     }      // Register shutdown hook     if (useShutdownHook) {         if (shutdownHook == null) {             // shutdown线程             shutdownHook = new CatalinaShutdownHook();         }         Runtime.getRuntime().addShutdownHook(shutdownHook);          // If JULI is being used, disable JULI＂s shutdown hook since         // shutdown hooks run in parallel and log messages may be lost         // if JULI＂s hook completes before the CatalinaShutdownHook()         LogManager logManager = LogManager.getLogManager();         if (logManager instanceof ClassLoaderLogManager) {             ((ClassLoaderLogManager) logManager).setUseShutdownHook(                 false);         }     }      // 手写嵌入式toncat借鉴     if (await) {         await();         stop();     } }
　　嗯，后面的过程其实和初始化一样的。
　　下面是一个时序图，有兴趣的可以自己画一下。
　　tomcat生命周期
　　在上面看init阶段的时候其实有一个疑问就是明明是调用的是init方法，但是实际上在对应的类（例如：StandardServer）中的源码却是initInternal方法。拿StandardServer来举例 //  Catalina.load 方法 ... // 最后调用server的init方法  try {     getServer().init(); } catch (LifecycleException e) {     if (Boolean.getBoolean(＂org.apache.catalina.startup.EXIT_ON_INIT_FAILURE＂)) {         throw new java.lang.Error(e);     } else {         log.error(＂Catalina.start＂, e);     } } ...  // 这里返回的是server接口 public Server getServer() {     return server; }
　　StandardServer对应的类关系图谱:
　　LifecycleBase中有如下代码，这样就可以看到在init里面调用的 initInternal()。 //  @Override public final synchronized void init() throws LifecycleException {     if (!state.equals(LifecycleState.NEW)) {         invalidTransition(Lifecycle.BEFORE_INIT_EVENT);     }      try {         setStateInternal(LifecycleState.INITIALIZING, null, false);                 initInternal();         setStateInternal(LifecycleState.INITIALIZED, null, false);     } catch (Throwable t) {         ExceptionUtils.handleThrowable(t);         setStateInternal(LifecycleState.FAILED, null, false);         throw new LifecycleException(             sm.getString(＂lifecycleBase.initFail＂,toString()), t);     } }
　　在来看下下面类架构图：可以看到整个过程中的大部分类最终都会集成或实现Lifecycle
　　这个是一个典型的模板模式
　　整体生命周期如下:
　　当然Tomcat在整体过程中也涉及到状态的管理，使用的就是state属性。下面截图是状态检查的例子之一