文件上传概述:
1,文件上传对页面的要求:
必须使用表单,而不能是超链接
表单的method必须是post
表单的enctype必须是multipart/form-data
在表单中添加file表单字段,即<input type=”file”…/>比如:
<form action="${pageContext.request.contextPath }/XXXServlet" 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>
2,对比文件上传表单与普通表单的区别
通过httpWatch查看“文件上传表单”和“普通文本表单”的区别。
文件上传表单的enctype=”multipart/form-data”,表示多部件表单数据;
普通文本表单可以不设置enctype属性:
当method=”post”时,enctype的默认值为application/x-www-form-urlencoded,表示使用url编码正文;
当method=”get”时,enctype的默认值为null,没有正文,所以就不需要enctype了
通过httpWatch测试,查看表单的请求数据正文,我们发现请求中只有文件名称,而没有文件内容。也就是说,当表单的enctype不是multipart/form-data时,请求中不包含文件内容,而只有文件的名称,这说明普通文本表单中input:file与input:text没什么区别了。
通过httpWatch测试,查看表单的请求数据正文部分,发现正文部分是由多个部件组成,每个部件对应一个表单字段,每个部件都有自己的头信息。头信息下面是空行,空行下面是字段的正文部分。多个部件之间使用随机生成的分隔线隔开。
文本字段的头信息中只包含一条头信息,即Content-Disposition,这个头信息的值有两个部分,第一部分是固定的,即form-data,第二部分为字段的名称。在空行后面就是正文部分了,正文部分就是在文本框中填写的内容。
文件字段的头信息中包含两条头信息,Content-Disposition和Content-Type。Content-Disposition中多出一个filename,它指定的是上传的文件名称。而Content-Type指定的是上传文件的类型。文件字段的正文部分就是文件的内容。
请注意,因为我们上传的文件都是普通文本文件,即txt文件,所以在httpWatch中是可以正常显示的,如果上传的是exe、mp3等文件,那么在httpWatch看到的就是乱码了
3,文件上传对Servlet的要求
当提交的表单是文件上传表单时,那么对Servlet也是有要求的。
首先我们要肯定一点,文件上传表单的数据也是被封装到request对象中的。
request.getParameter(String)方法获取指定的表单字段字符内容,但文件上传表单已经不在是字符内容,而是字节内容,所以失效。
这时可以使用request的getInputStream()方法获取ServletInputStream对象,它是InputStream的子类,这个ServletInputStream对象对应整个表单的正文部分(从第一个分隔线开始,到最后),这说明我们需要的解析流中的数据。当然解析它是很麻烦的一件事情,而Apache已经帮我们提供了解析它的工具:commons-fileupload
需要使用的jar包
commons-fileupload.jar,核心包;最主要的工作就是帮我们解析request.getInputStream()
commons-io.jar,依赖包
Fileupload详述
fileupload的核心类DiskFileItemFactory,ServletFileUpload, FileItem
使用fileupload组件的步骤如下:
1. 创建工厂类DiskFileItemFactory对象:DiskFileItemFactory factory = new DiskFileItemFactory()
2. 使用工厂创建解析器对象:ServletFileUpload fileUpload = new ServletFileUpload(factory)
3. 使用解析器来解析request对象:List<FileItem> list = fileUpload.parseRequest(request)
隆重介绍FileItem类,它才是我们最终要的结果。一个FileItem对象对应一个表单项(表单字段)。一个表单中存在文件字段和普通字段,可以使用FileItem类的isFormField()方法来判断表单字段是否为普通字段,如果不是普通字段,那么就是文件字段了
常用方法如下
String getName():获取文件字段的文件名称;
String getString():获取字段的内容,如果是文件字段,那么获取的是文件内容,当然上传的文件必须是文本文件;
String getFieldName():获取字段名称,例如:<input type=”text” name=”username”/>,返回的是username;
String getContentType():获取上传的文件的类型,例如:text/plain。
int getSize():获取上传文件的大小;
boolean isFormField():判断当前表单字段是否为普通文本字段,如果返回false,说明是文件字段;
InputStream getInputStream():获取上传文件对应的输入流;
void write(File):把上传的文件保存到指定文件中
我们先举个例子
数显在jsp文件,建立表单
<form action="${pageContext.request.contextPath }/AServlet" method="post" enctype="multipart/form-data">
文件:<input type="file" name="file2"/><br/>
<input type="submit" value="提交"/>
</form>
然后写服务器端Servlet文件
public class AServlet extends HttpServlet { public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { System.out.println("成功"); request.setCharacterEncoding("utf-8"); //也可以用fileUpload.setHeaderEncdoing(String) response.setContentType("text/html;charset=utf-8"); DiskFileItemFactory factory = new DiskFileItemFactory();//可以设置临时目录和缓存大小,当上传的文件超出了缓存的大小就会保存到临时目录 ServletFileUpload fileUpload = new ServletFileUpload(factory); // 设置上传的单个文件的上限为10KB,一定要在fileUploadRequest()方法之前调用, //超出上限,则抛出FileUploadBase.SizeLimitExceededException异常 fileUpload.setFileSizeMax(1024 * 100); try { //一个FileItem对象对应一个表单项(表单字段),一个表单中存在文件字段和普通字段 List<FileItem> list = fileUpload.parseRequest(request); System.out.println("已经获取表单信息"); for(FileItem fileItem:list) { if(fileItem.isFormField()) {//如果当前表单项为普通表单项 String filename=fileItem.getFieldName();// 获取当前表单项的字段名称 System.out.println(filename); }else {//如果当前表单项不是普通表单项,说明就是文件字段 String name = fileItem.getName();//获取上传文件的名称 // 如果上传的文件名称为空,即没有指定上传文件 if(name == null || name.isEmpty()) { continue; } int index=name.lastIndexOf("\"); String path=name.substring(index+1);//得到上传文件真实的文件名 System.out.println("文件名称为:"+path); // 获取真实路径,对应${项目目录}/upLoads,当然,这个目录必须存在 String savepath = "E:\ProgramFiles\apache-tomcat-9.0.11\webapps\Upload\WEB-INF\upLoads";//指定文件保存路径 //this.getServletContext().getRealPath("/WEB-INF/upLoads");//也可以通过这个来获取文件真实路径 System.out.println("文件保存在"+savepath); //----------------------------- File f = new File(savepath); if(!f.exists()){//如果文件不存在 f.mkdirs();//创建目录,也就是文件夹 } File file = new File(savepath, path); if(!file.exists()){ try { file.createNewFile(); } catch (IOException e) { e.printStackTrace(); } } //----------------------------- 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); } }
文件上传之细节
1 把上传的文件放到WEB-INF目录下
如果没有把用户上传的文件存放到WEB-INF目录下,那么用户就可以通过浏览器直接访问上传的文件,这是非常危险的。
假如说用户上传了一个a.jsp文件,然后用户在通过浏览器去访问这个a.jsp文件,那么就会执行a.jsp中的内容,如果在a.jsp中有如下语句:Runtime.getRuntime().exec(“shutdown –s –t 1”);,那么就会关机
通常我们会在WEB-INF目录下创建一个uploads目录来存放上传的文件,而在Servlet中找到这个目录需要使用ServletContext的getRealPath(String)方法,例如在我的upload1项目中有如下语句:
ServletContext servletContext = this.getServletContext();
String savepath = servletContext.getRealPath(“/WEB-INF/uploads”);
其中savepath为:F: omcatwebappsuploadWEB-INFuploads
2 文件名称(完整路径、文件名称)
上传文件名称可能是完整路径:
IE6获取的上传文件名称是完整路径,而其他浏览器获取的上传文件名称只是文件名称而已。浏览器差异的问题我们还是需要处理一下的。
String name = file1FileItem.getName(); response.getWriter().print(name); |
使用不同浏览器测试,其中IE6就会返回上传文件的完整路径,不知道IE6在搞什么,这给我们带来了很大的麻烦,就是需要处理这一问题。
处理这一问题也很简单,无论是否为完整路径,我们都去截取最后一个“\”后面的内容就可以了。
String name = file1FileItem.getName(); int lastIndex = name.lastIndexOf("\");//获取最后一个“”的位置 if(lastIndex != -1) {//注意,如果不是完整路径,那么就不会有“”的存在。 name = name.substring(lastIndex + 1);//获取文件名称 } response.getWriter().print(name); |
3 中文乱码问题
上传文件名称中包含中文:
当上传的谁的名称中包含中文时,需要设置编码,commons-fileupload组件为我们提供了两种设置编码的方式:
request.setCharacterEncoding(String):这种方式是我们最为熟悉的方式了;
fileUpload.setHeaderEncdoing(String):这种方式的优先级高与前一种。
上传文件的文件内容包含中文:
通常我们不需关心上传文件的内容,因为我们会把上传文件保存到硬盘上!也就是说,文件原来是什么样子,到服务器这边还是什么样子!
但是如果你有这样的需求,非要在控制台显示上传的文件内容,那么你可以使用fileItem.getString(“utf-8”)来处理编码。
文本文件内容和普通表单项内容使用FileItem类的getString(“utf-8”)来处理编码。
4 上传文件同名问题(文件重命名)
通常我们会把用户上传的文件保存到uploads目录下,但如果用户上传了同名文件呢?这会出现覆盖的现象。处理这一问题的手段是使用UUID生成唯一名称,然后再使用“_”连接文件上传的原始名称。
例如用户上传的文件是“我的一寸照片.jpg”,在通过处理后,文件名称为:“891b3881395f4175b969256a3f7b6e10_我的一寸照片.jpg”,这种手段不会使文件丢失扩展名,并且因为UUID的唯一性,上传的文件同名,但在服务器端是不会出现同名问题的。
String uuid = CommonUtils.uuid();//生成uuid String filename = uuid + "_" + name;//新的文件名称为uuid + 下划线 + 原始名称
5 一个目录不能存放过多的文件(存放目录打散)
一个目录下不应该存放过多的文件,一般一个目录存放1000个文件就是上限了,如果在多,那么打开目录时就会很“卡”。你可以尝试打印C:WINDOWSsystem32目录,你会感觉到的。
也就是说,我们需要把上传的文件放到不同的目录中。但是也不能为每个上传的文件一个目录,这种方式会导致目录过多。所以我们应该采用某种算法来“打散”!
打散的方法有很多,例如使用日期来打散,每天生成一个目录。也可以使用文件名的首字母来生成目录,相同首字母的文件放到同一目录下。
日期打散算法:如果某一天上传的文件过多,那么也会出现一个目录文件过多的情况;
首字母打散算法:如果文件名是中文的,因为中文过多,所以会导致目录过多的现象。
我们这里使用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(); |
6 上传的单个文件的大小限制
限制上传文件的大小很简单,ServletFileUpload类的setFileSizeMax(long)就可以了。参数就是上传文件的上限字节数,例如servletFileUpload.setFileSizeMax(1024*10)表示上限为10KB。
一旦上传的文件超出了上限,那么就会抛出FileUploadBase.FileSizeLimitExceededException异常。我们可以在Servlet中获取这个异常,然后向页面输出“上传的文件超出限制”。
7 上传文件的总大小限制
上传文件的表单中可能允许上传多个文件。
有时我们需要限制一个请求的大小。也就是说这个请求的最大字节数(所有表单项之和)!实现这一功能也很简单,只需要调用ServletFileUpload类的setSizeMax(long)方法即可。
例如fileUpload.setSizeMax(1024 * 10);,显示整个请求的上限为10KB。当请求大小超出10KB时,ServletFileUpload类的parseRequest()方法会抛出FileUploadBase.SizeLimitExceededException异常
8 缓存大小与临时目录
大家想一想,如果我上传一个蓝光电影,先把电影保存到内存中,然后再通过内存copy到服务器硬盘上,那么你的内存能吃的消么?
所以fileupload组件不可能把文件都保存在内存中,fileupload会判断文件大小是否超出10KB,如果是那么就把文件保存到硬盘上,如果没有超出,那么就保存在内存中。
10KB是fileupload默认的值,我们可以来设置它。
当文件保存到硬盘时,fileupload是把文件保存到系统临时目录,当然你也可以去设置临时目录。
像这样,fileItem.write(path(savepath, name));