JavaWeb之文件上传

 

基于表单的文件上传

 

如果在表单中使用表单元素 <input type=“file” />，浏览器在解析表单时，会自动生成一个输入框和一个按钮，输入框可供用户填写本地文件的文件名和路径名，按钮可以让浏览器打开一个文件选择框供用户选择文件：

 

 

 

Enctype 属性

 

当表单需要上传文件时，需指定表单 enctype 的值为 multipart/form-data

在 form 元素的语法中，enctype 属性指定将数据发送到服务器时浏览器使用的编码类型。  

enctype 属性取值: 

application/x-www-form-urlencoded：表单 enctype 属性的默认值。这种编码方案使用有限的字符集，当使用了非字母和数字时，必须用”%HH”代替(H 代表十六进制数字)。对于大容量的二进制数据或包含非 ASCII 字符的文本来说，这种编码不能满足要求。

multipart/form-data：form 设定了enctype=“multipart/form-data”属性后，表示表单以二进制传输数据 

 

 

Commons-fileupload 组件

 

Commons-fileupload 组件是 Apache 开源代码组织用来处理表单文件上传的一个子项目，该组件性能优异，可以支持任意大小的文件的上传

Commons-fileupload 组件从 1.1 版本开始依赖 Apache 的另一个项目：commons-io

 

 

Commons-fileupload 组件上传的基本原理 

 

FileUpload组件将页面提交的所有元素(普通form表单域，如text和文件域file)都看作一样的FileItem，这样上传页面提交的 request请求也就是一个FileItem的有序组合，FileUpload组件可以解析该request，并返回一个一个的FileItem。而对每一个FileItem，FileUpload组件可以判断出它是普通form表单域还是文件file域，从而根据不同的类型，采取不同的操作－－如果是表单域，就读出其值，如果是文件域，就保存文件到服务器硬盘上或者内存中。 

 

 

Commons-fileupload 组件API

 

在 Commons-fileupload 组件中，主要用到以下三个接口和类：

 

 

org.apache.commons.fileupload.FileItem;

org.apache.commons.fileupload.disk.DiskFileItemFactory;

org.apache.commons.fileupload.servlet.ServletFileUpload;

 

ServletFileUpload 负责处理上传的文件数据，并将每部分的数据封装成一到 FileItem 对象中。

DiskFileItemFactory 是创建 FileItem 对象的工厂，在这个工厂类中可以配置内存缓冲区大小和存放临时文件的目录。

ServletFileUpload 在接收上传文件数据时，会将内容保存到内存缓存区中，如果文件内容超过了 DiskFileItemFactory 指定的缓冲区的大小，那么文件将被保存到磁盘上，存储为 DiskFileItemFactory 指定目录中的临时文件。等文件数据都接收完毕后，ServletUpload 在从文件中将数据写入到上传文件目录下的文件中

 

示例代码

 

package org.rabbitx.web.javaweb.upload;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
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.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

public class UploadServlet extends HttpServlet {

	private static final long serialVersionUID = -2514770270647850944L;

	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
		
		DiskFileItemFactory factory = new DiskFileItemFactory();
		factory.setSizeThreshold(1024 * 500);
		File tmpFile = new File("D:\\tmp");
		
		factory.setRepository(tmpFile);
		
		ServletFileUpload upload = new ServletFileUpload(factory);
		upload.setSizeMax(1024 * 1024 * 5);
		
		try {
			@SuppressWarnings("unchecked")
			List<FileItem> fileItems = upload.parseRequest(req);
			
			for(FileItem fileItem : fileItems)
			{
				if(fileItem.isFormField())
				{
					System.out.println(fileItem.getFieldName() + " <-> " + fileItem.getString());
				}else
				{
					String fieldName = fileItem.getFieldName();
					String fileName = fileItem.getName();
					String contentType = fileItem.getContentType();
					long sizeInBytes = fileItem.getSize();

					System.out.println("fieldName: " + fieldName);
					System.out.println("fileName: " + fileName);
					System.out.println("contentType: " + contentType);
					System.out.println("sizeInBytes: " + sizeInBytes);
					
					InputStream in = fileItem.getInputStream();
					byte[] buffer = new byte[1024];
					int len = 0;

					fileName = "D:\\upload\\" + fileName;
					System.out.println(fileName);

					OutputStream out = new FileOutputStream(fileName);

					while ((len = in.read(buffer)) != -1) {
						out.write(buffer, 0, len);
					}

					out.close();
					in.close();
				}
			}
			
		} catch (FileUploadException e) {
			e.printStackTrace();
		}
		
	}
}

 

 

