Spring 梳理-处理Multipart 请求

1. 原理讲解

   1. 简单的HTTP POST
      
      大家通过HTTP向服务器发送POST请求提交数据，都是通过form表单提交的，代码如下：
      
      <form method="post"action="http://w.sohu.com" >
      
               <inputtype="text" name="txt1">
      
               <inputtype="text" name="txt2">
      
       </form>
      
      提交时会向服务器端发出这样的数据（已经去除部分不相关的头信息），数据如下：
      
      POST / HTTP/1.1
      
      Content-Type:application/x-www-form-urlencoded
      
      Accept-Encoding: gzip, deflate
      
      Host: w.sohu.com
      
      Content-Length: 
      
      Connection: Keep-Alive
      
      Cache-Control: no-cache
      
      txt1=hello&txt2=world
      
      对于普通的HTML Form POST请求，它会在头信息里使用Content-Length注明内容长度。头信息每行一条，空行之后便是Body，即“内容”（entity）。它的Content-Type是application/x-www-form-urlencoded，这意味着消息内容会经过URL编码，就像在GET请 求时URL里的QueryString那样。txt1=hello&txt2=world
      
      POST上传文件
      
      最早的HTTP POST是不支持文件上传的，给编程开发带来很多问题。但是在1995年，ietf出台了rfc1867,也就是《RFC  -Form-based File Upload in HTML》，用以支持文件上传。所以Content-Type的类型扩充了multipart/form-data用以支持向服务器发送二进制数据。因此发送post请求时候，表单<form>属性enctype共有二个值可选，这个属性管理的是表单的MIME编码：
      
       ①application/x-www-form-urlencoded(默认值)
       ②multipart/form-data
      其实form表单在你不写enctype属性时，也默认为其添加了enctype属性值，默认值是enctype="application/x- www-form-urlencoded".
      
      通过form表单提交文件操作如下：
      
      <form method="post"action="http://w.sohu.com/t2/upload.do" enctype=”multipart/form-data”>
      
               <inputtype="text" name="desc">
      
               <inputtype="file" name="pic">
      
       </form>
      
      浏览器将会发送以下数据：
      
      POST /t2/upload.do HTTP/1.1
      
      User-Agent: SOHUWapRebot
      
      Accept-Language: zh-cn,zh;q=0.5
      
      Accept-Charset: GBK,utf-;q=0.7,*;q=0.7
      
      Connection: keep-alive
      
      Content-Length: 
      
      Content-Type:multipart/form-data; boundary=ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC
      
      Host: w.sohu.com
      
      --ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC
      
      Content-Disposition: form-data;name="desc"
      
      Content-Type: text/plain; charset=UTF-
      
      Content-Transfer-Encoding: 8bit
      
      [......][......][......][......]...........................
      
      --ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC
      
      Content-Disposition: form-data;name="pic"; filename="photo.jpg"
      
      Content-Type: application/octet-stream
      
      Content-Transfer-Encoding: binary
      
      [图片二进制数据]
      
      --ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC--
      
      我们来分析下数据，第一个空行之前自然还是HTTP header，之后则是Entity，而此时的Entity也比之前要复杂一些。根据RFC 1867定义，我们需要选择一段数据作为“分割边界”（ boundary属性），这个“边界数据”不能在内容其他地方出现，一般来说使用一段从概率上说“几乎不可能”的数据即可。 不同浏览器的实现不同，例如火狐某次post的  boundary=--------------------------- ， opera为boundary=----------E4SgDZXhJMgNE8jpwNdOAX ，每次post浏览器都会生成一个随机的30-40位长度的随机字符串，浏览器一般不会遍历这次post的所有数据找到一个不可能出现在数据中的字符串，这样代价太大了。一般都是随机生成，如果你遇见boundary值和post的内容一样，那样的话这次上传肯定失败，不过我建议你去买彩票，你太幸运了。Rfc1867这样说明{A boundary is selected that does not occur in any of the data. (This selection is sometimes done probabilisticly.)}。
      
      选择了这个边界之后，浏览器便把它放在Content-Type 里面传递给服务器，服务器根据此边界解析数据。下面的数据便根据boundary划分段，每一段便是一项数据。(每个field被分成小部分，而且包含一个value是"form-data"的"Content-Disposition"的头部；一个"name"属性对应field的ID,等等，文件的话包括一个filename)
      •IE和Chrome在filename的选择策略上有所不同，前者是文件的完整路径，而后者则仅仅是文件名。
      •数据内容以两条横线结尾，并同样以一个换行结束。在网络协议中一般都以连续的CR、LF（即\r、\n，或0x0D、Ox0A）字符作为换行，这与Windows的标准一致。如果您使用其他操作系统，则需要考虑它们的换行符。

