文件上传
一、文件上传概述
1 文件上传的作用
例如网络硬盘！就是用来上传下载文件的。
在招聘网上填写一个完整的简历还需要上传照片等。
2 文件上传对页面的要求
上传文件的要求比较多，需要记一下：
- 必须使用表单，而不能是超链接；
- 表单的method必须是POST，而不能是GET；
- 表单的enctype必须是multipart/form-data；
- 在表单中添加file表单字段，即<input type=”file“ name=”xxx” />
1 <form action="${pageContext.request.contextPath }/FileUploadServlet" method="post" enctype="multipart/form-data">
2 用户名：<input type="text" name="username"/><br/>
3 文件1：<input type="file" name="file1"/><br/>
4 文件2：<input type="file" name="file2"/><br/>
5 <input type="submit" value="提交"/>
6 </form>
3 文件上传对Servlet的要求
- request.getParameter(String)方法获取指定的表单字段字符内容，但文件上传表单已经不在是字符内容，而是字节内容，所以失效。
- ServletInputStream request.getInputStream():包含整个请求体。
4 多部件表单的体
①每隔出多个部件，即一个表单项一个部件。
②一个部件中字节包含请求头和空行，以及请求体
③普通表单项：
- 1个头：Content-Disposition:包含name=“xxxx”,即表单项名称
- 体就是表单项的值
④文件表单项：
- Content-Disposition: 包含name=“xx”，即表单项名称，还有一个filename=“xx”，表示上传文件的名称
- Content-Type：它是上传文件的MINE类型，例如：image/pjpeg，表示上传的图片，图中jpg扩展名的图片。
- 体就是上传文件的内容
Request Headers
view parsed
POST /form1.jsp HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Content-Length: 479756
Cache-Control: max-age=0
Origin: http://localhost:8080
Upgrade-Insecure-Requests: 1
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary8Wne2EqQO2Ps7E8m
User-Agent: ****
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
Referer: http://localhost:8080/form1.jsp
Accept-Encoding: gzip, deflate, br
Accept-Language: zh,en-US;q=0.8,en;q=0.6,zh-CN;q=0.4
Cookie: Idea-e96526d7=db12919d-58f1-479a-b0f7-3104911c767b; JSESSIONID=9DEFDF98FE8715CB5707772F874D8C82
Request Payload
------WebKitFormBoundary8Wne2EqQO2Ps7E8m
Content-Disposition: form-data; name="username"
zhangsan
------WebKitFormBoundary8Wne2EqQO2Ps7E8m
Content-Disposition: form-data; name="picture"; filename="2.jpg"
Content-Type: image/jpeg
------WebKitFormBoundary8Wne2EqQO2Ps7E8m--
5 commons-fileupload
fileupload是由apache的commons组件提供的上传组件。它最主要的工作就是帮我们解析request.getInputStream()。
fileupload组件需要的JAR包有：
- commons-fileupload.jar，核心包；
- commons-io.jar，依赖包。
二、fileupload简单应用
1、fileupload的核心类有：DiskFileItemFactory、ServletFileUpload、FileItem。
使用fileupload组件的步骤如下：
①创建工厂类DiskFileItemFactory对象：DiskFileItemFactory factory = new DiskFileItemFactory()
②使用工厂创建解析器对象：ServletFileUpload fileUpload = new ServletFileUpload(factory)
③使用解析器来解析request对象：List<FileItem> list = fileUpload.parseRequest(request)
2、FileItem
一个FileItem对象对应一个表单项（表单字段）。
一个表单中存在文件字段和普通字段，可以使用FileItem类的isFormField()方法来判断表单字段是否为普通字段，如果不是普通字段，那么就是文件字段了。
- boolean isFormField()：判断当前表单字段是否为普通文本字段，如果返回false，说明是文件字段；
- String getFieldName()：获取字段名称，例如：<input type=”text” name=”username”/>，返回的是username；
- String getName()：获取文件字段的文件名称；
- String getString(String charset)：获取字段的内容，如果是文件字段，那么获取的是文件内容，当然上传的文件必须是文本文件；
- String getContentType()：获取上传的文件的类型，例如：text/plain。
- long getSize()：返回上传文件的字节数；
- InputStream getInputStream()：获取上传文件对应的输入流；
- void write(File)：把上传的文件保存到指定文件中。
3、示例：
1 package servlet;
2
3 import org.apache.commons.fileupload.FileItem;
4 import org.apache.commons.fileupload.FileUploadException;
5 import org.apache.commons.fileupload.disk.DiskFileItemFactory;
6 import org.apache.commons.fileupload.servlet.ServletFileUpload;
7
8 import javax.servlet.ServletException;
9 import javax.servlet.annotation.WebServlet;
10 import javax.servlet.http.HttpServlet;
11 import javax.servlet.http.HttpServletRequest;
12 import javax.servlet.http.HttpServletResponse;
13 import java.io.File;
14 import java.io.IOException;
15 import java.util.List;
16
17 @WebServlet(name = "Upload2Servlet",urlPatterns = "/Upload2Servlet")
18 public class Upload2Servlet extends HttpServlet {
19 protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
20 request.setCharacterEncoding("utf-8");
21 response.setContentType("text/html;charset=utf-8");
22 /*
23 * 1、得到工厂
24 * 2、通过工厂创建解析器
25 * 3、解析request，得到FileItem集合
26 * 4、遍历FileItem集合，调用其API完成文件的保存
27 * */
28 DiskFileItemFactory factory = new DiskFileItemFactory();
29 ServletFileUpload sfu = new ServletFileUpload(factory);
30 try {
31 List<FileItem> fileItems = sfu.parseRequest(request);
32 FileItem fileItem1 = fileItems.get(0);
33 FileItem fileItem2 = fileItems.get(1);
34
35 System.out.println("普通表单项演示："+fileItem1.get()+
36 "="+fileItem1.toString());
37 System.out.println("文件表单演示：");
38 System.out.println("Content-Type:" + fileItem2.getContentType());
39 System.out.println("size:"+fileItem2.getSize());
40 System.out.println("filename:"+fileItem2.getName());
41 //保存文件
42 File destFile = new File("/Users/Shared/picture.jpg");
43 try {
44 fileItem2.write(destFile);
45 } catch (Exception e) {
46 throw new RuntimeException(e);
47 }
48 } catch (FileUploadException e) {
49 throw new RuntimeException(e);
50 }
51 }
52 }
1 <%@ page contentType="text/html;charset=UTF-8" language="java" %>
2 <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
3 <html>
4 <head>
5 <title>Title</title>
6 </head>
7 <body>
8 <h1>上传2</h1>
9 <form action="<c:url value='/Upload2Servlet'/>" method="post" enctype="multipart/form-data">
10 用户名：<input type="text" name="username"/><br/>
11 照片： <input type="file" name="picture" /><br/>
12 <input type="submit" value="上传">
13 </form>
14 </body>
15 </html>
三、上传的细节
1. 文件必须保存到WEB-INF下！
* 目的是不让浏览器直接访问到！
* 把文件保存到WEB-INF目录下！
2. 文件名称相关问题
* 有的浏览器上传的文件名是绝对路径，这需要切割！C:\files\baibing.jpg
String filename = fi2.getName();
int index = filename.lastIndexOf("\\");
if(index != -1) {
filename = filename.substring(index+1);
}
* 文件名乱码或者普通表单项乱码：request.setCharacterEncoding("utf-8");因为fileupload内部会调用request.getCharacterEncoding();
> request.setCharacterEncoding("utf-8");//优先级低
> servletFileUpload.setHeaderEncoding("utf-8");//优先级高
* 文件同名问题:我们需要为每个文件添加名称前缀，这个前缀要保证不能重复。uuid
> filename = CommonUtils.uuid() + "_" + filename;
3. 目录打散
* 不能在一个目录下存放之多文件。
> 首字符打散：使用文件的首字母做为目录名称，例如：abc.txt，那么我们把文件保存到a目录下。如果a目录这时不存在，那么创建之。
> 时间打散：使用当前日期做为目录。
> 哈希打散：
* 通过文件名称得到int值，即调用hashCode()
* 它int值转换成16进制0~9, A~F
* 获取16进制的前两位用来生成目录，目录为二层！例如：1B2C3D4E5F，/1/B/保存文件。
4. 上传文件的大小限制
* 单个文件大小限制
> sfu.setFileSizeMax(100*1024)：限制单个文件大小为100KB
> 上面的方法调用，必须在解析开始之前调用！
> 如果上传的文件超出限制，在parseRequest()方法执行时，会抛出异常！FileUploadBase.FileSizeLimitExceededException
* 整个请求所有数据大小限制
> sfu.setSizeMax(1024 * 1024);//限制整个表单大小为1M
> 这个方法也是必须在parseRequest()方法之前调用
> 如果上传的文件超出限制，在parseRequest()方法执行时，会抛出异常！FileUploadBase.SizeLimitExceededException
5. 缓存大小与临时目录
* 缓存大小：超出多大，才向硬盘保存！默认为10KB
* 临时目录：向硬盘的什么目录保存
设置缓存大小与临时目录：new DiskFileItemFactory(20*1024, new File("F:/temp"))
四、目录打散、上传的大小限制、缓存大小与临时目录示例：
1 package servlet;
2
3 import cn.itcast.commons.CommonUtils;
4 import org.apache.commons.fileupload.FileItem;
5 import org.apache.commons.fileupload.FileUploadBase;
6 import org.apache.commons.fileupload.FileUploadException;
7 import org.apache.commons.fileupload.disk.DiskFileItemFactory;
8 import org.apache.commons.fileupload.servlet.ServletFileUpload;
9
10 import javax.servlet.ServletException;
11 import javax.servlet.annotation.WebServlet;
12 import javax.servlet.http.HttpServlet;
13 import javax.servlet.http.HttpServletRequest;
14 import javax.servlet.http.HttpServletResponse;
15 import java.io.File;
16 import java.io.IOException;
17 import java.util.List;
18 @WebServlet(name = "Upload3Servlet",urlPatterns = "/Upload3Servlet")
19 public class Upload3Servlet extends HttpServlet {
20 protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
21 request.setCharacterEncoding("utf-8");
22 response.setContentType("text/html;charset=utf-8");
23
24 //工厂
25 DiskFileItemFactory factory = new DiskFileItemFactory(20*1024,new File("/Users/Shared/temp"));
26 //解析器
27 ServletFileUpload sfu = new ServletFileUpload(factory);
28
29 // sfu.setFileSizeMax(100*1024);//限制单个文件大小为100KB
30 // sfu.setSizeMax(100*1024);//限制整个表单大小为100KB
31 //解析，得到List
32 try {
33 List<FileItem> list = sfu.parseRequest(request);
34 FileItem fi = list.get(1);
35
36 //1、得到文件保存的路径
37 String root = this.getServletContext().getRealPath("/WEB-INF/files");
38 /*
39 * 2、生成二层目录
40 * 得到文件名称
41 * 得到hashCode
42 * 转发成16进制
43 * 获取前两个字符用来生成目录
44 * */
45 String filename = fi.getName();//获取上传文件名称
46 //处理文件名的绝对路径问题
47 int index = filename.lastIndexOf("//");
48 if (index != 1) {
49 filename = filename.substring(index+1);
50 }
51 //给文件名称添加UUID前缀，处理文件同名问题
52 String savename = CommonUtils.uuid()+"_"+filename;
53 //1、得到hashCode
54 int hCode = filename.hashCode();
55 String hex = Integer.toHexString(hCode);
56 //2、获取hex的前两个字母，与root连接在一起，生成一个完整的路径
57 File dirFile = new File(root,hex.charAt(0)+"/"+hex.charAt(1));
58 //3、创建目录链
59 dirFile.mkdirs();
60 //4、创建目录文件
61 File destFile = new File(dirFile,savename);
62 //5、保存
63 fi.write(destFile);
64 } catch (FileUploadException e) {
65 if(e instanceof FileUploadBase.FileSizeLimitExceededException) {
66 request.setAttribute("msg", "您上传的文件超出了100KB！");
67 request.getRequestDispatcher("/form3.jsp").forward(request, response);
68 }
69 } catch (Exception e) {
70 e.printStackTrace();
71 }
72 }
73 }
