FileUpload文件上传源码解析

FileUpload文件上传源码解析

 作者：Charles，转载时请指明作者出处

背景介绍：

 

FileUpload是apache Commons 用于文件上传的组件，实际上就是用来解析http请求，大家都知道，上传文件的时候，http的request请求的 content-type 是multipart/form-data，我们就可以用FileUpload 来解析http请求，struts,springMVC 等很多MVC框架都是基于FileUpload 来实现文件上传功能。

 

2月7日发布了 最新的1.3.1的版本。

源代码的svn地址：http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/

大家可以check下来最新的源码看下

使用方法

1．文件上传

首先，判断是否上传的为文件

 

 

 

然后获取文件的输入流

 

 

 

 

 

 

 

拿到流之后我们就可以保存文件

 

 

以上是其中一种使用方法，如果想将文件保存在本地，就可以用使用先生成FileItem,然后再去遍历items来实现写文件

 

 

 

2.上传监控

1，其中包括 org.apache.commons.fileupload.servlet.FileCleanerCleanup  如果上传文件用到了DisFileItem的话，可以用这个作为监听器来删除保存到磁盘的临时目录。同时在创建DiskFileItemFactory工厂的时候调用如下代码，

 

FileUpload有一个可以用来监听上传文件的过程，主要是用到了 ProgressListener这个类

 

 

原理解析

基本实现方式：

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

 

FileUpload 主要的核心的类有三个

FileItemFactory：用于创建FileItem，其具体实现是DiskFileItemFactory，可以控制文件保存在内存中还是保存到临时磁盘内，改变其默认临界值。默认是10KB.

 

ServletFileUpload   处理表单数据，将数据封装到 FileItem 对象中。

FileItem  用来封装http请求的元素以及数据。包含普通参数或者文件

 

具体流程图如下：

 

 

 

下面是对一些主要相关的源代码进行解读。

 

我们首先看下FileUploadBase的parseRequest方法

 

1.获取FileItemIterator

2.遍历FileItemIterator，通过FileItemFactory创建FileItem

3,组装FileItem，构造List<FileItem>

 

其中 iter.next() 会调用到 FileUploadBase.findNextItem()方法来封装FileItem

然后我们看下获取到item之后的操作

 

 

 

获取到item之后我们可以遍历这个items,然后分别调用 item的write方法，可以将文件写入某个目录下。

 

 

 

Write方法主要分两步走，如果在内存中，就直接获取，如果在临时文件中，则负责一个新文件到指定目录。

 

总结：

使用FileUpload组件时需要注意的问题

1，  中文乱码问题，可以通过 ServletUpLoader的setHeaderEncoding来制定

2，  设置上传文件的最大尺寸，通过ServletUpLoader 的setSizeMax方法来指定

3，  合理的设置缓冲区的临界值，否则会出现outOfmemory。