Spring文件上传接口学习(MultipartFile,MultiparHttpservletRequest,MultipartResolver)

原文链接：https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/multipart/MultipartFile.html

公司的文件上传基于MongoDB写的文件服务，上传文件解析数据出了问题，搞得焦头烂额的，所以整理学习。

摘一句：在我看来，春天里一颗小草的生长，它没有什么目的。风起时一匹公马发情，它也没有什么目的...我要抱着草长马发情的伟大真诚去做一切事，而不是在人前羞羞答答的表演。 ——《三十而立》

文件上传接口理论整理：

• MultiparHttpservletRequest :提供其他方法来处理servlet请求中的多部分内容，从而允许访问上载的文件。实现还需要覆盖ServletRequest用于参数访问的标准 方法，以使多部分参数可用。

 public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) {
   MultipartHttpServletRequest multipartRequest = (MultipartHttpServletRequest) request;
   MultipartFile multipartFile = multipartRequest.getFile("image");
   ...
 }

---

具体实现是 DefaultMultipartHttpServletRequest作为中间步骤， AbstractMultipartHttpServletRequest可以进行子类化。

---

+DefaultMultipartHttpServletRequest：MultipartHttpServletRequest 接口的默认实现 。提供预生成参数值的管理。由使用CommonsMultipartResolver。

public class DefaultMultipartHttpServletRequest
extends AbstractMultipartHttpServletRequest

构造函数	描述
DefaultMultipartHttpServletRequest(HttpServletRequest request)	将给定的HttpServletRequest包装在MultipartHttpServletRequest中。
DefaultMultipartHttpServletRequest(HttpServletRequest request, MultiValueMap<String,MultipartFile> mpFiles, Map<String,String[]> mpParams, Map<String,String> mpParamContentTypes)	将给定的HttpServletRequest包装在MultipartHttpServletRequest中。

---

方法	说明
String getMultipartContentType(String paramOrFileName)	确定指定请求部分的内容类型。
HttpHeaders getMultipartHeaders(String paramOrFileName)	返回与multipart请求的指定部分关联的标头。
protected Map<String,String> getMultipartParameterContentTypes()	获取用于检索的多部分参数内容类型Map，如有必要，请对其进行延迟初始化。
protected Map<String,String[]> getMultipartParameters()	获取要检索的多部分参数Map，如有必要，请对其进行延迟初始化。
String getParameter(String name)	此方法的默认行为是在包装的请求对象上返回getParameter（String name）。
Map<String,String[]> getParameterMap()	此方法的默认行为是在包装的请求对象上返回getParameterMap（）。
Enumeration getParameterNames()	此方法的默认行为是在包装的请求对象上返回getParameterNames（）。
String[] getParameterValues(String name)	此方法的默认行为是在包装的请求对象上返回getParameterValues（String name）。
protected void setMultipartParameterContentTypes(Map<String,String> multipartParameterContentTypes)	设置一个映射，将参数名称作为键，将内容类型字符串作为值。
protected void setMultipartParameters(Map<String,String[]> multipartParameters)	设置一个映射，将参数名称作为键，将字符串数组对象作为值。
String getMultipartContentType(String paramOrFileName)	确定指定请求部分的内容类型。
HttpHeaders getMultipartHeaders(String paramOrFileName)	返回与multipart请求的指定部分关联的标头。
protected Map<String,String> getMultipartParameterContentTypes()	获取用于检索的多部分参数内容类型Map，如有必要，请对其进行延迟初始化。
protected Map<String,String[]> getMultipartParameters()	获取要检索的多部分参数Map，如有必要，请对其进行延迟初始化。
String getParameter(String name)	此方法的默认行为是在包装的请求对象上返回getParameter（String name）。
Map<String,String[]> getParameterMap()	此方法的默认行为是在包装的请求对象上返回getParameterMap（）。
Enumeration getParameterNames()	此方法的默认行为是在包装的请求对象上返回getParameterNames（）。
String[] getParameterValues(String name)	此方法的默认行为是在包装的请求对象上返回getParameterValues（String name）。
protected void setMultipartParameterContentTypes(Map<String,String> multipartParameterContentTypes)	设置一个映射，将参数名称作为键，将内容类型字符串作为值。
protected void setMultipartParameters(Map<String,String[]> multipartParameters)	设置一个映射，将参数名称作为键，将字符串数组对象作为值。

