Servlet 与 Spring MVC上传文件

悠悠 2022-03-22 04:46 178阅读 0赞

## Servlet 与 Spring MVC上传文件 ##

在写web项目的时候，难免会有前端向后台发送文件数据的情况，我们知道：通常我们用form表单向后端发送请求数据并得到响应(比如上传头像)。form表单中input标签有一个参数type，里面有个值是file，是不是我们只需要修改这里，就可以直接向后端发送文件数据了呢?答案是不对，我们先来看我们应该怎样写这个form表单

我们可以注意到，在form标签中，有一个：enctype=“multipart/form-data” ，这句话的作用是什么呢？  
我们先来看一下enctype中的三个选项分别代表什么

<table> 
 <thead> 
  <tr> 
   <th>值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>application/x-www-form-urlencoded</td> 
   <td>在发送前编码所有字符（默认）</td> 
  </tr> 
  <tr> 
   <td>multipart/form-data</td> 
   <td>不对字符编码。在使用包含文件上传控件的表单时，必须使用该值。</td> 
  </tr> 
  <tr> 
   <td>text/plain</td> 
   <td>空格转换为 “+” 加号，但不对特殊字符编码。</td> 
  </tr> 
 </tbody> 
</table>

其中表单中enctype="multipart/form-data"的意思，是设置表单的MIME编码，是类上传二进制数据方式， 所以form里面的input的值以二进制的方式传过去的。

而 multipart/form-data 是组合post请求方式发送的，但其与普通的post请求有两处区别

*  1 . 请求头：multipart/form-data的请求头必须包含一个特殊的头信息：Content-Type，其值也必须为multipart/form-data，同时还需要规定一个内容分割用于分割请求提中多个post的内容，如文件内容和文本内容是需要分隔开来的，不然接收方就无法解析和还原这个文件了，具体的头信息如下：

![在这里插入图片描述][20190125232549274.png]  
除了这个Content-Type，旁边的boundary是一个占位符，代表上传文件时请求体中规定的分割符，由于有boundary隔离，所以multipart/form-data既可以上传文件，也可以上传键值对，它采用了键值对的方式，所以可以上传多个文件。

前端的form表单就应该是上面的写法。下面我们来看后端的写法。  
首先我们必须要导入Apache的commons-io和commons-fileupload两个依赖  
如果使用servlet的话，我们要写这样一个servlet

@WebServlet(name = "UploadFileServlet",urlPatterns = {"/upload"})
    public class UploadFileServlet extends HttpServlet {
        @Override
        protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            req.setCharacterEncoding("utf-8");
            resp.setContentType("text/html;charset=utf-8");
            String rootPath = req.getSession().getServletContext().getRealPath("/web/image");
    
            File filePath = new File(rootPath);
            if (!filePath.exists()) {
                filePath.mkdirs();
            }
    
    		//获取对应的请求数据
            DiskFileItemFactory factory = new DiskFileItemFactory();
            ServletFileUpload upload = new ServletFileUpload(factory);
            List items = null;
            try {
                items = upload.parseRequest(req);
            } catch (FileUploadException e) {
                e.printStackTrace();
            }
            Iterator iter = items.iterator();
            while (iter.hasNext()) {
                FileItem item = (FileItem)iter.next();
                if (item.isFormField()) {
                	//对普通的key-value数据进行处理
                    String fieldName = item.getFieldName();
                    String value = item.getString();
                    req.setAttribute(fieldName,value);
                } else {
                	//获取文件数据并保存
                    StringBuilder fileName = new StringBuilder(item.getName());
                    fileName.insert(fileName.indexOf("."),System.currentTimeMillis());
                    System.out.println(fileName);
    
                    File image = new File(rootPath,new String(fileName));
    
                    InputStream is = item.getInputStream();
                    OutputStream os = new FileOutputStream(image);
                    byte[] buf = new byte[1024];
                    int read;
                    while ((read = is.read(buf)) > 0) {
                        os.write(buf,0,read);
                    }
    
                    System.out.println(req.getRequestURL());
                    System.out.println(req.getPathInfo());
                    int endIndex = 0;
                    if (req.getPathInfo() != null) {
                        endIndex = req.getRequestURL().length() - req.getPathInfo().length() - 8;
                    } else {
                        endIndex = req.getRequestURL().length() - 7;
                    }
    
                    String url = req.getRequestURL().substring(0, endIndex);
    				//返回文件对应url
                    resp.getWriter().write( "{\"success\": 1, \"message\":\"上传成功\",\"url\":\" "+ url
                            + req.getSession().getServletContext().getContextPath()+"/web/image/" + image.getName() + "\"}");
                }
            }
        }
    }

上面用到了DiskFileItemFactory这个类，并且写法较为繁琐，所以我们尽量使用spring mvc去处理

首先，我们需要在spring mvc的配置文件(即dispatcher-servlet.xml)中加入这样的配置

<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
            
            <property name="maxUploadSize" value="10485760"/> 
            <property name="maxInMemorySize" value="4096" />
            <property name="defaultEncoding" value="UTF-8"></property>
        </bean>

然后我们就可以在自己的controller中写这样的方法

@RequestMapping(value = "/upload.do")
        @ResponseBody
        public ServerResponse upload(@RequestParam(value = "upload_file", required = false) MultipartFile file, 
        		HttpServletRequest request) {
                
                String path = request.getSession().getServletContext().getRealPath("upload");
                String targetFileName = iFileService.upload(file,path);
                String url = PropertiesUtil.getProperty("ftp.server.http.prefix") + targetFileName;
    
                Map fileMap = Maps.newHashMap();
                fileMap.put("uri",targetFileName);
                fileMap.put("url",url);
                return ServerResponse.createBySuccess(fileMap);
        }

我们可以看到，在指定方法中有一个MultipartFile对象的参数，我们可以直接使用这个参数，只需要通过@RequestParam注解指定参数在表单中的name。

下面是MultipartFile接口的一些方法：

byte[] getBytes()				//以字节数组的形式返回文件中的内容
    String getContentType()		//返回文件的内容类型
    InputStream getInputStream()	//返回一个InputStream，从中读取文件的内容
    String getName()		//以多部分形式返回参数的名称
    String getOriginalFilename()		//返回客户端本地驱动器中的初始文件名
    long getSize()		//以字节为单位，返回文件的大小
    boolean isEmpty()		//判断被上传的文件是否为空
    void transferTo()		//将上传的文件保存到目标目录下

[20190125232549274.png]: /images/20220322/0ebbb314f9714758a9d0f33569a03e50.png