tomcat解析(十二)StandardHost

首先看构造方法:
       /** * Create a new StandardHost component with the default basic Valve. */ public StandardHost() { super(); pipeline.setBasic(new StandardHostValve()); }

可看到与StandardEngine如出一辙,具体对象作用我们将等到处理客户端请求处理说明

在上文看到在StandardEngine的start方法里又会调用StandardHost的start方法,因此下面这个将主要说明一下该方法的内容
<一>start方法
      /** * Start this host. * * @exception LifecycleException if this component detects a fatal error * that prevents it from being started */ public synchronized void start() throws LifecycleException { if( started ) { return; } if( ! initialized ) init(); // Look for a realm - that may have been configured earlier. // If the realm is added after context - it'll set itself. if( realm == null ) { ObjectName realmName=null; try { realmName=new ObjectName( domain + ":type=Realm,host=" + getName()); if( mserver.isRegistered(realmName ) ) { mserver.invoke(realmName, "init", new Object[] {}, new String[] {} ); } } catch( Throwable t ) { log.debug("No realm for this host " + realmName); } } // Set error report valve if ((errorReportValveClass != null) && (!errorReportValveClass.equals(""))) { try { boolean found = false; if(errorReportValveObjectName != null) { ObjectName[] names = ((StandardPipeline)pipeline).getValveObjectNames(); for (int i=0; !found && i<names.length; i++) if(errorReportValveObjectName.equals(names[i])) found = true ; } if(!found) { Valve valve = (Valve) Class.forName(errorReportValveClass) .newInstance(); addValve(valve); errorReportValveObjectName = ((ValveBase)valve).getObjectName() ; } } catch (Throwable t) { log.error(sm.getString ("standardHost.invalidErrorReportValveClass", errorReportValveClass), t); } } if(log.isDebugEnabled()) { if (xmlValidation) log.debug(sm.getString("standardHost.validationEnabled")); else log.debug(sm.getString("standardHost.validationDisabled")); } super.start(); }
    所调用的init()方法如下:
    public void init() { if( initialized ) return; initialized=true; // already registered. if( getParent() == null ) { try { // Register with the Engine ObjectName serviceName=new ObjectName(domain + ":type=Engine"); HostConfig deployer = new HostConfig(); addLifecycleListener(deployer); if( mserver.isRegistered( serviceName )) { if(log.isDebugEnabled()) log.debug("Registering "+ serviceName +" with the Engine"); mserver.invoke( serviceName, "addChild", new Object[] { this }, new String[] { "org.apache.catalina.Container" } ); } } catch( Exception ex ) { log.error("Host registering failed!",ex); } } if( oname==null ) { // not registered in JMX yet - standalone mode try { StandardEngine engine=(StandardEngine)parent; domain=engine.getName(); if(log.isDebugEnabled()) log.debug( "Register host " + getName() + " with domain "+ domain ); oname=new ObjectName(domain + ":type=Host,host=" + this.getName()); controller = oname; Registry.getRegistry(null, null) .registerComponent(this, oname, null); } catch( Throwable t ) { log.error("Host registering failed!", t ); } } }
    这里有做判断是否将该StandardHost实例设置为上一StandardEngine的child数组内,若没有则调用该方法进行处理,并同时添加LifecycleListener,类型为HostConfig,事实上在Catalina解析XML的时候,已经有这两步的Rule相应的设置了,因此其实这里只做一下保险处理.另外还是一些注册对象对象.
    调度完init方法后,依然调用了其父类的start方法,即ContainerBase.start(),这个方法在StandardEngine那篇已看过了,其实内容就是调用StandardHost对象上的Lifecycle监听者的各个相应方法以及各子对象的start方法,其中也有child对象组的start方法,该子对象是何类呢?这个需要看StandardContext类的实例化的方法调用相关的Rule设置内容便可知晓,其实对于哪个对象将会是哪个对象的父级或子级对象,可直接看server.xml文件即可,因为这些层级都是依照server.xml里元素的层级关系而来的,这里子对象类为StandardContext类
如StandardEngine一样,在调用super.start时,会触发相应的Lifecycle事件,因此会调用其监听器HostConfig的相应处理方法,方法内容如下:
       /** * Process the START event for an associated Host. * * @param event The lifecycle event that has occurred */ public void lifecycleEvent(LifecycleEvent event) { if (event.getType().equals(Lifecycle.PERIODIC_EVENT)) check(); // Identify the host we are associated with try { host = (Host) event.getLifecycle(); if (host instanceof StandardHost) { setDeployXML(((StandardHost) host).isDeployXML()); setUnpackWARs(((StandardHost) host).isUnpackWARs()); setXmlNamespaceAware(((StandardHost) host).getXmlNamespaceAware()); setXmlValidation(((StandardHost) host).getXmlValidation()); } } catch (ClassCastException e) { log.error(sm.getString("hostConfig.cce", event.getLifecycle()), e); return; } // Process the event that has occurred if (event.getType().equals(Lifecycle.START_EVENT)) start(); else if (event.getType().equals(Lifecycle.STOP_EVENT)) stop(); }
    当事件名为Lifecycle.PERIODIC_EVENT时,将调用check方法,这个事件是在ContainerBase.start()里的threadStart()启动的线程里触发的,但其实check里所做的内容与下边的Lifecycle.START_EVENT所做的事是相似的,我们可看一下START_EVENT对应的start方法的内容
   /** * Process a "start" event for this Host. */ public void start() { if (log.isDebugEnabled()) log.debug(sm.getString("hostConfig.start")); try { ObjectName hostON = new ObjectName(host.getObjectName()); oname = new ObjectName (hostON.getDomain() + ":type=Deployer,host=" + host.getName()); Registry.getRegistry(null, null).registerComponent (this, oname, this.getClass().getName()); } catch (Exception e) { log.error(sm.getString("hostConfig.jmx.register", oname), e); } if (host.getDeployOnStartup()) deployApps(); }
    如果该设置启动的时候部署,则会执行deployApps,而默认StandardHost是设置为true的,再看deployApps如下:
    /** * Deploy applications for any directories or WAR files that are found * in our "application root" directory. */ protected void deployApps() { File appBase = appBase(); File configBase = configBase(); // Deploy XML descriptors from configBase deployDescriptors(configBase, configBase.list()); // Deploy WARs, and loop if additional descriptors are found deployWARs(appBase, appBase.list()); // Deploy expanded folders deployDirectories(appBase, appBase.list()); }
1.deployDescriptors
    部署xml文件对应的context
    这句代码将得到context配置文件的路径
    File configBase = configBase(); /** * Return a File object representing the "configuration root" directory * for our associated Host. */ protected File configBase() { if (configBase != null) { return configBase; } File file = new File(System.getProperty("catalina.base"), "conf"); Container parent = host.getParent(); if ((parent != null) && (parent instanceof Engine)) { file = new File(file, parent.getName()); } file = new File(file, host.getName()); try { configBase = file.getCanonicalFile(); } catch (IOException e) { configBase = file; } return (configBase); }
    通过查看server.xml可看到Engine.getName()="Catalina",host.getName="localhost",因此这里将返回
    ${catalina.base}/conf/Catalina/localhost/目录
    deployDescriptors(configBase, configBase.list());如下:
   /** * Deploy XML context descriptors. */ protected void deployDescriptors(File configBase, String[] files) { if (files == null) return; for (int i = 0; i < files.length; i++) { if (files[i].equalsIgnoreCase("META-INF")) continue; if (files[i].equalsIgnoreCase("WEB-INF")) continue; File contextXml = new File(configBase, files[i]); if (files[i].toLowerCase().endsWith(".xml")) { // Calculate the context path and make sure it is unique String nameTmp = files[i].substring(0, files[i].length() - 4); String contextPath = "/" + nameTmp.replace('#', '/'); if (nameTmp.equals("ROOT")) { contextPath = ""; } if (isServiced(contextPath)) continue; String file = files[i]; deployDescriptor(contextPath, contextXml, file); } } }
    取得configBase目录下的xml文件,计算其contextPath(部署后在浏览器上打路径时http://localhost:8080/后面的内容),然后调用deployDescriptor方法,如下:
    /** * @param contextPath * @param contextXml * @param file */ protected void deployDescriptor(String contextPath, File contextXml, String file) { if (deploymentExists(contextPath)) { return; } DeployedApplication deployedApp = new DeployedApplication(contextPath); // Assume this is a configuration descriptor and deploy it if(log.isDebugEnabled()) { log.debug(sm.getString("hostConfig.deployDescriptor", file)); } Context context = null; try { synchronized (digester) { try { context = (Context) digester.parse(contextXml); if (context == null) { log.error(sm.getString("hostConfig.deployDescriptor.error", file)); return; } } finally { digester.reset(); } } if (context instanceof Lifecycle) { Class clazz = Class.forName(host.getConfigClass()); LifecycleListener listener = (LifecycleListener) clazz.newInstance(); ((Lifecycle) context).addLifecycleListener(listener); } context.setConfigFile(contextXml.getAbsolutePath()); context.setPath(contextPath); // Add the associated docBase to the redeployed list if it's a WAR boolean isExternalWar = false; boolean isExternal = false; if (context.getDocBase() != null) { File docBase = new File(context.getDocBase()); if (!docBase.isAbsolute()) { docBase = new File(appBase(), context.getDocBase()); } // If external docBase, register .xml as redeploy first if (!docBase.getCanonicalPath().startsWith( appBase().getAbsolutePath() + File.separator)) { isExternal = true; deployedApp.redeployResources.put (contextXml.getAbsolutePath(), new Long(contextXml.lastModified())); deployedApp.redeployResources.put(docBase.getAbsolutePath(), new Long(docBase.lastModified())); if (docBase.getAbsolutePath().toLowerCase().endsWith(".war")) { isExternalWar = true; } } else { log.warn(sm.getString("hostConfig.deployDescriptor.localDocBaseSpecified", docBase)); // Ignore specified docBase context.setDocBase(null); } } host.addChild(context); // Get paths for WAR and expanded WAR in appBase String name = null; String path = context.getPath(); if (path.equals("")) { name = "ROOT"; } else { if (path.startsWith("/")) { name = path.substring(1); } else { name = path; } } File expandedDocBase = new File(appBase(), name); if (context.getDocBase() != null) { // first assume docBase is absolute expandedDocBase = new File(context.getDocBase()); if (!expandedDocBase.isAbsolute()) { // if docBase specified and relative, it must be relative to appBase expandedDocBase = new File(appBase(), context.getDocBase()); } } // Add the eventual unpacked WAR and all the resources which will be // watched inside it if (isExternalWar && unpackWARs) { deployedApp.redeployResources.put(expandedDocBase.getAbsolutePath(), new Long(expandedDocBase.lastModified())); deployedApp.redeployResources.put (contextXml.getAbsolutePath(), new Long(contextXml.lastModified())); addWatchedResources(deployedApp, expandedDocBase.getAbsolutePath(), context); } else { // Find an existing matching war and expanded folder if (!isExternal) { File warDocBase = new File(expandedDocBase.getAbsolutePath() + ".war"); if (warDocBase.exists()) { deployedApp.redeployResources.put(warDocBase.getAbsolutePath(), new Long(warDocBase.lastModified())); } } if (expandedDocBase.exists()) { deployedApp.redeployResources.put(expandedDocBase.getAbsolutePath(), new Long(expandedDocBase.lastModified())); addWatchedResources(deployedApp, expandedDocBase.getAbsolutePath(), context); } else { addWatchedResources(deployedApp, null, context); } // Add the context XML to the list of files which should trigger a redeployment if (!isExternal) { deployedApp.redeployResources.put (contextXml.getAbsolutePath(), new Long(contextXml.lastModified())); } } } catch (Throwable t) { log.error(sm.getString("hostConfig.deployDescriptor.error", file), t); } if (context != null && host.findChild(context.getName()) != null) { deployed.put(contextPath, deployedApp); } }
    实例化一个代表每一个部署的context的对象
    DeployedApplication deployedApp = new DeployedApplication(contextPath);
    对contextXml进行解析,生成一个context实例,为其设置LifecycleListener,将其加到Host的children Map里,这里调用的是ContainerBase.addChild,可看到在加入该MAP外,会调用child的start方法,这里先不进行细讲,下篇再讲StandardContext.start();查看相应context的xml里的docBase是否存在,存在则判断是tomcat外部文件系统的还是在${catalina.base}/webapps下的,判断是war包还是文件夹格式,分别加入deployedApp及deployed,如
    deployedApp.redeployResources.put(warDocBase.getAbsolutePath(),new Long(warDocBase.lastModified()));
    app.reloadResources.put(resource.getAbsolutePath(),new Long(resource.lastModified()));
    deployed.put(contextPath, deployedApp);
2.deployWARs
    部署webapps下war包对应的context,为何是webapps目录呢?是在appBase代码中确定的
    File appBase = appBase();
  deployWARs(appBase, appBase.list());
  appBase方法如下:
  /** * Return a File object representing the "application root" directory * for our associated Host. */ protected File appBase() { if (appBase != null) { return appBase; } File file = new File(host.getAppBase()); if (!file.isAbsolute()) file = new File(System.getProperty("catalina.base"), host.getAppBase()); try { appBase = file.getCanonicalFile(); } catch (IOException e) { appBase = file; } return (appBase); }
    而host.getAppBase()取的是StandardHost的appBase属性,默认为空,但在实例化StandardHost的时候便为其赋了值,具体什么值是根据server.xml里的<Host>配置的
3.deployDirectories
    使用类似的过程部署webapps目录下的工程目录
<二>check方法
   /** * Check status of all webapps. */ protected void check() { if (host.getAutoDeploy()) { // Check for resources modification to trigger redeployment DeployedApplication[] apps = (DeployedApplication[]) deployed.values().toArray(new DeployedApplication[0]); for (int i = 0; i < apps.length; i++) { if (!isServiced(apps[i].name)) checkResources(apps[i]); } // Hotdeploy applications deployApps(); } } checkResources如下: /** * Check resources for redeployment and reloading. */ protected synchronized void checkResources(DeployedApplication app) { String[] resources = (String[]) app.redeployResources.keySet().toArray(new String[0]); for (int i = 0; i < resources.length; i++) { File resource = new File(resources[i]); if (log.isDebugEnabled()) log.debug("Checking context[" + app.name + "] redeploy resource " + resource); if (resource.exists()) { long lastModified = ((Long) app.redeployResources.get(resources[i])).longValue(); if ((!resource.isDirectory()) && resource.lastModified() > lastModified) { // Undeploy application if (log.isInfoEnabled()) log.info(sm.getString("hostConfig.undeploy", app.name)); ContainerBase context = (ContainerBase) host.findChild(app.name); try { host.removeChild(context); } catch (Throwable t) { log.warn(sm.getString ("hostConfig.context.remove", app.name), t); } try { context.destroy(); } catch (Throwable t) { log.warn(sm.getString ("hostConfig.context.destroy", app.name), t); } // Delete other redeploy resources for (int j = i + 1; j < resources.length; j++) { try { File current = new File(resources[j]); current = current.getCanonicalFile(); if ((current.getAbsolutePath().startsWith(appBase().getAbsolutePath() + File.separator)) || (current.getAbsolutePath().startsWith(configBase().getAbsolutePath()))) { if (log.isDebugEnabled()) log.debug("Delete " + current); ExpandWar.delete(current); } } catch (IOException e) { log.warn(sm.getString ("hostConfig.canonicalizing", app.name), e); } } deployed.remove(app.name); return; } } else { long lastModified = ((Long) app.redeployResources.get(resources[i])).longValue(); if (lastModified == 0L) { continue; } // Undeploy application if (log.isInfoEnabled()) log.info(sm.getString("hostConfig.undeploy", app.name)); ContainerBase context = (ContainerBase) host.findChild(app.name); try { host.removeChild(context); } catch (Throwable t) { log.warn(sm.getString ("hostConfig.context.remove", app.name), t); } try { context.destroy(); } catch (Throwable t) { log.warn(sm.getString ("hostConfig.context.destroy", app.name), t); } // Delete all redeploy resources for (int j = i + 1; j < resources.length; j++) { try { File current = new File(resources[j]); current = current.getCanonicalFile(); if ((current.getAbsolutePath().startsWith(appBase().getAbsolutePath() + File.separator)) || (current.getAbsolutePath().startsWith(configBase().getAbsolutePath()))) { if (log.isDebugEnabled()) log.debug("Delete " + current); ExpandWar.delete(current); } } catch (IOException e) { log.warn(sm.getString ("hostConfig.canonicalizing", app.name), e); } } // Delete reload resources as well (to remove any remaining .xml descriptor) String[] resources2 = (String[]) app.reloadResources.keySet().toArray(new String[0]); for (int j = 0; j < resources2.length; j++) { try { File current = new File(resources2[j]); current = current.getCanonicalFile(); if ((current.getAbsolutePath().startsWith(appBase().getAbsolutePath() + File.separator)) || ((current.getAbsolutePath().startsWith(configBase().getAbsolutePath()) && (current.getAbsolutePath().endsWith(".xml"))))) { if (log.isDebugEnabled()) log.debug("Delete " + current); ExpandWar.delete(current); } } catch (IOException e) { log.warn(sm.getString ("hostConfig.canonicalizing", app.name), e); } } deployed.remove(app.name); return; } } resources = (String[]) app.reloadResources.keySet().toArray(new String[0]); for (int i = 0; i < resources.length; i++) { File resource = new File(resources[i]); if (log.isDebugEnabled()) log.debug("Checking context[" + app.name + "] reload resource " + resource); long lastModified = ((Long) app.reloadResources.get(resources[i])).longValue(); if ((!resource.exists() && lastModified != 0L) || (resource.lastModified() != lastModified)) { // Reload application if(log.isInfoEnabled()) log.info(sm.getString("hostConfig.reload", app.name)); Container context = host.findChild(app.name); try { ((Lifecycle) context).stop(); } catch (Exception e) { log.warn(sm.getString ("hostConfig.context.restart", app.name), e); } // If the context was not started (for example an error // in web.xml) we'll still get to try to start try { ((Lifecycle) context).start(); } catch (Exception e) { log.warn(sm.getString ("hostConfig.context.restart", app.name), e); } // Update times app.reloadResources.put(resources[i], new Long(resource.lastModified())); app.timestamp = System.currentTimeMillis(); return; } } }
    通过比对context的被关注的resources来判断是否有做过变更,如果是的话即将该context删除,这里的被关注的resources我们将在Context一文中进行说明
    最后又调用deployApps对context重新部署