tomcat解压war包的一点例外

我在项目的开发过程中，发现Tomcat解压war 的一点例外。
   
   现象如下：

       使用ANT工具把web应用程序打包为war文件。然后把war文件放到tomcat的webapps，让tomcat自己解压。结果出现解压的web应用程序文件丢失。使用rar工具打开war文件。文件都齐全。怎么有这种现象呢？？查看tomcat的log文档。发现在解压war文档NullpointException.我升级tomcat到5.0还是出现这种现象。

jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/startup/HostConfig.java

   解决方法：

       我从tomcat网站下载了catalina 的原代码，进行分析。发现是在解压war文件出现input为null,而 input= jar.getInputStream(entry);然后提高tomcat的debug级别。可以在tomcat的log文档看到tomcat解压war文档的过程。发现如果某些文件名为???.txt,经检查发现原来这个文件的文件名为汉字。
      噢！才发现war文件在解压的过程中无法处理汉字的文件名。（因为找不到文件名为???.txt的文件而导致null例外。原来这个文件是个注释文档），所以在使用ant把web应用程序打包为war文件，一定要把文件名为汉字的文件去掉。使用Forte for java的IDE工具把web应用程序打包为war文件会不包含这些文件名为汉字的文件
。

下面是部分war文档解压的部分代码

代码采自jakarta.org 



 类HostConfig.java

jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/startup/HostConfig.java

   解决方法：

       我从tomcat网站下载了catalina 的原代码，进行分析。发现是在解压war文件出现input为null,而 input= jar.getInputStream(entry);然后提高tomcat的debug级别。可以在tomcat的log文档看到tomcat解压war文档的过程。发现如果某些文件名为???.txt,经检查发现原来这个文件的文件名为汉字。
      噢！才发现war文件在解压的过程中无法处理汉字的文件名。（因为找不到文件名为???.txt的文件而导致null例外。原来这个文件是个注释文档），所以在使用ant把web应用程序打包为war文件，一定要把文件名为汉字的文件去掉。使用Forte for java的IDE工具把web应用程序打包为war文件会不包含这些文件名为汉字的文件
。

下面是部分war文档解压的部分代码

代码采自jakarta.org 



 类HostConfig.java

jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/startup/HostConfig.java

1.  protected void deployWARs(File appBase, String[] files) {
3.         for (int i = 0; i < files.length; i++) {
5.             if (files[i].equalsIgnoreCase("META-INF"))
6.                 continue;
7.             if (files[i].equalsIgnoreCase("WEB-INF"))
8.                 continue;
9.             if (deployed.contains(files[i]))
10.                 continue;
11.             File dir = new File(appBase, files[i]);
12.             if (files[i].toLowerCase().endsWith(".war")) {
14.                 deployed.add(files[i]);
16.                 // Calculate the context path and make sure it is unique
17.                 String contextPath = "/" + files[i];
18.                 int period = contextPath.lastIndexOf(".");
19.                 if (period >= 0)
20.                     contextPath = contextPath.substring(0, period);
21.                 if (contextPath.equals("/ROOT"))
22.                     contextPath = "";
23.                 if (host.findChild(contextPath) != null)
24.                     continue;
26.                 // Checking for a nested /META-INF/context.xml
27.                 JarFile jar = null;
28.                 JarEntry entry = null;
29.                 InputStream istream = null;
30.                 BufferedOutputStream ostream = null;
31.                 File xml = new File
32.                     (configBase, files[i].substring
33.                      (0, files[i].lastIndexOf(".")) + ".xml");
34.                 if (!xml.exists()) {
35.                     try {
36.                         jar = new JarFile(dir);
37.                         entry = jar.getJarEntry("META-INF/context.xml");
38.                         if (entry != null) {
39.                             istream = jar.getInputStream(entry);
40.                             ostream =
41.                                 new BufferedOutputStream
42.                                 (new FileOutputStream(xml), 1024);
43.                             byte buffer[] = new byte[1024];
44.                             while (true) {
45.                                 int n = istream.read(buffer);
46.                                 if (n < 0) {
47.                                     break;
48.                                 }
49.                                 ostream.write(buffer, 0, n);
50.                             }
51.                             ostream.flush();
52.                             ostream.close();
53.                             ostream = null;
54.                             istream.close();
55.                             istream = null;
56.                             entry = null;
57.                             jar.close();
58.                             jar = null;
59.                             deployDescriptors(configBase(), configBase.list());
60.                             return;
61.                         }
62.                     } catch (Exception e) {
63.                         // Ignore and continue
64.                         if (ostream != null) {
65.                             try {
66.                                 ostream.close();
67.                             } catch (Throwable t) {
68.                                 ;
69.                             }
70.                             ostream = null;
71.                         }
72.                         if (istream != null) {
73.                             try {
74.                                 istream.close();
75.                             } catch (Throwable t) {
76.                                 ;
77.                             }
78.                             istream = null;
79.                         }
80.                         entry = null;
81.                         if (jar != null) {
82.                             try {
83.                                 jar.close();
84.                             } catch (Throwable t) {
85.                                 ;
86.                             }
87.                             jar = null;
88.                         }
89.                     }
90.                 }
92.                 if (isUnpackWARs()) {
94.                     // Expand and deploy this application as a directory
95.                     log.debug(sm.getString("hostConfig.expand", files[i]));
96.                     URL url = null;
97.                     String path = null;
98.                     try {
99.                         url = new URL("jar:file:" +
100.                                       dir.getCanonicalPath() + "!/");
101.                         path = ExpandWar.expand(host, url);
102.                     } catch (IOException e) {
103.                         // JAR decompression failure
104.                         log.warn(sm.getString
105.                                  ("hostConfig.expand.error", files[i]));
106.                         continue;
107.                     } catch (Throwable t) {
108.                         log.error(sm.getString
109.                                   ("hostConfig.expand.error", files[i]), t);
110.                         continue;
111.                     }
112.                     try {
113.                         if (path != null) {
114.                             url = new URL("file:" + path);
115.                             ((Deployer) host).install(contextPath, url);
116.                         }
117.                     } catch (Throwable t) {
118.                         log.error(sm.getString
119.                                   ("hostConfig.expand.error", files[i]), t);
120.                     }
122.                 } else {
124.                     // Deploy the application in this WAR file
125.                     log.info(sm.getString("hostConfig.deployJar", files[i]));
126.                     try {
127.                         URL url = new URL("file", null,
128.                                           dir.getCanonicalPath());
129.                         url = new URL("jar:" + url.toString() + "!/");
130.                         ((Deployer) host).install(contextPath, url);
131.                     } catch (Throwable t) {
132.                         log.error(sm.getString("hostConfig.deployJar.error",
133.                                          files[i]), t);
134.                     }
136.                 }
138.             }
140.         }
142.     }

