Apache的FileUpload类
一、类的简介
Web资源:
CommonsIO类库:http://commons.apache.org/io/,FileUpload需要用于该类库,所以你确保该类库在您的classpath中,否则会出现异常。
在得到上传文件之前,首先要判断客户端<form>标记的enctype属性是否是“multipart/form-data",可使用org.apache.commons.fileupload.servlet.ServletFileUpload类中的isMultipartContent()方法进行进行判断,该方法定义如下:
static boolean isMultipartContent(javax.servlet.http.HttpServletRequest request) static boolean isMultipartContent(javax.servlet.http.HttpServletRequest request)
示例:
import org.apache.commons.fileupload.servlet.ServletFileUpload; //.................... if(ServletFileUpload.isMultipartContent(request)){ //该提示符合文件上传规则,在此处对文件上传数据进行处理。 }else{ //该表单不符合文件上传规则,另作处理。 } //.................... import org.apache.commons.fileupload.servlet.ServletFileUpload; //.................... if(ServletFileUpload.isMultipartContent(request)){ //该提示符合文件上传规则,在此处对文件上传数据进行处理。 }else{ //该表单不符合文件上传规则,另作处理。 } //....................
DiskFileItemFactory类,实现了FileItemFactory,根据名字翻译就是”文件项工厂”,实际作用是定义文件传过程中文件占用的内存,及超过占用内存时临时文件的存储地点,主要方法如下:
void setSizeThreshold(int sizeThreshold) //以byte为单位设定文件使用多少内存量后,将文件存入临时存储。 void setRepository(java.io.File repository) //设定临时文件的存储路径 void setSizeThreshold(int sizeThreshold) //以byte为单位设定文件使用多少内存量后,将文件存入临时存储。 void setRepository(java.io.File repository) //设定临时文件的存储路径
ServletFileUpload类,处理同一HTML文件中多文件上传的类,继承自FileUpload,主要方法如下:
static boolean isMultipartContent(javax.servlet.http.HttpServletRequest request) //判断客户端请求是否为POST,并且enctype属性是否是“multipart/form-data" public java.util.List parseRequest(javax.servlet.http.HttpServletRequest request) throws FileUploadException //读入“multipart/form-data"数据流,并得到表单项列表。 void setSizeMax(long sizeMax) //设置允许上传文件的最大大小 static boolean isMultipartContent(javax.servlet.http.HttpServletRequest request) //判断客户端请求是否为POST,并且enctype属性是否是“multipart/form-data" public java.util.List parseRequest(javax.servlet.http.HttpServletRequest request) throws FileUploadException //读入“multipart/form-data"数据流 ,并得到表单项列表。 void setSizeMax(long sizeMax) //设置允许上传文件的最大大小
FileItem类,是一个接口,根据名字翻译就是文件项,代表所提交表单中的一个控件,ServletFileUpload中的parseRequest()文件返回整个表单的所有FileItem项的列表。
boolean isFormField() //判断该表单项是否是文件项,还是普通表单项。 String getFieldName() //如果不是文件项,返回对应表单项的表单名称。 String getString() //如果不是文件项,以默认编码返回该项的内容。 String getString(String encoding) //以指定编码返回该项内容。 long getSize() //以byte为单位返回该项大小 String getName() //如果是文件项,该方法返回文件名,文件名取决于客户端浏览器 void write(java.io.File file) //如果是文件项,将该文件写入对应的文件中 java.io.InputStream getInputStream() java.io.OutputStream getOutputStream() boolean isFormField() //判断该表单项是否是文件项,还是普通表单项。 String getFieldName() //如果不是文件项,返回对应表单项的表单名称。 String getString() //如果不是文件项,以默认编码返回该项的内容。 String getString(String encoding) //以指定编码返回该项内容。 long getSize() //以byte为单位返回该项大小 String getName() //如果是文件项,该方法返回文件名,文件名取决于客户端浏览器 void write(java.io.File file) //如果是文件项,将该文件写入对应的文件中 java.io.InputStream getInputStream() java.io.OutputStream getOutputStream()
一个简单的示例,运行文件并保存到D盘某个目录下:
//文件上传示例程序 //判断表单是否是 enctype="multipart/form-data" if(ServletFileUpload.isMultipartContent(request)){ DiskFileItemFactory dfif = new DiskFileItemFactory(); dfif.setSizeThreshold(5 * 1024 * 1024); //设定使用内存超过5M时,将产生临时文件并存储于临时目录中。 dfif.setRepository(new File("c:\\temp")); //设定存储临时文件的目录。 ServletFileUpload fileupload = new ServletFileUpload(dfif); fileupload.setSizeMax(50 * 1024 * 1024); //设定最大允许上传50M的文件。 List<FileItem> files = fileupload.parseRequest(request); for(FileItem f:files){ if(f.isFormField()){ //如果该项是表单项,不是文件上传项 out.print(f.getFieldName()); out.print(f.getString("UTF-8")); //因为Web使用是的UTF-8编码,所以客户端返回的也是UTF-8的编码。 }else{ String filename = f.getName(); filename = filename.substring(filename.lastIndexOf(".")); f.write(new File("d:\\upfile\\" + (int)(Math.random()*10000000) + filename)); //别学我,偷懒行为 } } }else{ out.print("你所提交的表单有错误!"); } //文件上传示例程序 //判断表单是否是 enctype="multipart/form-data" if(ServletFileUpload.isMultipartContent(request)){ DiskFileItemFactory dfif = new DiskFileItemFactory(); dfif.setSizeThreshold(5 * 1024 * 1024); //设定使用内存超过5M时,将产生临时文件并存储于临时目录中。 dfif.setRepository(new File("c:\\temp")); //设定存储临时文件的目录。 ServletFileUpload fileupload = new ServletFileUpload(dfif); fileupload.setSizeMax(50 * 1024 * 1024); //设定最大允许上传50M的文件。 List<FileItem> files = fileupload.parseRequest(request); for(FileItem f:files){ if(f.isFormField()){ //如果该项是表单项,不是文件上传项 out.print(f.getFieldName()); out.print(f.getString("UTF-8")); //因为Web使用是的UTF-8编码,所以客户端返回的也是UTF-8的编码。 }else{ String filename = f.getName(); filename = filename.substring(filename.lastIndexOf(".")); f.write(new File("d:\\upfile\\" + (int)(Math.random()*10000000) + filename)); //别学我,偷懒行为 } } }else{ out.print("你所提交的表单有错误!"); }如果了处理文件的输入流,可能参考手册的FileItemIterator类。
二、实例
1.示例1。
DiskFileUpload类会对mulipart类的表单中的所有字段进行处理,不只是file字段。getName()得到文件名,getString()得到表单数据内容,isFormField()可判断是否为普通的表单项。
demo1.html
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=GB18030"> <title>File upload</title> </head> <body> //必须是multipart的表单数据。 <form action="demo1.jsp" method="post" enctype="multipart/form-data"> br> <input type="text" size="15"><br> br> <input type="file" ><br><br> <input type="submit" value="Commit"> </form> </body> </html>demo1.jsp
<%@ page language="java" contentType="text/html; charset=GB18030" pageEncoding="GB18030"%> <%@ page import="org.apache.commons.fileupload.*"%> <%@ page import="java.util.*"%> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <% boolean isMultipart=FileUpload.isMultipartContent(request);//检查输入请求是否为multipart表单数据。 if(isMultipart==true){ DiskFileUpload upload=new DiskFileUpload();//为该请求创建一个DiskFileUpload对象,通过它来解析请求。执行解析后,所有的表单项目都保存在一个List中。 List items=upload.parseRequest(request); Iterator itr=items.iterator(); while(itr.hasNext()){ FileItem item=(FileItem)itr.next(); //检查当前项目是普通表单项目还是上传文件。 if(item.isFormField()){//如果是普通表单项目,显示表单内容。 String fieldName=item.getFieldName(); if(fieldName.equals("name")) //对应demo1.html中type="text" out.println("the field name is"+ item.getString());//显示表单内容。 out.println("<br>"); } else{//如果是上传文件,显示文件名。 out.println("the upload fielname is"+item.getName()); out.println("<br>"); } } } else{ out.println("the enctype must be multipart/form-data"); } %> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=GB18030"> <title>File upload</title> </head> <body> </body> </html>
2.示例2。
上传两个文件到指定的目录。
demo2.html
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=GB18030"> <title>File upload</title> </head> <body> <form action="demo2.jsp" method="post" enctype="multipart/form-data"> br> <input type="file" ><br> br> <input type="file" ><br><br> <input type="submit" value="Commit"> </form> </body> </html>demo2.jsp
<%@ page language="java" contentType="text/html; charset=GB18030" pageEncoding="GB18030"%> <%@ page import="org.apache.commons.fileupload.*"%> <%@ page import="java.util.*"%> <%@ page import="java.io.*"%> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <%String uploadPath="D:\\Dvp\\workspace4Lomboz\\Test4Jsp\\uploadfiles"; boolean isMultipart=FileUpload.isMultipartContent(request); if(isMultipart==true){ try{ DiskFileUpload upload=new DiskFileUpload(); List items=upload.parseRequest(request);//得到所有的文件 Iterator itr=items.iterator(); while(itr.hasNext()){//依次处理每个文件 FileItem item=(FileItem)itr.next(); String fileName=item.getName();//获得文件名,包括路径 if(fileName!=null){ File fullFile=new File(item.getName()); File savedFile=new File(uploadPath,fullFile.getName()); item.write(savedFile); } } out.println("upload succeed"); } catch(Exception e){ e.printStackTrace(); } } else{ out.println("the enctype must be multipart/form-data"); } %> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=GB18030"> <title>File upload</title> </head> <body> </body> </html>3.示例3。
上传一个文件到指定的目录,并限定文件大小。
demo3.html
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=GB18030"> <title>File upload</title> </head> <body> <form action="demo3.jsp" method="post" enctype="multipart/form-data"> br> <input type="file" ><br><br> <input type="submit" value="Commit"> </form> </body> </html>demo3.jsp
<%@ page language="java" contentType="text/html; charset=GB18030" pageEncoding="GB18030"%> <%@ page import="org.apache.commons.fileupload.*"%> <%@ page import="java.util.*"%> <%@ page import="java.io.*"%> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <%File uploadPath=new File("D:\\upload");//上传文件目录 if(!uploadPath.exists()){ uploadPath.mkdirs(); } String tempPath="d:\\upload\\temp\\"; // 临时文件目录 File tempPathFile=new File("d:\\upload\\temp"); if(!tempPathFile.exists()){ tempPathFile.mkdirs(); } try{ DiskFileUpload fu=new DiskFileUpload(); fu.setSizeMax(4194304); // 设置最大文件尺寸,这里是4MB fu.setSizeThreshold(4096); // 设置缓冲区大小,这里是4kb fu.setRepositoryPath(tempPath);//设置缓冲区目录 List fileItems=fu.parseRequest(request); Iterator i=fileItems.iterator(); while(i.hasNext()){ FileItem fi=(FileItem)i.next(); String fileName=fi.getName(); if(fileName!=null){ File fullFile=new File(fi.getName()); File savedFile=new File(uploadPath,fullFile.getName()); fi.write(savedFile); } } out.println("upload succeed"); } catch(Exception e){ e.printStackTrace(); } %> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=GB18030"> <title>File upload</title> </head> <body> </body> </html>4.示例4。
利用Servlet来实现文件上传。
Upload.java
package com.zj.sample; import java.io.*; import java.util.*; import javax.servlet.*; import javax.servlet.http.*; import org.apache.commons.fileupload.*; public class Upload extends HttpServlet { private String uploadPath="D:\\upload\\"; // 上传文件的目录 private String tempPath= "d:\\upload\\temp\\"; // 临时文件目录 public void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { try { DiskFileUpload fu = new DiskFileUpload(); fu.setSizeMax(4194304); fu.setSizeThreshold(4096); fu.setRepositoryPath(tempPath); List fileItems = fu.parseRequest(request); Iterator i = fileItems.iterator(); while (i.hasNext()) { FileItem fi=(FileItem)i.next(); String fileName=fi.getName(); if(fileName!=null){ File fullFile=new File(fi.getName()); File savedFile=new File(uploadPath,fullFile.getName()); fi.write(savedFile); } } System.out.println("upload succeed"); } catch (Exception e) { // 可以跳转出错页面 e.printStackTrace(); } } public void init() throws ServletException { File uploadPath = new File("D:\\upload"); if (!uploadPath.exists()) { uploadPath.mkdirs(); } File tempPathFile = new File("d:\\upload\\temp"); if (!tempPathFile.exists()) { tempPathFile.mkdirs(); } } }demo4.html
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=GB18030"> <title>File upload</title> </head> <body> // action="fileupload"对应web.xml中<servlet-mapping>中<url-pattern>的设置。 <form action="fileupload" method="post" enctype="multipart/form-data"> br> <input type="file" ><br><br> <input type="submit" value="Commit"> </form> </body> </html>
web.xml
<servlet> <servlet-name>Upload</servlet-name> <servlet-class>com.zj.sample.Upload</servlet-class> </servlet> <servlet-mapping> <servlet-name>Upload</servlet-name> <url-pattern>/fileupload</url-pattern> </servlet-mapping>