Servlet 2.3过滤器编程(二)
文件上传过滤器
我们将看到的最后一个过滤器是处理多路/多类型数据的POST请求,该类型的请求能包含文件上传。每个多路/多类型数据POST请求包含所有参数和文件,使用一种servlet不能识别的特别的格式。历史上Servlet开发者使用第三方类来处理上传,例如在我的com.oreilly.servlet包中的MultipartRequest和MultipartParser类。这里我们将看到一种使用MultipartFilter的新方法来是处理这种请求更容易。该过滤器基于com.oreilly.servlet包下的parsers构建并已经被集成到该包中(参见Resources)。
MultipartFilter工作与观察输入的请求,当它发现一个文件上传请求时(content type:multipart/form-data),过滤器使用一个知道如何分析这种特殊content type格式的特殊请求包来将请求对象进行包装。servlet获取此特殊请求包并通过标准的getParameter()方法来无缝地访问此multipart参数,因为这个wrapper中已经重新定义了这些方法的功能。此servelt能够通过将requset转换成wrapper类型并使用wrapper中附加的getFile()方法来处理文件上传。
过滤器代码:
package com.oreilly.servlet;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
public class MultipartFilter implements Filter {
private FilterConfig config = null;
private String dir = null;
public void init(FilterConfig config) throws ServletException {
this.config = config;
// Determine the upload directory. First look for an uploadDir filter
// init parameter. Then look for the context tempdir.
dir = config.getInitParameter("uploadDir");
if (dir == null) {
File tempdir = (File) config.getServletContext()
.getAttribute("javax.servlet.context.tempdir");
if (tempdir != null) {
dir = tempdir.toString();
}
else {
throw new ServletException(
"MultipartFilter: No upload directory found: set an uploadDir " +
"init parameter or ensure the javax.servlet.context.tempdir " +
"directory is valid");
}
}
}
public void destroy() {
config = null;
}
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
HttpServletRequest req = (HttpServletRequest) request;
String type = req.getHeader("Content-Type");
// If this is not a multipart/form-data request continue
if (type == null || !type.startsWith("multipart/form-data")) {
chain.doFilter(request, response);
}
else {
MultipartWrapper multi = new MultipartWrapper(req, dir);
chain.doFilter(multi, response);
}
}
}
init()方法确定文件上传的路径。这是multipart parser放置文件的地方,因此实际的请求并不需要驻留在内存中。它先查找uploadDir过滤器初始化参数,如果没找到,则使用默认的tempdir目录——Servlet API 2.2中的标准context属性。
doFilter()方法检查请求的content type,如果是multipart/form-data请求,则将此请求用MultipartWrapper打包。wrapper代码如下:
package com.oreilly.servlet;
import java.io.*;
import java.util.*;
import javax.servlet.*;
import javax.servlet.http.*;
public class MultipartWrapper extends HttpServletRequestWrapper {
MultipartRequest mreq = null;
public MultipartWrapper(HttpServletRequest req, String dir)
throws IOException {
super(req);
mreq = new MultipartRequest(req, dir);
}
// Methods to replace HSR methods
public Enumeration getParameterNames() {
return mreq.getParameterNames();
}
public String getParameter(String name) {
return mreq.getParameter(name);
}
public String[] getParameterValues(String name) {
return mreq.getParameterValues(name);
}
public Map getParameterMap() {
Map map = new HashMap();
Enumeration enum = getParameterNames();
while (enum.hasMoreElements()) {
String name = (String) enum.nextElement();
map.put(name, mreq.getParameterValues(name));
}
return map;
}
// Methods only in MultipartRequest
public Enumeration getFileNames() {
return mreq.getFileNames();
}
public String getFilesystemName(String name) {
return mreq.getFilesystemName(name);
}
public String getContentType(String name) {
return mreq.getContentType(name);
}
public File getFile(String name) {
return mreq.getFile(name);
}
}
wrapper构造了一个com.oreilly.servlet.MultipartRequest对象以处理上传分析并重载getParameter()方法族以使用MultipartRequest取代未加工的请求来读取参数值。wrapper也定义了不同的getFile()方法以使一个servlet接收打包过的请求以能通过调用其他方法来处理上传的文件。
Web.xml部署描述器用如下代码来添加此过滤器:
<filter>
<filter-name>multipartFilter</filter-name>
<filter-class>com.oreilly.servlet.MultipartFilter</filter-class>
<!--
<init-param>
<param-name>uploadDir</param-name>
<param-value>/tmp</param-value>
</init-param>
-->
</filter>
<filter-mapping>
<filter-name>multipartFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<servlet>
<servlet-name>
uploadTest
</servlet-name>
<servlet-class>
UploadTest
</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>
uploadTest
</servlet-name>
<url-pattern>
/uploadTest
</url-pattern>
</servlet-mapping>
UploadText servlet如下:
import java.io.*;
import java.util.*;
import javax.servlet.*;
import javax.servlet.http.*;
import com.oreilly.servlet.*;
public class UploadTest extends HttpServlet {
public void doPost(HttpServletRequest req, HttpServletResponse res)
throws ServletException, IOException {
res.setContentType("text/html");
PrintWriter out = res.getWriter();
out.println("<HTML>");
out.println("<HEAD><TITLE>UploadTest</TITLE></HEAD>");
out.println("<BODY>");
out.println("<H1>UploadTest</H1>");
// Parameters can now be read the same way for both
// application/x-www-form-urlencoded and multipart/form-data requests!
out.println("<H3>Request Parameters:</H3><PRE>");
Enumeration enum = req.getParameterNames();
while (enum.hasMoreElements()) {
String name = (String) enum.nextElement();
String values[] = req.getParameterValues(name);
if (values != null) {
for (int i = 0; i < values.length; i++) {
out.println(name + " (" + i + "): " + values[i]);
}
}
}
out.println("</PRE>");
// Files can be read if the request class is MultipartWrapper
// Init params to MultipartWrapper control the upload handling
if (req instanceof MultipartWrapper) {
try {
// Cast the request to a MultipartWrapper
MultipartWrapper multi = (MultipartWrapper) req;
// Show which files we received
out.println("<H3>Files:</H3>");
out.println("<PRE>");
Enumeration files = multi.getFileNames();
while (files.hasMoreElements()) {
String name = (String)files.nextElement();
String filename = multi.getFilesystemName(name);
String type = multi.getContentType(name);
File f = multi.getFile(name);
out.println("name: " + name);
out.println("filename: " + filename);
out.println("type: " + type);
if (f != null) {
out.println("length: " + f.length());
}
out.println();
}
out.println("</PRE>");
}
catch (Exception e) {
out.println("<PRE>");
e.printStackTrace(out);
out.println("</PRE>");
}
}
out.println("</BODY></HTML>");
}
}
servlet的前一半显示了过滤器如何将参数数据毫无改变的传送给接收的servlet。后半部分则显示了一个servlet是如何将请求向下传送给MultipartWrapper以获得附加的文件访问方法。
一个驱动此servlet的HTML例子如下:
<FORM ACTION="uploadTest" ENCTYPE="multipart/form-data" METHOD=POST>
What is your name? <INPUT TYPE=TEXT NAME=submitter> <BR>
What is your age? <INPUT TYPE=TEXT NAME=age> <BR>
Which file do you want to upload? <INPUT TYPE=FILE NAME=file1> <BR>
Any other file to upload? <INPUT TYPE=FILE NAME=file2> <BR>
<INPUT TYPE=SUBMIT>
</FORM>
这是可能的输出:
UploadTest
Request Parameters:
submitter (0): Jason
age (0): 28
Files:
name: file1
filename: 4008b21.tif
type: application/octet-stream
length: 39396
name: file2
filename: null
type: null
你们也许会疑惑我们如何确信由过滤器设置的MultipartWrapper能正确的传送给接下来的servlet。在2号发布稿规范和Tomcat 4.0 beta 5中,那是不确定的。实际上,如果你试图用/servlet/UploadTest去访问此servlet,你将注意到过滤并没有正确工作,因为/servlet的调用将MultipartWrapper转给Tomcat自己的特殊wrapper了。这允许参数能被正确解析,但文件访问方法却不能正确工作。在Servlet API专家组的讨论中,我们决定servlet容器不能对过滤器的wrapper做更多的包装。这个servlet规范将被修改的更清楚。在Tomcat 4.0以后版本中将澄清这些规则。短期的办法是在请求wrapper中使用getRequest()方法来“沿着”请求去找到这个隐藏的multipart wrapper。
从如下地址下载该WAR文件:
http://www.javaworld.com/jw-06-2001/Filters/mulitpart.war
过滤器能力
Servlet过滤器提供了一中强大的能力来控制请求的操作和响应的发生,提供新的servlet功能而不需要太多的代码。我希望通过这些已经向你展示使用过滤器的可能情况,并教给你一些关于如何更有效的使用新的过滤器机能的技巧。
感谢这些过滤器的作者以及其他对过滤器提供有用建议的的人:Amy Roh,Criag McClanahan,Serge Knystautas,以及OpenSymphony成员。
关于作者
见原文
资源
见原文
file://请达人给指点斧正了,谢谢:)