类 ExpandWar.java
jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/startup/ExpandWar.java

1. package org.apache.catalina.startup;
3. import java.io.BufferedOutputStream;
4. import java.io.File;
5. import java.io.FileOutputStream;
6. import java.io.InputStream;
7. import java.io.IOException;
8. import java.net.JarURLConnection;
9. import java.net.URL;
10. import java.util.Enumeration;
11. import java.util.jar.JarEntry;
12. import java.util.jar.JarFile;
14. import org.apache.catalina.Host;
15. import org.apache.catalina.Logger;
16. import org.apache.catalina.core.StandardHost;
17. import org.apache.catalina.util.StringManager;
19. /**
20.  * Expand out a WAR in a Host‘s appBase.
21.  *
22.  * @author Craig R. McClanahan
23.  * @author Remy Maucherat
24.  * @author Glenn L. Nielsen
25.  * @version $Revision: 1.4 $
26.  */
28. public class ExpandWar {
31.     /**
32.      * The string resources for this package.
33.      */
34.     protected static final StringManager sm =
35.         StringManager.getManager(Constants.Package);
38.     /**
39.      * Expand the WAR file found at the specified URL into an unpacked
40.      * directory structure, and return the absolute pathname to the expanded
41.      * directory.
42.      *
43.      * @param host Host war is being installed for
44.      * @param war URL of the web application archive to be expanded
45.      *  (must start with "jar:")
46.      *
47.      * @exception IllegalArgumentException if this is not a "jar:" URL
48.      * @exception IOException if an input/output error was encountered
49.      *  during expansion
50.      */
51.     public static String expand(Host host, URL war)
52.         throws IOException {
54.         int debug = 0;
55.         Logger logger = host.getLogger();
57.         if (host instanceof StandardHost) {
58.             debug = ((StandardHost) host).getDebug();
59.         }
61.         // Calculate the directory name of the expanded directory
62.         if (debug >= 1) {
63.             logger.log("expand(" + war.toString() + ")");
64.         }
65.         String pathname = war.toString().replace(‘\\‘, ‘/‘);
66.         if (pathname.endsWith("!/")) {
67.             pathname = pathname.substring(0, pathname.length() - 2);
68.         }
69.         int period = pathname.lastIndexOf(‘.‘);
70.         if (period >= pathname.length() - 4)
71.             pathname = pathname.substring(0, period);
72.         int slash = pathname.lastIndexOf(‘/‘);
73.         if (slash >= 0) {
74.             pathname = pathname.substring(slash + 1);
75.         }
76.         if (debug >= 1) {
77.             logger.log("  Proposed directory name: " + pathname);
78.         }
79.         return expand(host, war, pathname);
81.     }
84.     /**
85.      * Expand the WAR file found at the specified URL into an unpacked
86.      * directory structure, and return the absolute pathname to the expanded
87.      * directory.
88.      *
89.      * @param host Host war is being installed for
90.      * @param war URL of the web application archive to be expanded
91.      *  (must start with "jar:")
92.      * @param pathname Context path name for web application
93.      *
94.      * @exception IllegalArgumentException if this is not a "jar:" URL
95.      * @exception IOException if an input/output error was encountered
96.      *  during expansion
97.      */
98.     public static String expand(Host host, URL war, String pathname)
99.         throws IOException {
101.         int debug = 0;
102.         Logger logger = host.getLogger();
104.         if (host instanceof StandardHost) {
105.             debug = ((StandardHost) host).getDebug();
106.         }
108.         // Make sure that there is no such directory already existing
109.         File appBase = new File(host.getAppBase());
110.         if (!appBase.isAbsolute()) {
111.             appBase = new File(System.getProperty("catalina.base"),
112.                                host.getAppBase());
113.         }
114.         if (!appBase.exists() || !appBase.isDirectory()) {
115.             throw new IOException
116.                 (sm.getString("hostConfig.appBase",
117.                               appBase.getAbsolutePath()));
118.         }
119.         File docBase = new File(appBase, pathname);
120.         if (docBase.exists()) {
121.             // War file is already installed
122.             return (docBase.getAbsolutePath());
123.         }
125.         // Create the new document base directory
126.         docBase.mkdir();
127.         if (debug >= 2) {
128.             logger.log("  Have created expansion directory " +
129.                 docBase.getAbsolutePath());
130.         }
132.         // Expand the WAR into the new document base directory
133.         JarURLConnection juc = (JarURLConnection) war.openConnection();
134.         juc.setUseCaches(false);
135.         JarFile jarFile = null;
136.         InputStream input = null;
137.         try {
138.             jarFile = juc.getJarFile();
139.             if (debug >= 2) {
140.                 logger.log("  Have opened JAR file successfully");
141.             }
142.             Enumeration jarEntries = jarFile.entries();
143.             if (debug >= 2) {
144.                 logger.log("  Have retrieved entries enumeration");
145.             }
146.             while (jarEntries.hasMoreElements()) {
147.                 JarEntry jarEntry = (JarEntry) jarEntries.nextElement();
148.                 String name = jarEntry.getName();
149.                 if (debug >= 2) {
150.                     logger.log("  Am processing entry " + name);
151.                 }
152.                 int last = name.lastIndexOf(‘/‘);
153.                 if (last >= 0) {
154.                     File parent = new File(docBase,
155.                                            name.substring(0, last));
156.                     if (debug >= 2) {
157.                         logger.log("  Creating parent directory " + parent);
158.                     }
159.                     parent.mkdirs();
160.                 }
161.                 if (name.endsWith("/")) {
162.                     continue;
163.                 }
164.                 if (debug >= 2) {
165.                     logger.log("  Creating expanded file " + name);
166.                 }
167.                 input = jarFile.getInputStream(jarEntry);
168.                 expand(input, docBase, name);
169.                 input.close();
170.                 input = null;
171.             }
172.         } catch (IOException e) {
173.             // If something went wrong, delete expanded dir to keep things 
174.             // clean
175.             deleteDir(docBase);
176.             throw e;
177.         } finally {
178.             if (input != null) {
179.                 try {
180.                     input.close();
181.                 } catch (Throwable t) {
182.                     ;
183.                 }
184.                 input = null;
185.             }
186.             if (jarFile != null) {
187.                 try {
188.                     jarFile.close();
189.                 } catch (Throwable t) {
190.                     ;
191.                 }
192.                 jarFile = null;
193.             }
194.         }
196.         // Return the absolute path to our new document base directory
197.         return (docBase.getAbsolutePath());
199.     }
202.     /**
203.      * Delete the specified directory, including all of its contents and
204.      * subdirectories recursively.
205.      *
206.      * @param dir File object representing the directory to be deleted
207.      */
208.     public static void deleteDir(File dir) {
210.         String files[] = dir.list();
211.         if (files == null) {
212.             files = new String[0];
213.         }
214.         for (int i = 0; i < files.length; i++) {
215.             File file = new File(dir, files[i]);
216.             if (file.isDirectory()) {
217.                 deleteDir(file);
218.             } else {
219.                 file.delete();
220.             }
221.         }
222.         dir.delete();
224.     }
227.     /**
228.      * Expand the specified input stream into the specified directory, creating
229.      * a file named from the specified relative path.
230.      *
231.      * @param input InputStream to be copied
232.      * @param docBase Document base directory into which we are expanding
233.      * @param name Relative pathname of the file to be created
234.      *
235.      * @exception IOException if an input/output error occurs
236.      */
237.     protected static void expand(InputStream input, File docBase, String name)
238.         throws IOException {
240.         File file = new File(docBase, name);
241.         BufferedOutputStream output = null;
242.         try {
243.             output = 
244.                 new BufferedOutputStream(new FileOutputStream(file));
245.             byte buffer[] = new byte[2048];
246.             while (true) {
247.                 [b]int n = input.read(buffer);[/b]               
248.                 if (n <= 0)
249.                     break;
250.                 output.write(buffer, 0, n);
251.             }
252.         } finally {
253.             if (output != null) {
254.                 try {
255.                     output.close();
256.                 } catch (IOException e) {
257.                     // Ignore
258.                 }
259.             }
260.         }
262.     }
265. }