根据你的应用需求,fileupload可以有许多不同的使用方式。在最简单的情况下,你可以调用一个简单的方法来解析servlet请求,然后在他们提 交到你的应用时处理表单列表。在其它规模的终端上,你也可能决定将fileupload进行自定义,以完全控制个别表单项存储的方法。比如,你或许会将内 容流化来保存到数据中。
在这里。我们将要描述fileupload的基本使用方法,然后解释一些更简单的,以及最常用的使用模式。fileupload的个性化在这里得到了描述。
它怎么工作
一个文件上传请求由有序表单项的列表组成,这些表单是根据RFC1867来编码的,是在html中基于表单的文件上传。fileupload能解析这样一 个请求然后向你的应用提供一个单独的上传表单项的列表。每一个这样的表单项实现了FileItem接口,而不需要考虑它潜在的实现方式。每个文件的表单项 拥有一系列可能对你的应用有用的属性,比如,每个项目都有一个名字和文件类型,你就可以提供一个InputStream来取它的数据。从另一方面说,你可 能需要对这些选项进行不同的处理,这个可以根据对这个选项是不是一个规则的表单项来判断,即可以根据这个数据是否来源于普通的文本框或者一个简单的 html表单域,还是一个能被上传的文件。FileItem接口提供了多种方法来判断它是否是一个可上传的文件,然后你就可以用最合适的方式来处理这些数 据了。FileUpload使用FileItemFactory来创建新的文件项目。这正是给FileUpload带来灵活性的原因。这个工厂最终控制每 个项目的创建。默认的工厂在内存或者磁盘上保存了项目的数据,这个可以根据项目的大小来定(例如,字节数据)。当然,这个动作可以通过自定义来满足你应用 的需要。
解析请求
在你对要上传的选项处理之前,很显然的你得先解析这些请求本身。很直接的就是要确保这个请求是不是一个要上传的文件,然而FileUpload使这一点简单化了,你只需提供一个静态的方法来做到这一点。
//检查是否是一个文件上传请求
boolean isMultipart = FileUpload.isMultipartContent(request);
现在我们就可以准备解析这个请求到一个备选的选项了。解析的结果是一个文件选项的List,每个这样的选项都实现了FileItem接口,处理这些选项将在下面得到讨论。
最简单的情况
最简单的使用场景可以参照下面:
- 被上传得选项必须以适度的大小驻留在内存中;
- 比较大的文件上传选项必须写入到磁盘的临时文件中去;
- 大文件上传请求必须不被允许;
- 默认的驻留内存的选项的最大大小,最大允许的上传文件请求,和临时文件的存储地方是可以接受的;
在这种情景下处理这样一个请求并不是很简单的:
//创建一个新的文件上传句柄
DiskFileUpload upload = new DiskFileUpload();
//解析请求
List /* FileItem */ items = upload.parseRequest(request);
这就是所有我们需要做的,真的!
解析的结果是一个文件项目的List,每一个都实现了FileItem接口。处理这些项目将在下面讨论。
练习更多的控制
如果你的使用情景非常接近最简单的使用方式,在上文中可以看到,但是你需要更多的控制临界的大小和临时文件的驻留地址,你可以使用DiskFileUpload类的方法来自定义这些动作,就像这样:
//创建一个新的文件上传句柄
DiskFileUpload upload = new DiskFileUpload();
//设置上传参数
upload.setSizeThrehold(最大内存大小);
upload.setSizeMax(最大请求大小);
upload.setRepositoryPath(临时目录);
//解析请求
List /* FileItem */ items = upload.parseRequest(request);
当然,每个配置方法都是独立于其它的,但是如果你想一次就配置它们,你可以使用可选的parseRequest()方法,像这样:
// 建立一个新的文件上传句柄
DiskFileUpload upload = new DiskFileUpload();
// 解析请求
List /* FileItem */ items = upload.parseRequest(request,
内存大小, 允许上传的最大文件, 临时目录);
如果你想更多地控制请求的解析,比如把上传选项存储到其它地方,例如,存到数据库中-你可以参照自定义FileUpload。
处理上传选项
一旦解析过程完毕,你就可以获得一个文件选项的List,以便进一步处理。在大多数情况下,你将会根据规则的表单域来不同地处理文件的上传。所以你可能以这样的方式来处理:
// 处理上传的选项
Iterator iter = items.iterator();
while (iter.hasNext()) {
FileItem item = (FileItem) iter.next();
if (item.isFormField()) {
processFormField(item);
} else {
processUploadedFile(item);
}
}
对于一个规则的表单域来说,你对它感兴趣的可能就只有它的名字以及它的字符串值。你也会想到,处理它们是简单的:
//处理一个规则表单域
if (item.isFormField()) {
String name = item.getFieldName();
String value = item.getString();
...
}
而对于一个文件的上传,在你处理它的内容之前,可以有好多令你想知道的不同的东西,这里有一个采用了一些你可能感兴趣的方法的例子
// 处理一个文件上传
if (!item.isFormField()) {
String fieldName = item.getFieldName();
String fileName = item.getName();
String contentType = item.getContentType();
boolean isInMemory = item.isInMemory();
long sizeInBytes = item.getSize();
...
}
对于这些上传的文件,你一般不想通过内存来存取它们,除非它们很小,或者你没有其它好的方法,更进一步,你想将内容当作文件流来处理,或者将整个文件写到最终的地址。FileUpload提供了简单的方法来完成这些 操作。
// 处理一个文件上传的情况
if (writeToFile) {
File uploadedFile = new File(...);
item.write(uploadedFile);
} else {
InputStream uploadedStream = item.getInputStream();
...
uploadedStream.close();
}
注意到,在默认的FileUpload的实现中,write()方法将尝试把文件改名以将它保存到特定的地点,如果 数据已经在临时文件中了,如果重命名失败,实际的复制文件就完成了(?),在其它原因看来,或者数据已经在内存中了。如果你的确需要在内存中取上传的数 据,你只需简单的调用get()方法来把它当作一个字符数组来获得。
// 在内存中处理一个上传的文件
byte[] data = item.get();
...
和杀毒软件的相互作用
应用,这个已经超出了本文档的讨论范围。
希望这个页面能提供给你一个好的意见,让你在你自己的应用中能使用FileUpload。更多关于这里介绍的方法, 以及其它可用的方法,你可以参照api文档。这里介绍的用法已经可以满足大多数的文件上传的需要了,当然,如果你还有更多的复杂的需求,使用它的灵活的自 定义配置的能力,FileUpload一定可以能够帮助你。
一个简单的示例:
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Iterator;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
public class FileUploadServlet extends HttpServlet {
public FileUploadServlet() {
super();
}
public void destroy() {
super.destroy(); // Just puts "destroy" string in log
// Put your code here
}
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doPost(request, response);
}
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
final long MAX_SIZE = 3 * 1024 * 1024;// 设置上传文件最大为 3M
// 允许上传的文件格式的列表
final String[] allowedExt = new String[] { "jpg", "jpeg", "gif", "txt",
"doc", "docx", "mp3", "wma", "m4a" };
response.setContentType("text/html");
// 设置字符编码为UTF-8, 这样支持汉字显示
response.setCharacterEncoding("UTF-8");
// 实例化一个硬盘文件工厂,用来配置上传组件ServletFileUpload
DiskFileItemFactory dfif = new DiskFileItemFactory();
dfif.setSizeThreshold(4096);// 设置上传文件时用于临时存放文件的内存大小,这里是4K.多于的部分将临时存在硬盘
dfif.setRepository(new File(request.getRealPath("/")
+ "ImagesUploadTemp"));// 设置存放临时文件的目录,web根目录下的ImagesUploadTemp目录
// 用以上工厂实例化上传组件
ServletFileUpload sfu = new ServletFileUpload(dfif);
// 设置最大上传尺寸
sfu.setSizeMax(MAX_SIZE);
PrintWriter out = response.getWriter();
// 从request得到 所有 上传域的列表
List fileList = null;
try {
fileList = sfu.parseRequest(request);
} catch (FileUploadException e) {// 处理文件尺寸过大异常
if (e instanceof SizeLimitExceededException) {
out.println("文件尺寸超过规定大小:" + MAX_SIZE + "字节<p />");
out.println("<a href=\"upload.html\" target=\"_top\">返回</a>");
return;
}
e.printStackTrace();
}
// 没有文件上传
if (fileList == null || fileList.size() == 0) {
out.println("请选择上传文件<p />");
out.println("<a href=\"upload.html\" target=\"_top\">返回</a>");
return;
}
// 得到所有上传的文件
Iterator fileItr = fileList.iterator();
// 循环处理所有文件
while (fileItr.hasNext()) {
FileItem fileItem = null;
String path = null;
long size = 0;
// 得到当前文件
fileItem = (FileItem) fileItr.next();
// 忽略简单form字段而不是上传域的文件域(<input type="text" />等)
if (fileItem == null || fileItem.isFormField()) {
continue;
}
// 得到文件的完整路径
path = fileItem.getName();
// 得到文件的大小
size = fileItem.getSize();
if ("".equals(path) || size == 0) {
out.println("请选择上传文件<p />");
out.println("<a href=\"upload.html\" target=\"_top\">返回</a>");
return;
}
// 得到去除路径的文件名
String t_name = path.substring(path.lastIndexOf("\\") + 1);
// 得到文件的扩展名(无扩展名时将得到全名)
String t_ext = t_name.substring(t_name.lastIndexOf(".") + 1);
// 拒绝接受规定文件格式之外的文件类型
int allowFlag = 0;
int allowedExtCount = allowedExt.length;
for (; allowFlag < allowedExtCount; allowFlag++) {
if (allowedExt[allowFlag].equals(t_ext))
break;
}
if (allowFlag == allowedExtCount) {
out.println("请上传以下类型的文件<p />");
for (allowFlag = 0; allowFlag < allowedExtCount; allowFlag++)
out.println("*." + allowedExt[allowFlag]
+ " ");
out.println("<p /><a href=\"upload.html\" target=\"_top\">返回</a>");
return;
}
long now = System.currentTimeMillis();
// 根据系统时间生成上传后保存的文件名
String prefix = String.valueOf(now);
// 保存的最终文件完整路径,保存在web根目录下的ImagesUploaded目录下
String u_name = request.getRealPath("/") + "ImagesUploaded/"
+ prefix + "." + t_ext;
try {
// 保存文件
fileItem.write(new File(u_name));
out.println("文件上传成功. 已保存为: " + prefix + "." + t_ext
+ " 文件大小: " + size + "字节<p />");
out.println("<a href=\"upload.html\" target=\"_top\">继续上传</a>");
} catch (Exception e) {
e.printStackTrace();
}
}
}
public void init() throws ServletException {
// Put your code here
}
}