2. 后台处理
   1. 使用multipart/form-data提交的数据使用HttpServletRequest对象的getParameter()等方法无法读取。可以读取整个请求体数据流自己解析数据。但更好的方式是使用已经有的第三方工具类，如fileupload，jspsmartupload。下面的例子中使用的是fileupload。

   2. HttpServletRequeest request=....
      if(ServletFileUpload.isMultipartContent(request))
      {
          FileItemFactory factory = new DiskFileItemFactory();
          ServletFileUpload upload = new ServletFileUpload(factory);
          List<FileItem> items = upload.parseRequest(request);
          for(FileItem i: items)
          {
              i.getFieldName();  　　//参数名
              //i.getString();   　　//参数值（返回字符串），如果是上传文件，则为文件内容
      　　　　 //i.get();         　　//参数值（返回字节数组），如果是上传文件，则为文件内容
      　　　　 //i.getSize();　　　　　//参数值的字节大小
      　　　　 //i.getName();   　 　 //上传文件的文件名
      　　　　 //i.getContentType();  //上传文件的内容类型
      　　　　 if(!i.isFormField()&&i.getSize()>)　　 //简单参数返回true，文件返回false
      　　　　　　Files.write(Paths.get("/upload/"+Paths.get(i.getName()).getFileName()), i.get());
      　　}
      }

