tomcat解析(十三)StandardContext

在一个tomcat服务器的生命周期内可以会创建一个或多个StandardContext对象，StandardContext对象代表的是一个具体的工程项目，对应的可以是server.xml里的<context>标签或webapps文件夹下的某一个工程文件夹或war包，也可以对应于conf/Catalina/localhost文件夹下的任一个xml文件里的Context配置，在tomcat中，这些context代表的是某一具体的工程，在某一主机可以部署多个工程，如在webapps里可以有多个工程，因此可以这样理解，某一工程对应于某一主机，但某一主机可以对应多个工程，在tomcat里，某一具体的主机由StardardHost对象表示，通常在本机做测试时是localhost，但当使用集群时则可能需要做一些额外的配置，这里先不做讨论。下面我们继续看一下在tomcat初始化过程StandardContext类里做了什么事情

有构造方法如下:
       /** * Create a new StandardContext component with the default basic Valve. */ public StandardContext() { super(); pipeline.setBasic(new StandardContextValve()); broadcaster = new NotificationBroadcasterSupport(); }

<一>start方法
内容很多,但与StardardHost相异不大,同样的，主要的工作都交由其LifecycleListener来完成，可以在server.xml或HostConfig类里看到，StardardContext的监听器类为ContextConfig,在的start方法里每次触发一下Lifecycle事件的时候便会调用ConctextConfig类的lifecycleEvent方法,在该方法里进行了所有对某一Web工程的解析工作,该方法如下:
      /** * Process events for an associated Context. * * @param event The lifecycle event that has occurred */ public void lifecycleEvent(LifecycleEvent event) { // Identify the context we are associated with try { context = (Context) event.getLifecycle(); } catch (ClassCastException e) { log.error(sm.getString("contextConfig.cce", event.getLifecycle()), e); return; } // Process the event that has occurred if (event.getType().equals(Lifecycle.START_EVENT)) { start(); } else if (event.getType().equals(StandardContext.BEFORE_START_EVENT)) { beforeStart(); } else if (event.getType().equals(StandardContext.AFTER_START_EVENT)) { // Restore docBase for management tools if (originalDocBase != null) { String docBase = context.getDocBase(); context.setDocBase(originalDocBase); originalDocBase = docBase; } } else if (event.getType().equals(Lifecycle.STOP_EVENT)) { if (originalDocBase != null) { String docBase = context.getDocBase(); context.setDocBase(originalDocBase); originalDocBase = docBase; } stop(); } else if (event.getType().equals(Lifecycle.INIT_EVENT)) { init(); } else if (event.getType().equals(Lifecycle.DESTROY_EVENT)) { destroy(); } }
    在StandardContext.start()里依次触发了INIT_EVENT,BEFORE_START_EVENT,START_EVENT,AFTER_START_EVENT,下面让我们看一下ContextConfig对应的init,beforeStart,start方法,如下:
   /** * Process a "init" event for this Context. */ protected void init() { // Called from StandardContext.init() if (webDigester == null){ webDigester = createWebDigester(); webDigester.getParser(); } if (contextDigester == null){ contextDigester = createContextDigester(); contextDigester.getParser(); } if (log.isDebugEnabled()) log.debug(sm.getString("contextConfig.init")); context.setConfigured(false); ok = true; contextConfig(); try { fixDocBase(); } catch (IOException e) { log.error(sm.getString("contextConfig.fixDocBase"), e); } }
    这里实例化了两个Digester类,分别为webDigester,contextDigester,createWebDigester创建Digester后设置了其RuleSet为WebRuleSet,该类设置为解析web.xml所需要的所有Rule;createContextDigester类设置了解析<Context>相关的Rule;contextConfig()对默认的配置文件如conf/context.xml或context.xml.default进行解析,产生相应的context对象
        在ContextConfig.start里进行了对具体某一Context对应的Web工程的解析,当然最主要的是对web.xml文件的解析,以下是start方法的内容:
       /** * Process a "start" event for this Context. */ protected synchronized void start() { // Called from StandardContext.start() if (log.isDebugEnabled()) log.debug(sm.getString("contextConfig.start")); // Set properties based on DefaultContext Container container = context.getParent(); if( !context.getOverride() ) { if( container instanceof Host ) { // Reset the value only if the attribute wasn't // set on the context. xmlValidation = context.getXmlValidation(); if (!xmlValidation) { xmlValidation = ((Host)container).getXmlValidation(); } xmlNamespaceAware = context.getXmlNamespaceAware(); if (!xmlNamespaceAware){ xmlNamespaceAware = ((Host)container).getXmlNamespaceAware(); } container = container.getParent(); } } // Process the default and application web.xml files defaultWebConfig(); applicationWebConfig(); if (!context.getIgnoreAnnotations()) { applicationAnnotationsConfig(); } if (ok) { validateSecurityRoles(); } // Configure an authenticator if we need one if (ok) authenticatorConfig(); // Dump the contents of this pipeline if requested if ((log.isDebugEnabled()) && (context instanceof ContainerBase)) { log.debug("Pipeline Configuration:"); Pipeline pipeline = ((ContainerBase) context).getPipeline(); Valve valves[] = null; if (pipeline != null) valves = pipeline.getValves(); if (valves != null) { for (int i = 0; i < valves.length; i++) { log.debug(" " + valves[i].getInfo()); } } log.debug("======================"); } // Make our application available if no problems were encountered if (ok) context.setConfigured(true); else { log.error(sm.getString("contextConfig.unavailable")); context.setConfigured(false); } }
1.defaultWebConfig主要用于处理默认的web.xml,TOMCAT服务器有一些默认的WEB.XML,在默认的web.xml里做的配置可生效于所有的web工程,我们可以看一下该方法里将会对哪些默认的文件进行处理,该方法如下:
   /** * Process the default configuration file, if it exists. * The default config must be read with the container loader - so * container servlets can be loaded */ protected void defaultWebConfig() { long t1=System.currentTimeMillis(); // Open the default web.xml file, if it exists if( defaultWebXml==null && context instanceof StandardContext ) { defaultWebXml=((StandardContext)context).getDefaultWebXml(); } // set the default if we don't have any overrides if( defaultWebXml==null ) getDefaultWebXml(); File file = new File(this.defaultWebXml); if (!file.isAbsolute()) { file = new File(getBaseDir(), this.defaultWebXml); } InputStream stream = null; InputSource source = null; try { if ( ! file.exists() ) { // Use getResource and getResourceAsStream stream = getClass().getClassLoader() .getResourceAsStream(defaultWebXml); if( stream != null ) { source = new InputSource (getClass().getClassLoader() .getResource(defaultWebXml).toString()); } if( stream== null ) { // maybe embedded stream = getClass().getClassLoader() .getResourceAsStream("web-embed.xml"); if( stream != null ) { source = new InputSource (getClass().getClassLoader() .getResource("web-embed.xml").toString()); } } if( stream== null ) { log.info("No default web.xml"); } } else { source = new InputSource("file://" + file.getAbsolutePath()); stream = new FileInputStream(file); context.addWatchedResource(file.getAbsolutePath()); } } catch (Exception e) { log.error(sm.getString("contextConfig.defaultMissing") + " " + defaultWebXml + " " + file , e); } if (stream != null) { processDefaultWebConfig(webDigester, stream, source); webRuleSet.recycle(); } long t2=System.currentTimeMillis(); if( (t2-t1) > 200 ) log.debug("Processed default web.xml " + file + " " + ( t2-t1)); stream = null; source = null; String resourceName = getHostConfigPath(Constants.HostWebXml); file = new File(getConfigBase(), resourceName); try { if ( ! file.exists() ) { // Use getResource and getResourceAsStream stream = getClass().getClassLoader() .getResourceAsStream(resourceName); if( stream != null ) { source = new InputSource (getClass().getClassLoader() .getResource(resourceName).toString()); } } else { source = new InputSource("file://" + file.getAbsolutePath()); stream = new FileInputStream(file); } } catch (Exception e) { log.error(sm.getString("contextConfig.defaultMissing") + " " + resourceName + " " + file , e); } if (stream != null) { processDefaultWebConfig(webDigester, stream, source); webRuleSet.recycle(); } }
    首先要得到defaultWebXml的值,该值默认为空,因此将调用((StandardContext)context).getDefaultWebXml(),context里的DefaultWebXml是需要配置的(如server.xml),如果没有配置的话将调用ContextConfig.getDefaultWebXml()来获取,该方法如下:
    public static final String DefaultWebXml = "conf/web.xml"; ...... /** * Return the location of the default deployment descriptor */ public String getDefaultWebXml() { if( defaultWebXml == null ) { defaultWebXml=Constants.DefaultWebXml; } return (this.defaultWebXml); }
    可以看到DefaultWebXml所代表的是conf下的web.xml文件,下面的步骤包括转换成绝对路径,读取输入流,加入到Context的WatchedResource等,这里看一下WatchedResource部分将如何处理
    /** * Add a new watched resource to the set recognized by this Context. * * @param name New watched resource file name */ public void addWatchedResource(String name) { synchronized (watchedResourcesLock) { String results[] = new String[watchedResources.length + 1]; for (int i = 0; i < watchedResources.length; i++) results[i] = watchedResources[i]; results[watchedResources.length] = name; watchedResources = results; } fireContainerEvent("addWatchedResource", name); }
    可以看到内容就是将该文件的绝对路径字符串加入到Context持有的watchedResources字符串数组中,该数组也可以在context的配置xml文件里配置,最后触发容器监听事件
剩余的内容与上面类似,但处理的是web.xml.default.
2.applicationWebConfig
   /** * Process the application configuration file, if it exists. */ protected void applicationWebConfig() { String altDDName = null; // Open the application web.xml file, if it exists InputStream stream = null; ServletContext servletContext = context.getServletContext(); if (servletContext != null) { altDDName = (String)servletContext.getAttribute( Globals.ALT_DD_ATTR); if (altDDName != null) { try { stream = new FileInputStream(altDDName); } catch (FileNotFoundException e) { log.error(sm.getString("contextConfig.altDDNotFound", altDDName)); } } else { stream = servletContext.getResourceAsStream (Constants.ApplicationWebXml); } } if (stream == null) { if (log.isDebugEnabled()) { log.debug(sm.getString("contextConfig.applicationMissing") + " " + context); } return; } long t1=System.currentTimeMillis(); URL url=null; // Process the application web.xml file synchronized (webDigester) { try { if (altDDName != null) { url = new File(altDDName).toURL(); } else { url = servletContext.getResource( Constants.ApplicationWebXml); } if( url!=null ) { InputSource is = new InputSource(url.toExternalForm()); is.setByteStream(stream); if (context instanceof StandardContext) { ((StandardContext) context).setReplaceWelcomeFiles(true); } webDigester.push(context); webDigester.setErrorHandler(new ContextErrorHandler()); if(log.isDebugEnabled()) { log.debug("Parsing application web.xml file at " + url.toExternalForm()); } webDigester.parse(is); if (parseException != null) { ok = false; } } else { log.info("No web.xml, using defaults " + context ); } } catch (SAXParseException e) { log.error(sm.getString("contextConfig.applicationParse", url.toExternalForm()), e); log.error(sm.getString("contextConfig.applicationPosition", "" + e.getLineNumber(), "" + e.getColumnNumber())); ok = false; } catch (Exception e) { log.error(sm.getString("contextConfig.applicationParse", url.toExternalForm()), e); ok = false; } finally { webDigester.reset(); parseException = null; try { if (stream != null) { stream.close(); } } catch (IOException e) { log.error(sm.getString("contextConfig.applicationClose"), e); } } } webRuleSet.recycle(); long t2=System.currentTimeMillis(); if (context instanceof StandardContext) { ((StandardContext) context).setStartupTime(t2-t1); } }
    如果我们有设置ServletContext的altDDName属性,则会读取其altDDName属性对应的值为路径来读取相应的配置,如果没有配置(一般都没有),那将会读取Constants.ApplicationWebXml路径对应的文件,而这个常量即是我们经常会看到的/WEB-INF/web.xml;最后使用在INIT方法初始化完成的webDigester来对这个配置文件进行解析,下文我们来看一下其解析过程
3.applicationAnnotationsConfig
    设置工程对注释敏感,从JDK1.5开始,JAVA便支持注释(annotation),因此TOMCAT版本也相应做了处理来支持这种功能,因为本人对这块也不是很熟悉,因此这里先不对这部分内容做详解,哈哈
4.validateSecurityRoles
    这里对web.xml里设置的一些roles进行一些简单的校验,然后全部放到context持有的字符串数组securityRoles里
5.authenticatorConfig
    这里会根据web.xml里配置的login-config等权限安全访问来确定是否为本context配置一个用于确定访问权限的Valve(授权管理器),该对象将被放于StandardContext持有的StandardPipeline对象里（如构造方法里）,调用的是StandardPipeline.addValve方法,该方法如下:
   /** * <p>Add a new Valve to the end of the pipeline associated with this * Container. Prior to adding the Valve, the Valve's * <code>setContainer()</code> method will be called, if it implements * <code>Contained</code>, with the owning Container as an argument. * The method may throw an * <code>IllegalArgumentException</code> if this Valve chooses not to * be associated with this Container, or <code>IllegalStateException</code> * if it is already associated with a different Container.</p> * * @param valve Valve to be added * * @exception IllegalArgumentException if this Container refused to * accept the specified Valve * @exception IllegalArgumentException if the specifie Valve refuses to be * associated with this Container * @exception IllegalStateException if the specified Valve is already * associated with a different Container */ public void addValve(Valve valve) { // Validate that we can add this Valve if (valve instanceof Contained) ((Contained) valve).setContainer(this.container); // Start the new component if necessary if (started) { if (valve instanceof Lifecycle) { try { ((Lifecycle) valve).start(); } catch (LifecycleException e) { log.error("StandardPipeline.addValve: start: ", e); } } // Register the newly added valve registerValve(valve); } // Add this Valve to the set associated with this Pipeline if (first == null) { first = valve; valve.setNext(basic); } else { Valve current = first; while (current != null) { if (current.getNext() == basic) { current.setNext(valve); valve.setNext(basic); break; } current = current.getNext(); } } }
    StandardPipeline是一个类似管道理念的类,其内存储着一连串有着前后关系的同一接口的处理类,当需要使用该管道类来处理某一应用时，会以一种链式的方式处理,每一个处理类执行完自己处理的部分后交由下一个处理类,依次类推直至最终的basic Vavle,在basic vavle执行完将返回前一个处理类执行剩余部分,再依次类推直至第一个处理类,这个理念也是WEB工程中Filter的实现方式,相似方式实现的还有struts 2的拦截器实现.
    下一篇我们先来说一下对web.xml解析的某些值得留意的内容,之后再来看一下对于客户端发起的一个请求,TOMCAT服务器是如何进行处理的