小结

 

1. 进行文件上传时, 表单需要做的准备:

 

1). 请求方式为 POST: <form action="uploadServlet" method="post" ... >

2). 使用 file 的表单域: <input type="file" name="file"/>

3). 使用 multipart/form-data 的请求编码方式: <form action="uploadServlet" method="post" enctype="multipart/form-data">

 

<form action="uploadServlet" method="post" enctype="multipart/form-data">

 

File: <input type="file" name="file"/>

<input type="submit" value="Submit"/>

 

</form>

 

4). 关于 enctype:

 

> application/x-www-form-urlencoded：表单 enctype 属性的默认值。这种编码方案使用有限的字符集，当使用了非字母和数字时，

必须用”%HH”代替(H 代表十六进制数字)。对于大容量的二进制数据或包含非 ASCII 字符的文本来说，这种编码不能满足要求。

 

> multipart/form-data：form 设定了enctype=“multipart/form-data”属性后，表示表单以二进制传输数据 

 

2. 服务端:

 

1). 不能再使用 request.getParameter() 等方式获取请求信息. 获取不到, 因为请求的编码方式已经改为 multipart/form-data, 以

二进制的方式来提交请求信息. 

 

2). 可以使用输入流的方式来获取. 但不建议这样做.

 

3). 具体使用 commons-fileupload 组件来完成文件的上传操作. 

 

I. 搭建环境: 加入 

commons-fileupload-1.2.1.jar

commons-io-2.0.jar(是fileupload.jar的依赖包)

 

II. 基本思想: 

 

> commons-fileupload 可以解析请求, 得到一个 FileItem 对象组成的 List

> commons-fileupload 把所有的请求信息都解析为 FileItem 对象, 无论是一个一般的文本域还是一个文件域. 

> 可以调用 FileItem 的 isFormField() 方法来判断是一个 表单域 或不是表单域(则是一个文件域)

> 再来进一步获取信息

 

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();

   

   InputStream uploadedStream = item.getInputStream();

   ...

   uploadedStream.close();

}

 

III. 如何得到 List<FileItem> 对象. 

 

> 简单的方式

 

// Create a factory for disk-based file items

FileItemFactory factory = new DiskFileItemFactory();

 

// Create a new file upload handler

ServletFileUpload upload = new ServletFileUpload(factory);

 

// Parse the request

List /* FileItem */ items = upload.parseRequest(request);

 

> 复杂的方式: 可以为文件的上传加入一些限制条件和其他的属性

 

// Create a factory for disk-based file items

DiskFileItemFactory factory = new DiskFileItemFactory();

 

//设置内存中最多可以存放的上传文件的大小, 若超出则把文件写到一个临时文件夹中. 以 byte 为单位

factory.setSizeThreshold(yourMaxMemorySize);

//设置那个临时文件夹

factory.setRepository(yourTempDirectory);

 

// Create a new file upload handler

ServletFileUpload upload = new ServletFileUpload(factory);

 

//设置上传文件的总的大小. 也可以设置单个文件的大小. 

upload.setSizeMax(yourMaxRequestSize);

 

// Parse the request

List /* FileItem */ items = upload.parseRequest(request);

 

-----------------------------------------------

 

问题1: 如果是一个多选, 若何获取对应的字符串数组. 每一个都对应一个 FileItem 对象. 

 

<input type="checkbox" name="interesting" value="Reading"/>Reading

<input type="checkbox" name="interesting" value="Party"/>Party

<input type="checkbox" name="interesting" value="Sports"/>Sports

<input type="checkbox" name="interesting" value="Shopping"/>Shopping

 

问题2. 临时文件夹如何清空的问题: 手工删除的方式.