DiskFileUpload类

1.2.2 DiskFileUpload类

DiskFileUpload类是Apache文件上传组件的核心类，应用程序开发者通过这个类来与Apache文件上传组件进行交互。以下介绍DiskFileUpload类中的几个经常使用的重要方法。

1．setSizeMax方法

setSizeMax方法用于设置请求消息实体内容的最大同意大小，以防止client有益通过上传特大的文件来塞满server端的存储空间，单位为字节。其完整语法定义例如以下：

    public void setSizeMax（long sizeMax）

假设请求消息中的实体内容的大小超过了setSizeMax方法的设置值，该方法将会抛出FileUploadException异常。

2．setSizeThreshold方法

Apache文件上传组件在解析和处理上传数据中的每一个字段内容时，须要暂时保存解析出的数据。由于Java虚拟机默认能够使用的内存空间是有限的（笔者測试不大于100M），超出限制时将会发生“java.lang.OutOfMemoryError”错误，假设上传的文件非常大，比如上传800M的文件，在内存中将无法保存该文件内容，Apache文件上传组件将用暂时文件来保存这些数据；但假设上传的文件非常小，比如上传600个字节的文件，显然将其直接保存在内存中更加有效。setSizeThreshold方法用于设置是否使用暂时文件保存解析出的数据的那个临界值，该方法传入的參数的单位是字节。其完整语法定义例如以下：

public void setSizeThreshold(int sizeThreshold)

3. setRepositoryPath方法

setRepositoryPath方法用于设置setSizeThreshold方法中提到的暂时文件的存放文件夹，这里要求使用绝对路径。其完整语法定义例如以下：

public void setRepositoryPath(String repositoryPath)

假设不设置存放路径，那么暂时文件将被储存在"java.io.tmpdir"这个JVM环境属性所指定的文件夹中，tomcat 5.5.9将这个属性设置为了“<tomcat安装文件夹>/temp/”文件夹。

4. parseRequest方法

parseRequest 方法是DiskFileUpload类的重要方法，它是对HTTP请求消息进行解析的入口方法，假设请求消息中的实体内容的类型不是“multipart/form-data”，该方法将抛出FileUploadException异常。parseRequest 方法解析出FORM表单中的每一个字段的数据，并将它们分别包装成独立的FileItem对象，然后将这些FileItem对象增加进一个List类型的集合对象中返回。parseRequest 方法的完整语法定义例如以下：

public List parseRequest(HttpServletRequest req)

parseRequest 方法另一个重载方法，该方法集中处理上述全部方法的功能，其完整语法定义例如以下：

parseRequest(HttpServletRequest req,int sizeThreshold,long sizeMax,

            String path)

这两个parseRequest方法都会抛出FileUploadException异常。

5. isMultipartContent方法

isMultipartContent方法方法用于推断请求消息中的内容是否是“multipart/form-data”类型，是则返回true，否则返回false。isMultipartContent方法是一个静态方法，不用创建DiskFileUpload类的实例对象就可以被调用，其完整语法定义例如以下：

public static final boolean isMultipartContent(HttpServletRequest req)

6. setHeaderEncoding方法

因为浏览器在提交FORM表单时，会将普通表单中填写的文本内容传递给server，对于文件上传字段，除了传递原始的文件内容外，还要传递其文件路径名等信息，如后面的图1.3所看到的。无论FORM表单採用的是“application/x-www-form-urlencoded”编码，还是“multipart/form-data”编码，它们不过将各个FORM表单字段元素内容组织到一起的一种格式，而这些内容又是由某种字符集编码来表示的。关于浏览器採用何种字符集来编码FORM表单字段中的内容，请參看笔者编著的《深入体验java Web开发内幕——核心基础》一书中的第6.9.2的解说，“multipart/form-data”类型的表单为表单字段内容选择字符集编码的原理和方式与“application/x-www-form-urlencoded”类型的表单是同样的。FORM表单中填写的文本内容和文件上传字段中的文件路径名在内存中就是它们的某种字符集编码的字节数组形式，Apache文件上传组件在读取这些内容时，必须知道它们所採用的字符集编码，才干将它们转换成正确的字符文本返回。

对于浏览器上传给WEBserver的各个表单字段的描写叙述头内容，Apache文件上传组件都须要将它们转换成字符串形式返回，setHeaderEncoding 方法用于设置转换时所使用的字符集编码，其原理与笔者编著的《深入体验java Web开发内幕——核心基础》一书中的第6.9.4节解说的ServletRequest.setCharacterEncoding方法同样。setHeaderEncoding 方法的完整语法定义例如以下：