3. SpringMVC处理Multipart方式

   1. MultipartResolver 用于处理文件上传，当收到请求时 DispatcherServlet 的 checkMultipart() 方法会调用 MultipartResolver 的 isMultipart() 方法判断请求中是否包含文件。如果请求数据中包含文件，则调用 MultipartResolver 的 resolveMultipart() 方法对请求的数据进行解析，然后将文件数据解析成 MultipartFile 并封装在 MultipartHttpServletRequest (继承了 HttpServletRequest) 对象中，最后传递给 Controller，在 MultipartResolver 接口中有如下方法：

      • boolean isMultipart(HttpServletRequest request); // 是否是 multipart
      • MultipartHttpServletRequest resolveMultipart(HttpServletRequest request); // 解析请求
      • void cleanupMultipart(MultipartHttpServletRequest request);

      MultipartFile 封装了请求数据中的文件，此时这个文件存储在内存中或临时的磁盘文件中，需要将其转存到一个合适的位置，因为请求结束后临时存储将被清空。在 MultipartFile 接口中有如下方法：

      • String getName(); // 获取参数的名称
      • String getOriginalFilename(); // 获取文件的原名称
      • String getContentType(); // 文件内容的类型
      • boolean isEmpty(); // 文件是否为空
      • long getSize(); // 文件大小
      • byte[] getBytes(); // 将文件内容以字节数组的形式返回
      • InputStream getInputStream(); // 将文件内容以输入流的形式返回
      • void transferTo(File dest); // 将文件内容传输到指定文件中
   2. MultipartResolver 是一个接口，它的实现类如下图所示，分为 CommonsMultipartResolver 类和 StandardServletMultipartResolver 类。
   3. 其中 CommonsMultipartResolver 使用 commons Fileupload 来处理 multipart 请求，所以在使用时，必须要引入相应的 jar 包；而 StandardServletMultipartResolver 是基于 Servlet 3.0来处理 multipart 请求的，所以不需要引用其他 jar 包，但是必须使用支持 Servlet 3.0的容器才可以，以tomcat为例，从 Tomcat 7.0.x的版本开始就支持 Servlet 3.0了。
   4. StandardServletMultipartResolver的使用方法
      1. 配置文件

         1. <bean id="multipartResolver" class="org.springframework.web.multipart.support.StandardServletMultipartResolver">
            </bean>
            
            这里并没有配置文件大小等参数，这些参数的配置在 web.xml 中
            
            <servlet>
                <servlet-name>springmvc</servlet-name>
                <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
                <init-param>
                    <param-name>contextConfigLocation</param-name>
                    <param-value>classpath:springmvc.xml</param-value>
                </init-param>
                <load-on-startup></load-on-startup>
                <multipart-config>
                    <!-- 临时文件的目录 -->
                    <location>d:/</location>
                    <!-- 上传文件最大2M -->
                    <max-file-size></max-file-size>
                    <!-- 上传文件整个请求不超过4M -->
                    <max-request-size></max-request-size>
                </multipart-config>
            </servlet>

      2. 上传表单

         1. <form action="${pageContext.request.contextPath}/test/file-upload.do" method="post" enctype="multipart/form-data">
                 <input type="file" name="file">
                 <input type="submit" value="提交">
            </form>

      3. 处理方式有两种
         1. 通过 MultipartFile 类型的参数处理

            1. @RequestMapping("/file-upload")
               public ModelAndView upload(@RequestParam(value = "file", required = false) MultipartFile file,
               　　　　　　HttpServletRequest request, HttpSession session) {
                   // 文件不为空
                   if(!file.isEmpty()) {
                       // 文件存放路径
                       String path = request.getServletContext().getRealPath("/");
                       // 文件名称
                       String name = String.valueOf(new Date().getTime()+"_"+file.getOriginalFilename());
                       File destFile = new File(path,name);
                       // 转存文件
                       try {
                           file.transferTo(destFile);
                       } catch (IllegalStateException | IOException e) {
                           e.printStackTrace();
                       }
                       // 访问的url
                       String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
               　　　　　　+ request.getContextPath() + "/" + name;
                   }
                   ModelAndView mv = new ModelAndView();
                   mv.setViewName("other/home");
                   return mv;
               }

         2. 通过 MultipartHttpServletRequest 类型的参数

            1. @RequestMapping("/file-upload")
               public ModelAndView upload(MultipartHttpServletRequest request, HttpSession session) {
                   // 根据页面input标签的name
                   MultipartFile file = request.getFile("file");
                   // 文件不为空
                   if(!file.isEmpty()) {
                       // 文件存放路径
                       String path = request.getServletContext().getRealPath("/");
                       // 文件名称
                       String name = String.valueOf(new Date().getTime()+"_"+file.getOriginalFilename());
                       File destFile = new File(path,name);
                       // 转存文件
                       try {
                           file.transferTo(destFile);
                       } catch (IllegalStateException | IOException e) {
                           e.printStackTrace();
                       }
                       // 访问的url
                       String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
               　　　　　　+ request.getContextPath() + "/" + name;
                   }
                   ModelAndView mv = new ModelAndView();
                   mv.setViewName("other/home");
                   return mv;
               }

   5. CommonsMultipartResolver的使用方法
      1. 配置文件

         1. <!-- 定义文件上传解析器 -->
            <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
                <!-- 设定默认编码 -->
                <property name="defaultEncoding" value="UTF-8"></property>
                <!-- 设定文件上传的最大值为5MB，** -->
                <property name="maxUploadSize" value=""></property>
                <!-- 设定文件上传时写入内存的最大值，如果小于这个参数不会生成临时文件，默认为10240 -->
                <property name="maxInMemorySize" value=""></property>
                <!-- 上传文件的临时路径 -->
                <property name="uploadTempDir" value="fileUpload/temp"></property>
                <!-- 延迟文件解析 -->
                <property name="resolveLazily" value="true"/>
            </bean>

      2. 上传表单

         1. <form action="${pageContext.request.contextPath}/test/file-upload.do" method="post" enctype="multipart/form-data">
                 <input type="file" name="file">
                 <input type="submit" value="提交">
            </form>

      3. 处理文件

         1. @RequestMapping("/file-upload")
            public ModelAndView upload(@RequestParam(value = "file", required = false) MultipartFile file,
            　　　　　　HttpServletRequest request, HttpSession session) {
                // 文件不为空
                if(!file.isEmpty()) {
                    // 文件存放路径
                    String path = request.getServletContext().getRealPath("/");
                    // 文件名称
                    String name = String.valueOf(new Date().getTime()+"_"+file.getOriginalFilename());
                    File destFile = new File(path,name);
                    // 转存文件
                    try {
                        file.transferTo(destFile);
                    } catch (IllegalStateException | IOException e) {
                        e.printStackTrace();
                    }
                    // 访问的url
                    String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
            　　　　　　+ request.getContextPath() + "/" + name;
                }
                ModelAndView mv = new ModelAndView();
                mv.setViewName("other/home");
                return mv;
            }