---

• AbstractMultipartHttpServletRequest:MultipartHttpServletRequest接口的抽象基础实现。提供对预生成的MultipartFile实例的管理。

public abstract class AbstractMultipartHttpServletRequest
extends HttpServletRequestWrapper
implements MultipartHttpServletRequest

修饰符	构造函数和描述
protected AbstractMultipartHttpServletRequest(HttpServletRequest request)	将给定的HttpServletRequest包装在MultipartHttpServletRequest中。

---

修饰符和类型	方法和说明
MultipartFile getFile(String name)	返回此请求中的内容以及上载文件的描述，或者null如果不存在，则返回描述。
Map<String,MultipartFile> getFileMap()	返回Map此请求中包含的多部分文件。
Iterator getFileNames()	返回一个IteratorString对象，其中包含此请求中包含的多部分文件的参数名称。
List getFiles(String name)	返回此请求中的内容以及上载文件的描述，如果不存在，则返回一个空列表。
MultiValueMap<String,MultipartFile> getMultiFileMap()	返回MultiValueMap此请求中包含的多部分文件。
protected MultiValueMap<String,MultipartFile> getMultipartFiles()	获取要检索的MultipartFile映射，并在必要时延迟对其进行初始化。
HttpServletRequest getRequest()	返回包装的请求对象。
HttpHeaders getRequestHeaders()	以方便的HttpHeaders实例的形式返回此请求的标头。
HttpMethod getRequestMethod()	以方便的HttpMethod实例的形式返回此请求的方法。
protected void initializeMultipart()	如果可能，延迟初始化多部分请求。
boolean isResolved()	确定基础的多部分请求是否已解决。
protected void setMultipartFiles(MultiValueMap<String,MultipartFile> multipartFiles)	设置一个映射，将参数名称作为键，将MultipartFile对象的列表作为值。

---

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

Spring没有默认的解析器实现 DispatcherServlets，因为应用程序可能会选择自行解析其多部分请求。要定义实现，请在DispatcherServlet’s 应用程序上下文中创建一个ID为“ multipartResolver”的bean 。这样的解析器将应用到该解析器处理的所有请求DispatcherServlet。
如果a DispatcherServlet检测到多部分请求，它将通过已配置解析该请求MultipartResolver 并传递包装的HttpServletRequest。然后，控制器可以将给定的请求转换为MultipartHttpServletRequest 接口，从而可以访问any MultipartFiles。请注意，仅在实际的多部分请求的情况下才支持此转换。几乎不需要MultipartResolver 从应用程序代码访问自身。它只会在后台进行工作，MultipartHttpServletRequests 提供给控制器。

---

• MultipartFile:多部分请求中收到的上载文件的表示形式。文件内容要么存储在内存中，要么临时存储在磁盘上。在这两种情况下，用户都有责任根据需要将文件内容复制到会话级或持久性存储中。临时存储将在请求处理结束时清除。

方法	说明
byte[] getBytes()	以字节数组形式返回文件的内容。
String getContentType()	返回文件的内容类型。
InputStream getInputStream()	返回一个InputStream，以从中读取文件的内容。
String getName()	以多部分形式返回参数名称。
String getOriginalFilename()	返回客户端文件系统中的原始文件名。
default Resource getResource()	返回此MultipartFile的资源表示形式。
long getSize()	返回文件的大小（以字节为单位）。
boolean isEmpty()	返回上载的文件是否为空，即，是否没有以多部分形式选择文件或选择的文件没有内容。
void transferTo(File dest)	将收到的文件传输到给定的目标文件。
default void transferTo(Path dest)	将收到的文件传输到给定的目标文件。

Demo

package com.example.demo.fileup;
 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.util.FileCopyUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.multipart.MultipartFile;
 
 
import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.*;
 
/**
 * @Description :
 * @Author: Liruilong
 * @Date: 2019/10/4 12:12
 */
