文件上传
文件上传的作用
在一般比较大的Java系统中,对文件上传和下载的流量比较大,一般都会单独开发一个文件处理系统,在整个项目中具有十分重要的作用。
页面的要求
上传文件的要求比较多,需要记一下:
1. 必须使用表单,而不能是超链接;
2. 表单的method必须是POST,而不能是GET;
3. 表单的enctype必须是multipart/form-data;
4. 在表单中添加file表单字段,即<input type=”file”…/>
<form action="${pageContext.request.contextPath }/FileUploadServlet" method="post" enctype="multipart/form-data"> 用户名:<input type="text" name="username"/><br/> 文件1:<input type="file" name="file1"/><br/> 文件2:<input type="file" name="file2"/><br/> <input type="submit" value="提交"/> </form> |
Servlet的要求
当提交的表单是文件上传表单时,那么对Servlet也是有要求的。文件上传表单的数据也是被封装到request对象中的。request.getParameter(String)方法获取指定的表单字段字符内容,但文件上传表单已经不在是字符内容,而是字节内容。这时可以使用request的getInputStream()方法获取ServletInputStream对象,它是InputStream的子类,这个ServletInputStream对象对应整个表单的正文部分(从第一个分隔线开始,到最后),这说明我们需要的解析流中的数据。当然解析它是很麻烦的一件事情,而Apache已经帮我们提供了解析它的工具:commons-fileupload。
可以尝试把request.getInputStream()这个流中的内容打印出来。
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { InputStream in = request.getInputStream(); String s = IOUtils.toString(in); System.out.println(s); } |
commons-fileupload
FileUpload组件将页面提交的所有元素(普通form表单域,如text和文件域file)都看作一样的FileItem,这样上传页面提交的request请求也就是一个FileItem的有序组合,FileUpload组件可以解析该request,并返回一个一个的FileItem。而对 每一个FileItem,FileUpload组件可以判断出它是普通form表单域还是文件file域,从而根据不同的类型,采取不同的操作--如果是表单域,就读出其值,如果是文件域,就保存文件到服务器硬盘上或者内存中。
为什么使用fileupload:
上传文件的要求比较多,需要记一下:
l 必须是POST表单;
l 表单的enctype必须是multipart/form-data;
l 在表单中添加file表单字段,即<input type=”file”…/>
Servlet的要求:
l 不能再使用request.getParameter()来获取表单数据;
l 可以使用request.getInputStream()得到所有的表单数据,而不是一个表单项的数据;
l 不使用fileupload,需要对request.getInputStream()的内容进行解析
fileupload概述
fileupload是由apache的commons组件提供的上传组件。它最主要的工作就是解析request.getInputStream()。
fileupload组件需要的JAR包有:
l commons-fileupload.jar,核心包;
l commons-io.jar,依赖包。
fileupload简单应用
fileupload的核心类有:DiskFileItemFactory、ServletFileUpload、FileItem。
使用fileupload组件的步骤如下:
1. 创建工厂类DiskFileItemFactory对象:DiskFileItemFactoryfactory = new DiskFileItemFactory()
2. 使用工厂创建解析器对象:ServletFileUpload fileUpload = new ServletFileUpload(factory)
3. 使用解析器来解析request对象:List<FileItem>list = fileUpload.parseRequest(request)
FileItem类,一个FileItem对象对应一个表单项(表单字段)。一个表单中存在文件字段和普通字段,可以使用FileItem类的isFormField()方法来判断表单字段是否为普通字段,如果不是普通字段,那么就是文件字段了。
l String getName():获取文件字段的文件名称;
l String getString():获取字段的内容,如果是文件字段,那么获取的是文件内容,当然上传的文件必须是文本文件;
l String getFieldName():获取字段名称,例如:<inputtype=”text” name=”username”/>,返回的是username;
l String getContentType():获取上传的文件的类型,例如:text/plain。
l int getSize():获取上传文件的大小;
l boolean isFormField():判断当前表单字段是否为普通文本字段,如果返回false,说明是文件字段;
l InputStream getInputStream():获取上传文件对应的输入流;
l void write(File):把上传的文件保存到指定文件中。
简单上传示例
写一个简单的上传示例:
l 表单包含一个用户名字段,以及一个文件字段;
l Servlet保存上传的文件到uploads目录,显示用户名,文件名,文件大小,文件类型。
第一步:
完成index.jsp,只需要一个表单。注意表单必须是post的,而且enctype必须是mulitpart/form-data的。
<form action="${pageContext.request.contextPath }/FileUploadServlet" method="post" enctype="multipart/form-data"> 用户名:<input type="text" name="username"/><br/> 文件1:<input type="file" name="file1"/><br/> <input type="submit" value="提交"/> </form> |
第二步:
完成FileUploadServlet
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // 因为要使用response打印,所以设置其编码 response.setContentType("text/html;charset=utf-8");
// 创建工厂 DiskFileItemFactory dfif = new DiskFileItemFactory(); // 使用工厂创建解析器对象 ServletFileUpload fileUpload = new ServletFileUpload(dfif); try { // 使用解析器对象解析request,得到FileItem列表 List<FileItem> list = fileUpload.parseRequest(request); // 遍历所有表单项 for(FileItem fileItem : list) { // 如果当前表单项为普通表单项 if(fileItem.isFormField()) { // 获取当前表单项的字段名称 String fieldName = fileItem.getFieldName(); // 如果当前表单项的字段名为username if(fieldName.equals("username")) { // 打印当前表单项的内容,即用户在username表单项中输入的内容 response.getWriter().print("用户名:" + fileItem.getString() + "<br/>"); } } else {//如果当前表单项不是普通表单项,说明就是文件字段 String name = fileItem.getName();//获取上传文件的名称 // 如果上传的文件名称为空,即没有指定上传文件 if(name == null || name.isEmpty()) { continue; } // 获取真实路径,对应${项目目录}/uploads,当然,这个目录必须存在 String savepath = this.getServletContext().getRealPath("/uploads"); // 通过uploads目录和文件名称来创建File对象 File file = new File(savepath, name); // 把上传文件保存到指定位置 fileItem.write(file); // 打印上传文件的名称 response.getWriter().print("上传文件名:" + name + "<br/>"); // 打印上传文件的大小 response.getWriter().print("上传文件大小:" + fileItem.getSize() + "<br/>"); // 打印上传文件的类型 response.getWriter().print("上传文件类型:" + fileItem.getContentType() + "<br/>"); } } } catch (Exception e) { throw new ServletException(e); } } |
文件上传之细节
文件放到WEB-INF目录
如果没有把用户上传的文件存放到WEB-INF目录下,那么用户就可以通过浏览器直接访问上传的文件,这是非常危险的。
通常会在WEB-INF目录下创建一个uploads目录来存放上传的文件,而在Servlet中找到这个目录需要使用ServletContext的getRealPath(String)方法,例如在我的upload1项目中有如下语句:
ServletContextservletContext = this.getServletContext();
String savepath= servletContext.getRealPath(“/WEB-INF/uploads”);
其中savepath为:F:\tomcat6_1\webapps\upload1\WEB-INF\uploads。
文件名称
上传文件名称可能是完整路径:
IE6获取的上传文件名称是完整路径,而其他浏览器获取的上传文件名称只是文件名称而已。浏览器差异的问题我们还是需要处理一下的。
String name = file1FileItem.getName(); response.getWriter().print(name); |
使用不同浏览器测试,其中IE6就会返回上传文件的完整路径,带来了很大的麻烦,就是需要处理这一问题。无论是否为完整路径,截取最后一个“\\”后面的内容就可以了。
String name = file1FileItem.getName(); int lastIndex = name.lastIndexOf("\\");//获取最后一个“\”的位置 if(lastIndex != -1) {//注意,如果不是完整路径,那么就不会有“\”的存在。 name = name.substring(lastIndex + 1);//获取文件名称 } response.getWriter().print(name); |
中文乱码问题
上传文件名称中包含中文:
当上传的谁的名称中包含中文时,需要设置编码,commons-fileupload组件提供了两种设置编码的方式:
l request.setCharacterEncoding(String)
l fileUpload.setHeaderEncdoing(String):这种方式的优先级高与前一种。
上传文件的文件内容包含中文:
通常不需关心上传文件的内容,因为会把上传文件保存到硬盘上!也就是说,文件原来是什么样子,到服务器这边还是什么样子!但是如果有这样的需求,要在控制台显示上传的文件内容,那么可以使用fileItem.getString(“utf-8”)来处理编码。文本文件内容和普通表单项内容使用FileItem类的getString(“utf-8”)来处理编码。
上传文件同名问题
通常会把用户上传的文件保存到uploads目录下,但如果用户上传了同名文件?这会出现覆盖的现象。处理这一问题的手段是使用UUID生成唯一名称,然后再使用“_”连接文件上传的原始名称。
例如用户上传的文件是“一寸照片.jpg”,在通过处理后,文件名称为:“891b3881395f4175b969256a3f7b6e10_一寸照片.jpg”,这种手段不会使文件丢失扩展名,并且因为UUID的唯一性,上传的文件同名,但在服务器端是不会出现同名问题的。
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { request.setCharacterEncoding("utf-8"); DiskFileItemFactory dfif = new DiskFileItemFactory(); ServletFileUpload fileUpload = new ServletFileUpload(dfif); try { List<FileItem> list = fileUpload.parseRequest(request); //获取第二个表单项,因为第一个表单项是username,第二个才是file表单项 FileItem fileItem = list.get(1); String name = fileItem.getName();//获取文件名称
// 如果客户端使用的是IE6,那么需要从完整路径中获取文件名称 int lastIndex = name.lastIndexOf("\\"); if(lastIndex != -1) { name = name.substring(lastIndex + 1); }
// 获取上传文件的保存目录 String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads"); String uuid = CommonUtils.uuid();//生成uuid String filename = uuid + "_" + name;//新的文件名称为uuid + 下划线 + 原始名称
//创建file对象,下面会把上传文件保存到这个file指定的路径 //savepath,即上传文件的保存目录 //filename,文件名称 File file = new File(savepath, filename);
// 保存文件 fileItem.write(file); } catch (Exception e) { throw new ServletException(e); } } |
目录不能存放过多的文件
一个目录下不应该存放过多的文件,一般一个目录存放1000个文件就是上限了,如果在多,那么打开目录时就会很“卡”。需要把上传的文件放到不同的目录中。但是也不能为每个上传的文件一个目录,这种方式会导致目录过多。
打散的方法有很多,例如使用日期来打散,每天生成一个目录。也可以使用文件名的首字母来生成目录,相同首字母的文件放到同一目录下。
日期打散算法:如果某一天上传的文件过多,那么也会出现一个目录文件过多的情况;
首字母打散算法:如果文件名是中文的,因为中文过多,所以会导致目录过多的现象。
使用hash算法来打散:
1. 获取文件名称的hashCode:int hCode = name.hashCode();;
2. 获取hCode的低4位,然后转换成16进制字符;
3. 获取hCode的5~8位,然后转换成16进制字符;
4. 使用这两个16进制的字符生成目录链。例如低4位字符为“5”
这种算法的好处是,在uploads目录下最多生成16个目录,而每个目录下最多再生成16个目录,即256个目录,所有上传的文件都放到这256个目录下。如果每个目录上限为1000个文件,那么一共可以保存256000个文件。
例如上传文件名称为:新建文本文档.txt,那么把“新建 文本文档.txt”的哈希码获取到,再获取哈希码的低4位,和5~8位。假如低4位为:9,5~8位为1,那么文件的保存路径为uploads/9/1/。
int hCode = name.hashCode();//获取文件名的hashCode //获取hCode的低4位,并转换成16进制字符串 String dir1 = Integer.toHexString(hCode & 0xF); //获取hCode的低5~8位,并转换成16进制字符串 String dir2 = Integer.toHexString(hCode >>> 4 & 0xF); //与文件保存目录连接成完整路径 savepath = savepath + "/" + dir1 + "/" + dir2; //因为这个路径可能不存在,所以创建成File对象,再创建目录链,确保目录在保存文件之前已经存在 new File(savepath).mkdirs(); |
上传的单个文件的大小限制
限制上传文件的大小很简单,ServletFileUpload类的setFileSizeMax(long)就可以了。参数就是上传文件的上限字节数,例如servletFileUpload.setFileSizeMax(1024*10)表示上限为10KB。
一旦上传的文件超出了上限,那么就会抛出FileUploadBase.FileSizeLimitExceededException异常。可以在Servlet中获取这个异常,然后向页面输出“上传的文件超出限制”。
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { request.setCharacterEncoding("utf-8"); DiskFileItemFactory dfif = new DiskFileItemFactory(); ServletFileUpload fileUpload = new ServletFileUpload(dfif); // 设置上传的单个文件的上限为10KB fileUpload.setFileSizeMax(1024 * 10); try { List<FileItem> list = fileUpload.parseRequest(request); //获取第二个表单项,因为第一个表单项是username,第二个才是file表单项 FileItem fileItem = list.get(1); String name = fileItem.getName();//获取文件名称
// 如果客户端使用的是IE6,那么需要从完整路径中获取文件名称 int lastIndex = name.lastIndexOf("\\"); if(lastIndex != -1) { name = name.substring(lastIndex + 1); }
// 获取上传文件的保存目录 String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads"); String uuid = CommonUtils.uuid();//生成uuid String filename = uuid + "_" + name;//新的文件名称为uuid + 下划线 + 原始名称
int hCode = name.hashCode();//获取文件名的hashCode //获取hCode的低4位,并转换成16进制字符串 String dir1 = Integer.toHexString(hCode & 0xF); //获取hCode的低5~8位,并转换成16进制字符串 String dir2 = Integer.toHexString(hCode >>> 4 & 0xF); //与文件保存目录连接成完整路径 savepath = savepath + "/" + dir1 + "/" + dir2; //因为这个路径可能不存在,所以创建成File对象,再创建目录链,确保目录在保存文件之前已经存在 new File(savepath).mkdirs();
//创建file对象,下面会把上传文件保存到这个file指定的路径 //savepath,即上传文件的保存目录 //filename,文件名称 File file = new File(savepath, filename);
// 保存文件 fileItem.write(file); } catch (Exception e) { // 判断抛出的异常的类型是否为FileUploadBase.FileSizeLimitExceededException // 如果是,说明上传文件时超出了限制。 if(e instanceof FileUploadBase.FileSizeLimitExceededException) { // 在request中保存错误信息 request.setAttribute("msg", "上传失败!上传的文件超出了10KB!"); // 转发到index.jsp页面中!在index.jsp页面中需要使用${msg}来显示错误信息 request.getRequestDispatcher("/index.jsp").forward(request, response); return; } throw new ServletException(e); } } |
上传文件的总大小限制
上传文件的表单中可能允许上传多个文件,例如:
有时需要限制一个请求的大小。也就是说这个请求的最大字节数(所有表单项之和)!实现这一功能也很简单,只需要调用ServletFileUpload类的setSizeMax(long)方法即可。
例如fileUpload.setSizeMax(1024 * 10);,显示整个请求的上限为10KB。当请求大小超出10KB时,ServletFileUpload类的parseRequest()方法会抛出FileUploadBase.SizeLimitExceededException异常。
缓存大小与临时目录
fileupload组件不可能把文件都保存在内存中,fileupload会判断文件大小是否超出10KB,如果是那么就把文件保存到硬盘上,如果没有超出,那么就保存在内存中。
10KB是fileupload默认的值,可以来设置修改它。
当文件保存到硬盘时,fileupload是把文件保存到系统临时目录,也可以去设置临时目录。
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { request.setCharacterEncoding("utf-8"); DiskFileItemFactory dfif = new DiskFileItemFactory(1024*20, new File("F:\\temp")); ServletFileUpload fileUpload = new ServletFileUpload(dfif); try { List<FileItem> list = fileUpload.parseRequest(request); FileItem fileItem = list.get(1); String name = fileItem.getName(); String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads");
// 保存文件 fileItem.write(path(savepath, name)); } catch (Exception e) { throw new ServletException(e); } } private File path(String savepath, String filename) { // 从完整路径中获取文件名称 int lastIndex = filename.lastIndexOf("\\"); if(lastIndex != -1) { filename = filename.substring(lastIndex + 1); } // 通过文件名称生成一级、二级目录 int hCode = filename.hashCode(); String dir1 = Integer.toHexString(hCode & 0xF); String dir2 = Integer.toHexString(hCode >>> 4 & 0xF); savepath = savepath + "/" + dir1 + "/" + dir2; // 创建目录 new File(savepath).mkdirs(); // 给文件名称添加uuid前缀 String uuid = CommonUtils.uuid(); filename = uuid + "_" + filename; // 创建文件完成路径 return new File(savepath, filename); } |