> Linux服务器 > Tomcat >

Tomcat学习之ContextConfig

时间:2014-12-30 13:19  来源:linux.it.net.cn   作者:IT

同HostConfig一样，ContextConfig也是在Digester解析server.xml的时候添加到StandardContext上的监听器，ContextConfig主要是处理web应用的配置文件，先看看它的init方法做了哪些事？

 


 
  1. protected void init() {  
  2.     // Called from StandardContext.init()  
  3.     Digester contextDigester = createContextDigester();  
  4.     contextDigester.getParser();  
  5.     if (log.isDebugEnabled())  
  6.         log.debug(sm.getString("contextConfig.init"));  
  7.     context.setConfigured(false);  
  8.     ok = true;  
  9.       
  10.     contextConfig(contextDigester);  
  11.       
  12.     createWebXmlDigester(context.getXmlNamespaceAware(),  
  13.             context.getXmlValidation());  
  14.   
  15.     try {  
  16.         fixDocBase();  
  17.     } catch (IOException e) {  
  18.         log.error(sm.getString(  
  19.                 "contextConfig.fixDocBase", context.getName()), e);  
  20.     }  
  21.       
  22. }  
1、处理Context的两个默认配置文件：conf/context.xml和/conf/[enginename]/[hostname]/context.xml.default，解析到context中；
2、对war包进行校验：主要是校验目录结构（是否有WEB-INF目录，是否有classes目录和META-INF目录等）
3、对于没有解压的文件还会将其解压：是在ExpandWar类的expand方法中完成的
[java] view plaincopyprint?
 
  1. public static String expand(Host host, URL war, String pathname)  
  2.     throws IOException {  
  3.     ...  
  4.     // Expand the WAR into the new document base directory  
  5.     JarURLConnection juc = (JarURLConnection) war.openConnection();  
  6.     juc.setUseCaches(false);  
  7.     JarFile jarFile = null;  
  8.     InputStream input = null;  
  9.     boolean success = false;  
  10.     try {  
  11.         jarFile = juc.getJarFile();  
  12.         Enumeration<JarEntry> jarEntries = jarFile.entries();  
  13.         while (jarEntries.hasMoreElements()) {  
  14.             JarEntry jarEntry = jarEntries.nextElement();  
  15.             String name = jarEntry.getName();  
  16.             File expandedFile = new File(docBase, name);  
  17.             if (!expandedFile.getCanonicalPath().startsWith(  
  18.                     canonicalDocBasePrefix)) {  
  19.                //... throw exception  
  20.             }  
  21.             int last = name.lastIndexOf('/');  
  22.             if (last >= 0) {  
  23.                 File parent = new File(docBase,  
  24.                                        name.substring(0, last));  
  25.                 if (!parent.mkdirs() && !parent.isDirectory()) {  
  26.                     throw new IOException(  
  27.                             sm.getString("expandWar.createFailed", parent));  
  28.                 }  
  29.             }  
  30.             input = jarFile.getInputStream(jarEntry);  
  31.             expand(input, expandedFile);  
  32.             input.close();  
  33.     } catch (IOException e) {  
  34.         //  
  35.     } finally {  
  36.         //release resource  
  37.     }  
  38. }  

(1)、将war文件转换成jarEntries，并遍历
(2)、如果在webapps外直接抛异常
(3)、如果为目录，就在对应位置创建目录，否则就将文件读入input中，调用expand(input, expandedFile方法将文件内容copy到解压后的目录中

[java] view plaincopyprint?
 
  1. private static void expand(InputStream input, File file)  
  2.         throws IOException {  
  3.         BufferedOutputStream output = null;  
  4.         try {  
  5.             output =   
  6.                 new BufferedOutputStream(new FileOutputStream(file));  
  7.             byte buffer[] = new byte[2048];  
  8.             while (true) {  
  9.                 int n = input.read(buffer);  
  10.                 if (n <= 0)  
  11.                     break;  
  12.                 output.write(buffer, 0, n);  
  13.             }  
  14.         } finally {  
  15.             if (output != null) {  
  16.                 try {  
  17.                     output.close();  
  18.                 } catch (IOException e) {  
  19.                     // Ignore  
  20.                 }  
  21.             }  
  22.         }  
  23.     }  

就是一个IO操作，每次读取2k数据到文件中。

顺着生命周期，init后就应该是configureStart，configureStart方法中做的最重要的一件事就是配置web.xml文件，实现细节在webConfig中完成的：
1、扫描/META-INF/lib/目录下的jar文件，如果在META-INF下含有web-fragment.xml文件，解析它；
2、确定确定这些xml片段的顺序,servlet 3.0可以将配置文件分散在多个jar包里面，而且还可以定义这些配置文件的顺序。分为绝对顺序和相对顺序，绝对顺序是通过absolute-ordering标签定义的
<web-app>  
<name>...</name>  
<absolute-ordering>  
<name>fragment1</name>  
<name>fragment2</name>  
</absolute-ordering>  
</web-app>  
还可以在web-fragment.xml里面通过before,after标签来定义这些配置文件的先后顺序，这里不再举例
这步主要是根据顺序，将这些配置文件加到集合orderedFragments中
3、处理ServletContainerInitializers的实现类，这也是servlet 3.0新增的特性，容器在启动时使用 JAR 服务 API(JAR Service API) 来发现 ServletContainerInitializer 的实现类，并且容器将 WEB-INF/lib 目录下 JAR 包中的类都交给该类的 onStartup() 方法处理，我们通常需要在该实现类上使用 @HandlesTypes 注解来指定希望被处理的类，过滤掉不希望给 onStartup() 处理的类。在onStartup方法中可以优先加载这些类，或者修改其中的方法等。这步主要是把这些类找到放到Set<ServletContainerInitializer> scis中；
4、将应用中的web.xml与orderedFragments进行合并，合并在WebXml类的merge方法中实现
5、将应用中的web.xml与全局的web.xml文件（conf/web.xml和web.xml.default）进行合并
6、用合并好的WebXml来配置Context，这一步在处理servlet时，会为每个servlet创建一个wrapper，并调用addChild将每个wrapper作为context子容器,后续分析
下面简单了解一下WebXml的merge方法的实现，WebXml类是web.xml配置文件类，里面包含web.xml的所有标签，在它里面维护了这些标签的顺序，merge方法实现如下：

 

[java] view plaincopyprint?
 
  1. public boolean merge(Set<WebXml> fragments) {  
  2.     // As far as possible, process in alphabetical order so it is easy to  
  3.     // check everything is present  
  4.       
  5.     // Merge rules vary from element to element. See SRV.8.2.3  
  6.   
  7.     WebXml temp = new WebXml();  
  8.   
  9.     for (WebXml fragment : fragments) {  
  10.         if (!mergeMap(fragment.getContextParams(), contextParams,  
  11.                 temp.getContextParams(), fragment, "Context Parameter")) {  
  12.             return false;  
  13.         }  
  14.     }  
  15.     contextParams.putAll(temp.getContextParams());  
  16.     ...  
  17. }     

 

 

[java] view plaincopyprint?
 
  1. private static <T> boolean mergeMap(Map<String,T> fragmentMap,  
  2.         Map<String,T> mainMap, Map<String,T> tempMap, WebXml fragment,  
  3.         String mapName) {  
  4.     for (Entry<String, T> entry : fragmentMap.entrySet()) {  
  5.         final String key = entry.getKey();  
  6.         if (!mainMap.containsKey(key)) {  
  7.             // Not defined in main web.xml  
  8.             T value = entry.getValue();  
  9.             if (tempMap.containsKey(key)) {  
  10.                 if (value != null && !value.equals(  
  11.                         tempMap.get(key))) {  
  12.                     log.error(sm.getString(  
  13.                             "webXml.mergeConflictString",  
  14.                             mapName,  
  15.                             key,  
  16.                             fragment.getName(),  
  17.                             fragment.getURL()));  
  18.                     return false;  
  19.                 }  
  20.             } else {  
  21.                 tempMap.put(key, value);  
  22.             }  
  23.         }  
  24.     }  
  25.     return true;  
  26. }  
基本上每个标签都是按上面的例子合并的，简单说一下这个算法:

 

有两个map：mapA,mapB,要将mapA中有的在mapB中没有的元素加到mapB中，它的做法是遍历mapA,如果没有在mapB中就将其放入tmpMap中，循环完后mapB.putAll(tmpMap).

(责任编辑：IT)
    最近关注
    热点内容