一、如何实现文件上传
要实现Web开发中的文件上传功能,通常需完成两步操作:一是在Web页面中添加上传输入项:二是在Servlet中读取上传文件的数据,并保存到本地硬盘中。接下来,本节将对这两步操作内容进行详细讲解。
由于大多数文件的.上传都是通过表单的形式提交给服务器的,因此,要想在程序中实现文件上传的功能,首先要创建一个用于提交上传文件的表单页面。在页面中,需要使用<inputtype= file">标签在Web页面中添加文件上传输入项。
标签的使用需要注意以下两点
必须要设置input输入项的name属性,否则浏览器将不会发送上传文件的数据。
必须将表单页面的method属性设置为post 方式,enctype 属性设置为“multipar/form-data"类型。
示例代码如下。
<%-- 指定表单数据的enctypel!属性以及提交方式–%>
需要注意的是,在使用FileUpload组件时,要导入commons-fileuploadjar和commons-io,jar 两个JAR包,这两个JAR包可以去Apache官网htp://ommo… apache.org/"下载(进入该网址页面后,在Apache Commons Proper 下方表格的Components列中找到FileUpload和10,单击进入后即可找到下载链接)。
FileUpload 组件是通过Servlet来实现文件上传功能的。其工作流程如下图所示。从图中可以看出,实现文件的上传会涉及到几个陌生类,这些类都是Apache组件上传文件的核心类。
二、文件上传的相关API
2.1 Fileltem 接口
Fileltem接口在Commons- FileUpload组件中被实现,其主要用于封装单个表单字段元素的数据,一个表单字段元素对应一个Filetem对象。Commons-FileUpload组件在处理文件上传的过程中,将每一个表单域(包括普通的文本表单域和文件域)封装在一个Fileltem 对象中。为了便于讲解,在此将Filete接口的实现类称为Filtem类Filetem类实现了Serialiable接口,因此,支持序列化操作。在Fileltem类中定义了许多获取表单字段元素的方法,具体如下。( 1) boolean isFormField()方法
isFormField()方法用于 判断Filetem类对象封装的数据是一个普通文本表单字段,还是一个文件表单字段,如果是普通文本表单字段,则返回true,否则返回false。
(1) String getName()方法
geltName()方法用于获得文件上传字段中的文件名。如果Fieltlem类对象对应的是普通文本表单字段,gelName()方法将返回 nll; 否则,只要刘览器将文件的字段信息传递给服务器,getName()方法就会返回一个字符串类型的结果,如: “C:ASunsetjpg”
需要注意的是,通过不同浏览器上传的文件,获取到的完整路径和名称都是不一一样的。例如,用户使用E浏览器上传文件,获取到的就是完整的路径"C:Sunsetipg";如果使用其他浏览器,比如火狐,获取到的仅仅是文件名,没有路径,如“sunsetig"。
(2)String getFieldName()方法
glFeldNamel0方法用于获得表单字段元素描述头的 name属性值,也是表单标签name属性的值。例如“name=file1" 中的“file1"。
(3)void write(File file)方法
wrtel0方法用于将Fllen对象中保存的主体内容保存到某个指定的文件中。如果Fllem对象中的主体内容是保存在某个临时文件中,那么该方法顺利完成后,临时文件有可能会被清除。另外,该方法也可将普通表单字段内容写入到一个文件中,但它主要用于将上传的文件内容保存到本地文件系统中。
(4) String getString()方法
getString(方法用于将Flle对象中保存的数据流内容以一个字符串返回,它有两个重载的定义形式。
(1)public String getString()
(2)public String getString(java.lang.String encoding)
在上面重载的两个方法中,前者使用默认的字符集编码将主体内容转换成字符串,后者使用参数指定的字符集编码将主体内容转换成字符串。需要注意的是,如果在读取普通表单字段元素内容时出现中文乱码现象,请调用第2个geting(方法,并为之传递正确的字符集编码名称。
(5) String getContentType()方法
getContentType()方法用于获得上传文件的类型,即表单字段元素描述头属性"Content-Type"的值,如"image/jpeg"。 如果Fietem类对象对应的是普通表单字段,该方法将返回null.
(6) boolean isInMemory()方法
isInMemory()方法用来判断Fileltem对象封装的数据内容是存储在内存中,还是存储在临时文件中,如果存储在内存中则返回true,否则返回false。
(7) void delete()方法
delete()方法用来清空Filtem类对象中存放的主体内容,如果主体内容被保存在临时文件中,delete()方法将删除该临时文件。需要注意的是,尽管Fileltem 对象被垃圾收集器收集时会
自动清除临时文件,但应该及时调用dele()方法清除临时文件,从而释放系统存储资源,以防
系统出现异常,导致临时文件被永久地保存在硬盘中。
(8) InputStream getlnputStream()方法
getlnputStream()方 法以流的形式返回上传文件的数据内容。
(9) long getSize()方法
gelSize()方法返回该 上传文件的大小(以字节为单位)o
2.2 DiskFileltemFactory 类
DiskleltenFactory 类用于将请求消息实体中的每一个文件封装成单独的Filele对象。如果上传的文件比较小,将直接保存在内存中,如果上传的文件比较大,则会以临时文件的形式,保存在磁盘的临时文件夹中。默认情况下,文件保存在内存还是硬盘临时文件夹的临界值是10240, 即10KB。DiskFileItemFactory类中包含两个构造方法。接下来,针对DielemFactary类的常用方法进行洋细讲解,具体如下所示。
(1Filtem ceteltem(Sring fieldName, String contentType,boolean isFormField, StringfileName)方法
该方法用于将请求消息实体创建成Filtem类型的实例对象。需要注意的是,该方法是FileUpload 组件在解析请求时内部自动调用,无需我们管理。
(2) setSizeThreshold(int sizeThreshold)和getSizeThreshold()方法
seiSizThreshold()方 法用于设置是否将上传文件以临时文件的形式保存在磁盘的临界值。当Apache文件上传组件解析上传的数据时,需要将解析后的数据临时保存,以便后续对数据进一步处理。由于Java虚拟机可使用的内存空间是有限的,因此,需要根据上传文件的大小决定文件的保存位置。例如,一个800MB的文件是无法在内存中临时保存的,这时,Apache文件上传组件可以采用临时文件的方式来保存这些数据。但是,如果上传的文件很小,只有600KB,显然将其保存在内存中是比较好的选择。另外,对应的getSizeThreshold()方 法用来获取此临界值。
(3 ) setRepository(File repository)和getRepository()方法
如果上传文件的大小大于setSizeThreshold()方 法设置的临界值,这时,可以采用setRepository()方法,将上传的文件以临时文件的形式保存在指定的目录下。在默认情况下,采用的是系统默认的临时文件路径,可以通过以下方式获取。
System. getProperty(“java. io. tmpdir”)
另外,对应的getRepository()方法用于获取临时文件。
2.3 ServletFileUpload 类
SerlelFileUpload类是Apache 组件处理文件上传的核心高级类,通过使用pseaustSertetReqes)方法可以将HTIML 中每个表单提交的数据封装成一个Filelem 对象,然后以List 列表的形式返回。Sr/lFieUplaldo类中包含两个构造方法。
SrlelFleUpload 类的常用方法如下所示。
(1)selSizeMaxlong sizeMax)和geizeMax()方法
selSzeMax方法继承自 FlUplaBase类,用于设置请求消息实体内容的最大尺寸限制,以防止客户端恶意上传超大文件来浪费服务端的储存空间,其中参数sizeMax是以字节为单位。另外,对应的getsizeMax方法用于读取请求消息实体内容所允许的最大值。
(2) seleSzeaxlongg flSieMax)和geFieieMax(方法
setFileSizeMax()方法继承 自FileUploadBase类,用于设置单个上传文件的最大尺寸限制,以防止客户端恶意上传超大文件来浪费服务器端的存储空间。其中,参数flieMlx是以字节为单位。另外,对应的getFileSizeMax(方法用于获取单个上传文件所允许的最大值。
(3) parseRequestjavax. selett. HtSereRequet req)
parseRequest)方法是SerletFileUpload 类的重要方法,它是对HTTP请求消息体内容进行解析的入口。它解析出Form表单中的每个字段的数据,并将它们分别包装成独立的Filetem对象,然后将这些Filtem对象加入进一一个 List 类型的集合对象中返回。
( 4) getltemlterator(HtpServletRequest request)
getltemlterator()方法和parseRequest()方法的作用基本相同,但gettemlterator()方法返回
ert 的是一个迭代器,该迭代器中保存的不是Fileltem对象,而是FiltemStream对象,如果读者希望进一步提高性能,可以采用gettemlterator()方法, 直接获得每一个文件项的数据输入流,什底层处理;如果性能不是问题,希望代码简单,则采用parseRequest()方法即可。
( 5 ) isMultipartContentHtpServletRequest req)
isMultipartContent()方法用于判断请求消息中的内容是否是“multipart/form-data" 类型,如果是,则返回true,否则返回false。需要注意的是, isMultipartContent()方法是一个静态方法 ,不用创建ServletFileUpload类的实例对象即可被调用。
( 6) getFileltemFactory()和setFileltemFactory(FileltemFactory factory)
这两个方法继承自FileUpload类,分别用于读取和设置flteFactory属性。
(7 ) setHeaderEncoding(String encoding)方法和getHeaderEncoding()方法
这两个方法继承自FileUploadBase类,用于设置和读取字符编码。需要注意的是,如果没有使用seHeaderEncoding(设置字符编码,则geHeaderEnoding()方法返回nul上传组件1会采用HtSerlelReqes设置的字符编码。但是,如果HtSrletReque的字符编码也为null,这时,上传组件将采用系统默认的字符编码。获取系统默认字符编码的方式如下所示。System.getProperty(" file .encoding"));