Java Web之第12章文件上传和下载

12.1 如何实现文件上传

要实现Web开发中的文件上传功能，通常需完成两步操作：一是在Web页面中添加上传输项；二是在Servlet中读取上传文件数据，并且保存到本地硬盘中

由于大多数文件的上传都是通过表单的形式提交给服务器的，因此，要想在程序中实现文件上传的功能，首先要创建一个用于提交上传文件的表单页面。在页面中，需要使用<input type="file">标签在页面中添加文件上传输入项

<input type="file">标签使用需要注意：

1.必须设置input输入项的name属性，否则浏览器将不会发送上传文件的数据

2.必须将表单页面的method属性设置为post方式，enctype属性设置为“multipart/form-data”类型

示例代码如下:

<%--指定表单数据的enctype属性以及提交方式--%>
<form enctype="multipart/form-data" method="post">
	<%--指定标记的类型和文件域的名称--%>
	选择上传文件：<input type="file" name="myfile"/><br />
</form>

当浏览器通过表单提交上传文件时，由于文件数据都附带在HTTP请求消息体中，并且采用MIME类型（多用途互联网邮件扩展类型）进行描述，在后台使用request对象提供的getlnputStream()方法可以读取到客户端提交过来的数据。但由于用户可能会同时上传多个文件，而在Servlet端直接读取上传数据，并分解析出相应的文件数据是一项非常麻烦的工作

为了方便处理用户上传数据，Apache组织提供一个开源组件Commons-FileUpload。该组件可以方便地将“multipart/form-data”类型请求中的各种表单域解析出来，并实现一个或多个文件的上传，同时也可以限制上传文件的大小等内容。其性能十分优异，使用及其简单

12.2 文件上传的相关API

12.2.1 Fileltem接口

Fileltem接口：在Commons-FileUpload组件中被实现，其主要作用于封装单个表单字段元素的数据，一个表单字段元素对应一个Fileltem对象。Commons-FileUpload组件在处理文件上传的过程中，将每一个表单域（包括普通的文本表单域和文件域）封装在一个Fileltem对象中

Fileltem接口的实现类称为Fileltem类，Fileltem类实现了Serializable接口，所以支持序列化操作。在Fileltem类中定义 了许多获取表单字段元素的方法，具体如下：

（1）boolean isFormField()方法：用于判断Fileltem类对象封装的数据是一个普通文本表单字段，还是一个文件表单字段，如果是普通文本表单字段，则返回true，否则返回false

（2）String getName()方法：用于获得文件上传字段中的文件名。如果Fileltem类对象对应的是普通文本表单字段，getName()方法将返回null；否则，只要浏览器将文件的字段信息传递给服务器，getName()方法就会返回一个字符串类型的结果，如：“c：\SUNset.jsp"

注意：通过不同浏览器上传的文件，获取到的完整路径和名称都是不一样的

（3）String getFieldName()方法：用于获得表单字段元素描述头的name属性值，也是表单标签name属性的值

（4）void write(File file)方法：用于将Fileltem对象中保存的主体内容保存到指定的文件中。如果Fileltem对象中的主题内容是保存在某个临时文件中，那么该办法顺利完成后，临时文件有可能会被清除。另外外，该方法也可将普通表单字段内容写入到一个文件中，但它主要用于将上传的文件内容保存到本地文件系统中

（5）Sting getString()方法：用于将Fileltem对象中保存的数据流内容以一个字符串返回，它由两个重载的定义形式：

1.public String getString()

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

在上述重载的两个方法中，前者使用默认的字符集编码将主体内容转成字符串，后者使用参数指定的字符集编码将主体内容转换成字符串。注意：如果在读取普通表单字段元素内容时出现中文乱码现象，请调用第2个getString()方法，并为之传递正确的字符集编码名称

（6）Sting getContentType()方法：用于获得上传文件的类型，即表单字段元素描述头属性"Content-Type"的值，如”image/jpeg“。如果Fileltem类对象对应的是普通表单字段，该方法将返回null

（7）bloean islnMemory()方法：用于判断Fileltem类对象封装的数据内容是存储在内存中，还是存储在临时文件中，如果存储在内存中则返回true，否则返回false

（8）void delete()方法：用来清空Fileltem类对象中存放的主体内容，如果主体内容被保存在临时文件中，delete()方法将删除该临时文件

注意：尽管Fileltem对象被垃圾收集器收集时会自动清除临时文件，但应该及时调用delete()方法清除临时文件，从而释放系统存储资源，以防系统出现异常，导致临时文件被永久地保存在硬盘中

（9）InputStream getlnputStream()方法：以流的形式返回上传文件的数据内容

（10）long getSize()方法：返回该上传文件的大小（以字节为单位）

12.2.2 DiskFileLtemFactory类

