在Web应用系统开发中,文件上传和下载功能是非常常用的功能,今天就来讲一下Java Web开发中的文件上传和下载功能的实现。
文件上传概述
实现Web开发中的文件上传功能,需完成如下二步操作:
- 在Web页面中添加上传输入项;
- 在Servlet中读取上传文件的数据,并保存到本地硬盘中。
那如何在Web页面中添加上传输入项呢?我们可以这样回答:<input type="file"
标签用于在Web页面中添加文件上传输入项,设置文件上传输入项时须注意:
- 必须要设置input输入项的name属性,否则浏览器将不会发送上传文件的数据;
- 必须把form的enctype属值设为multipart/form-data。设置该值后,浏览器在上传文件时,将把文件数据附带在http请求消息体中,并使用MIME协议对上传的文件进行描述,以方便接收方对上传数据进行解析和处理。
现在我们设计一个这样的文件上传页面——upload.jsp。
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>文件上传页面</title>
</head>
<body>
<form action="${pageContext.request.contextPath }/UploadServlet" enctype="multipart/form-data" method="post">
上传用户:<input type="text" name="username" /><br/>
上传文件1:<input type="file" name="file1"><br/>
上传文件2:<input type="file" name="file2"><br/>
<input type="submit" value="上传" />
</form>
</body>
</html>
此时表单的提交方式应该为post,因为请求方式为post方式,则可以在请求的实体内容中向服务器发送数据,即文件数据将附带在http请求消息体中。
接下来,我们就要编写UploadServlet了,该Servlet用于处理文件上传请求。若UploadServlet的代码写成这样:
这时我们输入上传用户名和两个文件,Eclipse的控制台输出null。这说明了如果表单类型为multipart/form-data的话,在Servlet中就不能采用传统方式获取数据了。如果读者使用Firefox浏览器的Firebug工具对该请求进行监测的话,则会看到类似于下图的结果:
接下来如何在Servlet中读取文件上传数据,并保存到本地硬盘中呢?Request对象提供了一个getInputStream方法,通过这个方法可以读取到客户端提交过来的数据。但由于用户可能会同时上传多个文件,在Servlet端编程直接读取上传数据,并分别解析出相应的文件数据是一项非常麻烦的工作。于是,我们可以把UploadServlet的代码修改为:
这时我们再次输入上传用户名和两个文件,Eclipse的控制台输出如下:
这时我们在Servlet端编程直接读取上传数据,并分别解析出相应的文件数据是一项非常麻烦的工作。为方便用户处理文件上传数据,Apache开源组织提供了一个用来处理表单文件上传的一个开源组件(commons-fileupload),该组件性能优异,并且其API使用极其简单,可以让开发人员轻松实现Web文件上传功能,因此在Web开发中实现文件上传功能,通常使用commons-fileupload组件实现。
使用commons-fileupload组件实现文件上传,需要导入该组件相应的支撑jar包:commons-fileupload和commons-io。commons-io不属于文件上传组件的开发jar文件,但commons-fileupload组件从1.1版本开始,它工作时需要commons-io包的支持。大家可从网上下载这两个jar包,如下:
- commons-fileupload.jar;
- commons-io-2.2.jar。
fileupload组件工作流程
fileupload组件工作流程如下图所示:
核心API—DiskFileItemFactory
DiskFileItemFactory是创建FileItem对象的工厂,这个工厂类常用方法有:
核心API—ServletFileUpload
ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象中。常用方法有:
文件上传案例
首先,我们要在项目中加入Apache的commons-fileupload文件上传组件的相关jar包。
然后,编写文件上传页面——upload.jsp,其内容如下:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>文件上传页面</title>
</head>
<body>
<form action="${pageContext.request.contextPath }/UploadServlet2" enctype="multipart/form-data" method="post">
上传用户:<input type="text" name="username" /><br/>
上传文件1:<input type="file" name="file1"><br/>
上传文件2:<input type="file" name="file2"><br/>
<input type="submit" value="上传" />
</form>
</body>
</html>
最后,我们要编写处理文件上传的Servlet。初次编写这样的Servlet,心里也会发慌,因为不知道怎么下手,但是我们可以按照下面的步骤将它撸出来。
- 创建DiskFileItemFactory对象,可能需要设置缓冲区大小和临时文件目录,也即创建解析工厂;
- 使用DiskFileItemFactory对象创建ServletFileUpload对象,可能需要设置上传文件的大小限制,也即创建解析器;
- 调用ServletFileUpload.parseRequest方法解析request对象,得到一个保存了所有上传内容的List对象;
- 对List集合进行迭代,每迭代一个FileItem对象,调用其isFormField方法判断是否是上传文件;
- 为普通表单字段,则调用getFieldName、getString方法得到字段名和字段值;
- 为上传文件,则调用getInputStream方法得到数据输入流,从而读取上传数据。
按照以上4个步骤来编写代码,我们的UploadServlet2就写好了。
package cn.liayun.web.servlet;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
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.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
//处理上传数据
@WebServlet("/UploadServlet2")
public class UploadServlet2 extends HttpServlet {
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
try {
//创建解析工厂
DiskFileItemFactory factory = new DiskFileItemFactory();//内存缓冲区的大小,默认值为10K
//创建解析器
ServletFileUpload upload = new ServletFileUpload(factory);
//调用解析器解析request,得到保存了所有上传数据的List集合
List<FileItem> list = upload.parseRequest(request);
//迭代List集合,拿到封装了每一个输入项数据的FileItem对象
for (FileItem item : list) {
//判断FileItem的类型,如果是普通字段,则直接获取数据,如果是上传文件,则调用流获取数据写到本地硬盘
if (item.isFormField()) {
//为普通输入项的数据
String inputName = item.getFieldName();
String inputValue = item.getString();
System.out.println(inputName + "=" + inputValue);
} else {
//代表当前处理的item里面封装的是上传文件
//IE6浏览器获取到的上传文件的名称是D:\a.txt;而IE7则是a.txt
String filename = item.getName().substring(item.getName().lastIndexOf("\") + 1);
InputStream in = item.getInputStream();
int len = 0;
byte[] buffer = new byte[1024];
FileOutputStream out = new FileOutputStream("D:\server_pic\" + filename);
while ((len = in.read(buffer)) > 0) {
out.write(buffer, 0, len);
}
out.close();
in.close();
}
}
} catch (Exception e) {
throw new RuntimeException(e);
}
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
}
若当前处理的FileItem对象封装的是上传文件:
- 若用IE6浏览器上传文件,则在Servlet端中的代码
item.getName()
获取的是诸如D:\a.txt
这样的文件名; - 若用IE7及以上版本的浏览器上传文件,则在Servlet端中的代码
item.getName()
获取的是诸如a.txt
这样的文件名。
至此,一个文件上传案例就写好了,但以上掌握的知识在实际开发中是不够看的,所以我们应该深入地学习下去。