Java Web之上传文件
本篇文章你会学到
1. Apache FileUpload组件
2.上传文件保存的路径和名称问题
3.缓存大小和临时目录
4.控制文件上传的格式
先讲一个简单的例子，一个注册页面，有账号，邮箱，和头像这三个，JSP代码如下：
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>文件上传</title> </head> <body> <h3>文件上传</h3> <form action="/upload" method="post"> 账号：<input type="text" name="username"/><br> 邮箱：<input type="email" name="email"><br> 头像：<input type="file" name="headimg"><br> <input type="submit" value="注册"> </form> </body> </html>
然后我们的浏览器是这样的
我现在输入账号，邮箱和选择一张图片，用Servlet来接收，看看我的Servlet代码
package main.com.vae.Upload;import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.File; import java.io.IOException; import java.util.List; @WebServlet("/upload") public class UploadServlet extends HttpServlet { @Override protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { req.setCharacterEncoding("utf-8"); String name=req.getParameter("username"); String email=req.getParameter("email"); String headimg=req.getParameter("headimg"); System.out.println(name + email + headimg); } }
你会发现，账号，邮箱都是对的，但是头像这个获取的是图片的名字，而不是一个图片。
所以我们的解决办法是使用二进制流的形式传输过来，这样就可以获取图片的二进制流文件了，我们需要在form表单加一个东西
这个就是说让表单以二进制流的形式传输内容。加了这个之后，我们再次去执行一下注册，发现获取的参数全部变成null了
这个说明了一个问题：
req.getParameter 无法获取二进制流的文件
不用二进制流，req.getParameter只能获取图片的名称，使用二进制流，req.getParameter又不能获取二进制流格式的文件，那怎么办呢？很简单，答案是不使用req.getParameter
Apache FileUpload组件
引入正题，我们使用Apache的FileUpload组件来做文件上传的处理，首先你要下载这个组件，我直接在maven仓库里面搜了一下，然后放到maven里面获取了
我们的JSP不需要改什么，我们的Servlet这样写：
package main.com.vae.Upload; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.FileItemFactory; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.File; import java.io.IOException; import java.util.List; @WebServlet("/upload") public class UploadServlet extends HttpServlet { @Override protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { req.setCharacterEncoding("utf-8"); String name=req.getParameter("username"); String email=req.getParameter("email"); String headimg=req.getParameter("headimg"); System.out.println(name + email + headimg); //解析和检查请求，是否是post方式，是否是二进制流格式 Boolean isMultipart=ServletFileUpload.isMultipartContent(req); if (!isMultipart) { return; //如果不是就不用上传了 } try { //创建FileItemFactory对象 FileItemFactory factory=new DiskFileItemFactory(); //创建文件上传的处理器 ServletFileUpload upload=new ServletFileUpload(factory); //解析请求 List<FileItem> items=upload.parseRequest(req); //迭代出每一个FileItem for (FileItem item : items) { String fileName = item.getFieldName(); if (item.isFormField()) { //普通的表单控件 String value = item.getString("utf-8"); System.out.println(fileName + "->" + value); } else { //上传文件的控件 System.out.println(fileName + "->" + item.getName()); //一个的标签的name，一个是文件的name item.write(new File("E:/", item.getName())); //把上传的文件保存到某个文件中 } } } catch (Exception e){ e.printStackTrace(); } } }
大概就是这样，测试之后是ok的
上面就已经实现了文件上传的功能了，但是有几个问题需要修正一下
1.我获取的文件名是图片的名字，IE6获取的文件名是加绝对路径的图片名称。这是第一个问题，浏览器版本问题。
2.文件保存名称问题，例如我上传的图片是 小女孩.jpg 我现在又上传了一个另外的小女孩图片名还是 小女孩.jpg 虽然两张图片的内容不一样，但是会覆盖。
3.文件保存路径问题，我不可能保存文件在一个写死的路径E盘吧。
1.获取文件名的浏览器版本问题
解决办法：Apache FileUpload为我们提供了3个方法，我们使用第一个就行，只获取文件的名称
String parh="c:/vae/piecture/小女孩.jpg"; //1.获取文件名称,获取的是 小女孩.jpg FilenameUtils.getName(parh); //2.获取文件的名称，但是不包括拓展名 获取的是 小女孩 FilenameUtils.getBaseName(parh); //3.获取文件的拓展名 获取的是jpg FilenameUtils.getExtension(parh);
2.文件保存名称问题
解决办法：使用UUID通用唯一识别码，这个UUID貌似可以创建不相同的ID出来
String RandomName = UUID.randomUUID().toString()+"."+FilenameUtils.getExtension(item.getName());
但是我有一个问题啊，我的头像或者其他文件，采用了UUID之后，是名字不会重复了，也不会覆盖文件了。但是我读取的时候怎么找？我怎么知道一大堆UUID文件里面哪个是我的头像？
这个地方存疑。
3.文件保存路径问题
在做项目的时候，肯定不会指定保存到E盘，C盘什么的，肯定是保存在这个项目里面的某个文件夹的
我们在这里会使用Servlet的getServletContext().getRealPath这个方法来获取一个路径，然后保存在upload文件夹下面，这个问题我们要想清楚，必须先明白我们Java Web项目的目录结构
具体的看我这篇文章：Java Web的项目目录结构
以下是更新过的代码：
package com.vae.Upload; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.FileItemFactory; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload; import org.apache.commons.io.FilenameUtils; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.File; import java.io.IOException; import java.util.List; import java.util.UUID; @WebServlet("/upload") public class UploadServlet extends HttpServlet { @Override protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { req.setCharacterEncoding("utf-8"); String name=req.getParameter("username"); String email=req.getParameter("email"); String headimg=req.getParameter("headimg"); System.out.println(name + email + headimg); //解析和检查请求，是否是post方式，是否是二进制流格式 Boolean isMultipart=ServletFileUpload.isMultipartContent(req); if (!isMultipart) { return; //如果不是就不用上传了 } try { //创建FileItemFactory对象 FileItemFactory factory=new DiskFileItemFactory(); //创建文件上传的处理器 ServletFileUpload upload=new ServletFileUpload(factory); //解析请求 List<FileItem> items=upload.parseRequest(req); //迭代出每一个FileItem for (FileItem item : items) { String fileName = item.getFieldName(); if (item.isFormField()) { //普通的表单控件 String value = item.getString("utf-8"); System.out.println(fileName + "->" + value); } else { //上传文件的控件 String RandomName = UUID.randomUUID().toString()+"."+FilenameUtils.getExtension(item.getName()); System.out.println(fileName + "->" + FilenameUtils.getName(item.getName())); //一个的标签的name，一个是文件的name String path=super.getServletContext().getRealPath("/upload"); System.out.println(path); item.write(new File(path, RandomName)); //把上传的文件保存到某个文件中 } } } catch (Exception e) { e.printStackTrace(); } } }
我们可以看到，我们把图片保存的路径是upload文件夹，我的项目结构是这样的
最后，介绍一下缓存
缓存大小和临时目录
我们在上传文件的时候，有一个缓存大小的设置的，如果缓存小于10kb的话，会直接加载进内存，如果缓存大于10kb的话，会存到临时目录里面，等待着下一步存进某个路径的操作。
我们看一下怎么设置缓存的大小和临时目录。不要修改临时目录，没必要
//创建FileItemFactory对象 FileItemFactory factory=new DiskFileItemFactory(); //设置缓存区大小,默认大小是10kb， ((DiskFileItemFactory) factory).setSizeThreshold(20*1024); //设置临时目录，默认是Tomcat下的temp，不建议设置 //((DiskFileItemFactory) factory).setRepository(临时目录不建议修改);
怎么判断文件是否在内存中
System.out.println(item.isInMemory());//判断文件资源是否在内存中
临时目录默认的是Tomcat的temp文件夹，我们来看看我的文件夹里面是什么样的
可以看到，我上面上传的图片都在，只不过他们的后缀都变成了tmp，我修改一个后缀为png，打开看看，还是我的图片
控制文件的上传格式
思路是这样的，比如我限制为上传的文件格式必须是图片，我要先把图片的后缀名都列出来，然后获取我上传文件的后缀名，比较一下，如果不在图片后缀列表里面就返回给浏览器一个消息提示，然后结束方法。
思路是这样，具体看代码：
//设置允许接收的文件的格式，我这里设置为只能是图片 private static final String ALLWED_IMAGE_TYPE ="png,jpg,gif,jpeg";
//----------------先获取上传文件的拓展名 String ext = FilenameUtils.getExtension(item.getName()); String [] allowedImagetype=ALLWED_IMAGE_TYPE.split(","); //-----------------判断上传文件的拓展名在不在我设定的范围之内,不在的话提醒并且结束方法 if (!Arrays.asList(allowedImagetype).contains(ext)) { req.setAttribute("errorMsg","你上传的不是图片，请重新上传"); req.getRequestDispatcher("/input.jsp").forward(req,resp); return; }
前端的JSP要接收一下消息
<span style="color: red">${errorMsg}</span>
看一下效果：
文件上传类抽取
因为文件上传这个类会经常的用到，所以最好抽取成一个类，这样的话可复用
首先我们新建一个类，叫FileUtil
package com.vae.Upload; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.FileItemFactory; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload; import org.apache.commons.io.FilenameUtils; import javax.servlet.http.HttpServletRequest; import java.io.File; import java.util.Arrays; import java.util.List; import java.util.UUID; public class FileUtil { //设置允许接收的文件的格式，我这里设置为只能是图片 private static final String ALLWED_IMAGE_TYPE ="png,jpg,gif,jpeg"; public static void upload(HttpServletRequest req) { //解析和检查请求，是否是post方式，默认是二进制流格式 Boolean isMultipart=ServletFileUpload.isMultipartContent(req); if (!isMultipart) { return; //如果不是就不用上传了 } try { //创建FileItemFactory对象 FileItemFactory factory=new DiskFileItemFactory(); //设置缓存区大小,默认大小是10kb， ((DiskFileItemFactory) factory).setSizeThreshold(20*1024); //设置临时目录，默认是Tomcat下的temp，不建议设置 //((DiskFileItemFactory) factory).setRepository(临时目录不建议修改); //创建文件上传的处理器 ServletFileUpload upload=new ServletFileUpload(factory); //解析请求 List<FileItem> items=upload.parseRequest(req); //迭代出每一个FileItem for (FileItem item : items) { String fileName = item.getFieldName(); if (item.isFormField()) { //普通的表单控件 String value = item.getString("utf-8"); System.out.println(fileName + "->" + value); } else { //----------------先获取上传文件的拓展名 String ext = FilenameUtils.getExtension(item.getName()); String [] allowedImagetype=ALLWED_IMAGE_TYPE.split(","); //-----------------判断上传文件的拓展名在不在我设定的范围之内,不在的话提醒并且结束方法 if (!Arrays.asList(allowedImagetype).contains(ext)) { throw new LogicException("你上传的不是图片，请重新上传图片"); } //上传文件的控件 String RandomName = UUID.randomUUID().toString()+"."+FilenameUtils.getExtension(item.getName()); System.out.println(fileName + "->" + FilenameUtils.getName(item.getName())); //一个的标签的name，一个是文件的name String path=req.getServletContext().getRealPath("/upload"); System.out.println(path); item.write(new File(path, RandomName)); //把上传的文件保存到某个文件中 //System.out.println(item.isInMemory());//判断文件资源是否在内存中 } } } //Exception会捕捉我们的LogicException异常提示，所以我们在上面写一个，便于把LogicException异常返回给Servlet catch (LogicException e){ throw e; } catch (Exception e) { e.printStackTrace(); } } }
这个是我写好的，里面的亮点有
1.我们无法在进行跳转了，跳转是Servlet的事，所以这里为了使得我们的FileUtil类和Servlet之间进行通信，我们采用了 throw Exception的方法，throw和return其实是一样的，只不过retuen是返回的数据类型，throw返回的是异常信息类型的
2.super.getServletContext 这个可以获取路径，但是只能在Servlet里面使用，我们的FileUtil类不是Servlet，所以采用了另外一种方法，就是req也可以这样去获取路径
3.两个catch，Exception的catch会把我们1里面抛出的异常给捕获了，那我们还怎么传递异常给Servlet，所以我们在上面又新加了一个异常，叫LogicException，这样的话，我们可以在
LogicException异常里面再次上抛，抛给我们的Servlet
我们新建一个异常类，叫LogicException，这就是我们上面使用的异常类，继承这两个方法就可以了，这个没啥细说的
package com.vae.Upload; public class LogicException extends RuntimeException{ /** * * @param message 异常的信息，可以自定义的 */ public LogicException(String message) { super(message); } /** * * @param message 异常的信息 * @param cause 异常的根本原因 */ public LogicException(String message, Throwable cause) { super(message, cause); } }
最好，看看我们的Servlet
package com.vae.Upload; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; @WebServlet("/upload") public class UploadServlet extends HttpServlet { @Override protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { try { FileUtil.upload(req); }catch (LogicException e){ //拿到我们的LogicException异常信息 String Msg=e.getMessage(); req.setAttribute("errorMsg",Msg); req.getRequestDispatcher("/input.jsp").forward(req,resp); } } }
文件的大小限制
上面有一个是缓存文件大小限制，这个仅仅是决定你的文件是保存在内存中还是保存在临时目录里面，下面讲的这个文件上传大小限制，是，超过这个范围就不让你上传了
有两个：
1.单个文件上传大小限制
2.所有文件上传大小限制
//单个文件上传大小限制为2M upload.setFileSizeMax(1024*1024*2); //这次请求上传文件的大小(整个表单)限制为3M upload.setSizeMax(1024*1024*3);
还要捕捉异常，传给自定义的异常类
catch (FileUploadBase.FileSizeLimitExceededException e){ throw new LogicException("单个文件的上传大小不得超过2M"); } catch (FileUploadBase.SizeLimitExceededException e){ throw new LogicException("所有上传文件的大小不得超过3M"); }