DiskFileLtemFactory类用于将请求消息实体中的每一个文件封装成单独的Fileltem对象。如果上传文件比较小，将直接保存在内存中，如果上传的文件比较大，则会以临时文件的形式，保存在磁盘的临时文件中。默认情况下，文件保存在内存还是硬盘临时文件夹的临界值是10240，即10KB。DiskFileLtemFactory类中包含两个构造方法，如下：

方法名称	功能描述
DiskFileLtemFactory()	采用默认临界值和系统临时文件夹构造文件项工厂对象
DiskFileLtemFactory(int sizeThreshold,File repository)	采用参数指定临界值和系统临时文件夹构造文件项工厂对象

第二个构造方法需要传递两个参数，参数sizeThreshold代表文件保存在内存还是磁盘临时文件夹的临界值，参数repository表示临时文件的存储路径

DiskFileLtemFactory类常用的方法如下：

（1）Fileltem createltem(String fiedName,String contentType,boolean isFormField,String fileName)方法：用于请求消息实体创建成Fileltem类型的实例对象。注意：该方法是FileUpload组件在解析请求时内部自动调用，无需我们管理

（2）setSizeThreshold()方法：用于设置是否将上传文件以临时文件的形式保存在磁盘的临界值。由于Java虚拟机可使用的内存空间是有限的，因此，需要根据上传文件的大小决定文件的保存位置

（3）getSizeThreshold()方法：用于获取阀值

（4）setRepository(File repository)方法：用于将上传的文件以临时文件的形式保存在指定的目录下。默认情况下，采用的是系统默认的临时文件路径，可以通过以下方式获取：

System.getProperty("java.io.tmpdir")

（5）getRepository()方法：用于获取临时文件

12.2.3 ServletFileUpload类

ServletFileUpload类：是Apache组件处理文件上传的核心高级类，通过使用parseRequest(HttpServletRequest)方法将HTML中每个表单提交的数据封装成一个Fileltem对象，然后以List列表的形式返回。ServletFileUpload类中包含两个构造方法如下：

方法名称	功能描述
ServletFileUpload()	构造一个未初始化的ServletFileUpload实例对象
ServletFileUpload(FileltemFactory fileltemFactory)	根据参数指定FileltemFactory对象创建一个ServletFileYpload对象

由于在文件上传的过程中，FileltemFactory类必须设置，因此，在使用第一个构造方法创建ServletFileUpload对象时，首先需要在解析请求之前调用setFileltemFactory ()方法设置FileltemFactory属性

ServletFileUpload类的常用方法如下：

（1）setSizeMax(long sizeMax)和getSizeMax()方法：setSizeMax()方法继承自FileUploadBase类，用于设置请求消息实体内容(即所有上传的数据)的最大尺寸限制，以防止客户端恶意上传超大文件来浪费服务器的存储空间。其中，参数sizeMax是以字节为单位。另外，getSizeMax()方法用于读取消息实体内容所允许的最大值

（2）setFileSizeMax(long sizeFileMax)和getFileSizeMax()方法：setFileSizeMax()方法继承自FileUploadBase类，用于设置单个上传文件的最大尺寸限制，以防止客户端恶意上传超大文件来浪费服务器的存储空间。其中，参数fileSizeMax是以字节为单位。另外，对应getFileSizeMax()方法用于获取单个上传文件所允许的最大值

（3）parseRequest(javax.servlet.http.HttpServletRequest req)方法：是ServletFileUpload类的重要方法，它是对HTTP请求消息体内容进行解析的入口。它解析出Form表单中的每个字段的数据，并将它们分别包装成独立的Fileltem对象，然后将这些Fileltem对象加入一个进一个List类型的集合对象中返回

（4）getltemlteratou(HttpServletRequest request)方法：getltemlteratou()方法和
parseRequest()方法返回一个迭代器，该迭代器中保存的不是Fileltem对象，而是FileltemStream对象，如果读者希望进一步提高性能，可以采取getltemlteratou()方法，直接获的每一个文件项的数据输入流，作底层；如果性能不是问题，希望代码简单，则采用parseRequest()方法即可

（5）isMultipartContent(HttpServlet req)方法：用于判断请求信息的内容是否"multiprt/form-data"类型，如果是，则返回true，否则返回false。注意：isMultipartContent()方法是一个静态方法，不用创建ServletFileUpload类的实例对象即可被调用

（6）getFileltemFactory()和setFileltemFactory(FileltemFactory factory)：两个方法继承FileUpload类，分别用于读取和设置FileltemFactory属性

（7）setHeaderEncoding(String encoding)方法和getHeaderEncoding()方法：这两个方法都继承于FileUploadBase类，用于设置和读取字符编码。

注意：如果没有使用setHeaderEncoding()设置字符编码，则getHeaderEncoding()方法返回null，上传组件回采用HttpServletRequest设置的字符编码。但是，如果HttpServletRequest的字符编码也为null，这时，上传组件将采用系统默认的字符编码。获取系统默认字符编码的方式如下：

System.getProperty("file.encoding")