public void setHeaderEncoding(String encoding)

当中，encoding參数用于指定将各个表单字段的描写叙述头内容转换成字符串时所使用的字符集编码。

注意：假设读者在使用Apache文件上传组件时遇到了中文字符的乱码问题，一般都是没有正确调用setHeaderEncoding方法的原因。

以下介绍FileItem类中的几个经常使用的方法：

1. isFormField方法

isFormField方法用于推断FileItem类对象封装的数据是否属于一个普通表单字段，还是属于一个文件表单字段，假设是普通表单字段则返回true，否则返回false。该方法的完整语法定义例如以下：

public boolean isFormField()

2. getName方法

getName方法用于获得文件上传字段中的文件名称，对于图1.3中的第三个分区所看到的的描写叙述头，getName方法返回的结果为字符串“C:/bg.gif”。假设FileItem类对象相应的是普通表单字段，getName方法将返回null。即使用户没有通过网页表单中的文件字段传递不论什么文件，但仅仅要设置了文件表单字段的name属性，浏览器也会将文件字段的信息传递给server，仅仅是文件名称和文件内容部分都为空，但这个表单字段仍然相应一个FileItem对象，此时，getName方法返回结果为空字符串""，读者在调用Apache文件上传组件时要注意考虑这个情况。getName方法的完整语法定义例如以下：

public String getName()

注意：假设用户使用Windows系统上传文件，浏览器将传递该文件的完整路径，假设用户使用Linux或者Unix系统上传文件，浏览器将仅仅传递该文件的名称部分。

3．getFieldName方法

getFieldName方法用于返回表单字段元素的name属性值，也就是返回图1.3中的各个描写叙述头部分中的name属性值，比如“name=p1”中的“p1”。getFieldName方法的完整语法定义例如以下：

public String getFieldName()

4. write方法

write方法用于将FileItem对象中保存的主体内容保存到某个指定的文件里。假设FileItem对象中的主体内容是保存在某个暂时文件里，该方法顺利完毕后，暂时文件有可能会被清除。该方法也可将普通表单字段内容写入到一个文件里，但它主要用途是将上传的文件内容保存在本地文件系统中。其完整语法定义例如以下：

public void write(File file)

5．getString方法

    getString方法用于将FileItem对象中保存的主体内容作为一个字符串返回，它有两个重载的定义形式：

public java.lang.String getString()

public java.lang.String getString(java.lang.String encoding)

    throws java.io.UnsupportedEncodingException

前者使用缺省的字符集编码将主体内容转换成字符串，后者使用參数指定的字符集编码将主体内容转换成字符串。假设在读取普通表单字段元素的内容时出现了中文乱码现象，请调用第二个getString方法，并为之传递正确的字符集编码名称。

6. getContentType方法

getContentType 方法用于获得上传文件的类型，对于图1.3中的第三个分区所看到的的描写叙述头，getContentType方法返回的结果为字符串“image/gif”，即“Content-Type”字段的值部分。假设FileItem类对象相应的是普通表单字段，该方法将返回null。getContentType 方法的完整语法定义例如以下：

public String getContentType()

7. isInMemory方法

isInMemory方法用来推断FileItem类对象封装的主体内容是存储在内存中，还是存储在暂时文件里，假设存储在内存中则返回true，否则返回false。其完整语法定义例如以下：

public boolean isInMemory()

8. delete方法

delete方法用来清空FileItem类对象中存放的主体内容，假设主体内容被保存在暂时文件里，delete方法将删除该暂时文件。虽然Apache组件使用了多种方式来尽量及时清理暂时文件，但系统出现异常时，仍有可能造成有的暂时文件被永久保存在了硬盘中。在有些情况下，能够调用这种方法来及时删除暂时文件。其完整语法定义例如以下：

public void delete()

1.2.4 FileUploadException类

在文件上传过程中，可能发生各种各样的异常，比如网络中断、数据丢失等等。为了对不同异常进行合适的处理，Apache文件上传组件还开发了四个异常类，当中FileUploadException是其它异常类的父类，其它几个类仅仅是被间接调用的底层类，对于Apache组件调用人员来说，仅仅需对FileUploadException异常类进行捕获和处理就可以。

http://blog.csdn.net/zerolwp/article/details/5859187