@Controller
public class fileupController {
 
    @Value("${file.path}")
    private String filePath;
 
    @ResponseBody
    @RequestMapping("/upfile")
    public String upfile(MultipartFile multipartFile) throws IOException {
        if (multipartFile.isEmpty()){
            System.out.println("没有传入数据");
        }
        String filenamefix = multipartFile.getOriginalFilename().substring(multipartFile.getOriginalFilename().lastIndexOf("."));
        String newFile = UUID.randomUUID().toString() + filenamefix;
        FileCopyUtils.copy(multipartFile.getInputStream(),new FileOutputStream(new File(filePath+newFile)));
        return "文件已经上传啦!!!";
    }
    // 分文件夹存取
    SimpleDateFormat sdf = new SimpleDateFormat("/yyyy/MM/dd/");
    @ResponseBody
    @PostMapping("/upload")
    public String upload(MultipartFile multipartFile, HttpServletRequest request) throws IOException {
        // 将文件存入指定的文件夹
        String format = sdf.format(new Date());
        String realPath = request.getServletContext().getRealPath("/img") + format;
        // 创建文件存放路径
        File folder = new File(realPath);
        folder.mkdir();
        if (!folder.exists()){
            folder.mkdirs();
        }
        String oldName = multipartFile.getOriginalFilename();
        String newName = UUID.randomUUID().toString() + oldName.substring(oldName.lastIndexOf("."));
        // 将文件移动到指定的文件夹.
        File file = new File(folder,newName);
        System.out.println(file.getName());
        multipartFile.transferTo(new File(folder, newName));
        return newName;
    }
 
    // 多文件上传
    @ResponseBody
    @PostMapping("/uploads")
    public String uploads(MultipartFile[] multipartFiles,HttpServletRequest request){
        // 创建文件路径
        String fommad = sdf.format(new Date());
        String filepath = request.getServletContext().getRealPath("/img") + fommad;
        File file = new File(filepath);
        if (!file.exists()){
            file.mkdirs();
        }
        Arrays.stream(multipartFiles).forEach(
                (MultipartFile multipart) ->{
                    String filename = multipart.getOriginalFilename();
                    String newName = UUID.randomUUID().toString() + filename.substring(filename.lastIndexOf("."));
                    try {
                        multipart.transferTo(new File(file, newName));
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
        );
        return "上传成功";
    }
}

//UUID.randomUUID().toString()是javaJDK提供的一个自动生成主键的方法。UUID(Universally Unique Identifier)全局唯一标识符,
// 是指在一台机器上生成的数字，它保证对在同一时空中的所有机器都是唯一的，是由一个十六位的数字组成,表现出来的形式。
// 由以下几部分的组合：当前日期和时间(UUID的第一个部分与时间有关，如果你在生成一个UUID之后，过几秒又生成一个UUID，则第一个部分不同，其余相同)，
// 时钟序列，全局唯一的IEEE机器识别号（如果有网卡，从网卡获得，没有网卡以其他方式获得），UUID的唯一缺陷在于生成的结果串会比较长。

/**
	 * <per>
	 * <p>上传文件</p>
	 * <per/>
	 *
	 * @param request
	 * @param response
	 * @param isUseGridFS
	 * @return java.lang.Object
	 * @throws
	 * @Description : TODO 上传文件
	 * @author Liruilong
	 * @Date 2020/9/17 12:42
	 **/
public Object uploadFile(DefaultMultipartHttpServletRequest request,
			HttpServletResponse response, boolean isUseGridFS) throws Exception {
		//获取用户设置的参数
		Map<String, String[]> params = request.getParameterMap();
		/*********说明是断点续传************/
		String range = request.getHeader("RANGE");
		if(StringUtils.isNotBlank(range)){
			return uploadPointFile(request, response);
		}
		Iterator<String> uriFileNames = request.getFileMap().keySet().iterator();
		//遍历记录文件信息，并保存文件
		String urifileName = "";
		while (uriFileNames.hasNext()) {
			urifileName = uriFileNames.next();
			List<MultipartFile> mfiles = request.getFiles(urifileName);
			for(MultipartFile mFile : mfiles){