超详细的文件上传和下载(Spring Boot)

超详细的文件上传和下载

前言Ⅰ：@RequestParam和@RequestPart的区别

@RequestPart

• @RequestPart这个注解用在multipart/form-data表单提交请求的方法上。
• 支持的请求方法的方式MultipartFile，属于Spring的MultipartResolver类。这个请求是通过http协议传输的

@RequestParam

• @RequestParam支持application/json，也同样支持multipart/form-data请求

代码演示

• 测试一：使用@RequestPart接收json数据

  结论：@RequestPart可以将jsonData的json数据转换为Person对象

  /**
       * 测试 RequestParam 和 RequestPart区别2
       * @param person
       * @param file1
       * @return
       * @throws IOException
       * @throws ServletException
       */
  @RequestMapping(value = "/upload3",method = RequestMethod.POST)
  @ResponseBody
  public String readFile1(@RequestPart("person") Person person , @RequestPart("file1") MultipartFile file1)  {
      StringBuilder sb = new StringBuilder();
      sb.append(file1.getOriginalFilename()).append(";;;");
      return person.toString() + ":::" + sb.toString();
  }
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15

  参数名	参数值	参数类型
  file1	一个文件	file
  person	{“name”:“cvzhanshi”,“age”:23}	application/json

  测试结果：能够用对象去接收json

  

• 测试二：使用@RequestParam接收json数据

  结论：@RequestParam对于jsonData的json数据只能用String字符串来接收

  /**
       * 测试 RequestParam 和 RequestPart区别2
       * @param person
       * @param file1
       * @return
       * @throws IOException
       * @throws ServletException
       */
  @RequestMapping(value = "/upload3",method = RequestMethod.POST)
  @ResponseBody
  public String readFile1(@RequestParam("person") Person person , @RequestPart("file1") MultipartFile file1)  {
      StringBuilder sb = new StringBuilder();
      sb.append(file1.getOriginalFilename()).append(";;;");
      return person.toString() + ":::" + sb.toString();
  }
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15

​ 测试结果：报错 2022-10-08 10:19:48.434 WARN 3440 — [nio-8888-exec-1] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.method.annotation.MethodArgumentConversionNotSupportedException: Failed to convert value of type ‘java.lang.String’ to required type ‘cn.cvzhanshi.test.entity.Person’; nested exception is java.lang.IllegalStateException: Cannot convert value of type ‘java.lang.String’ to required type ‘cn.cvzhanshi.test.entity.Person’: no matching editors or conversion strategy found]

报错说明：只能接收解析String类型的

区别(总结)

• 当请求为multipart/form-data时，@RequestParam只能接收String类型的name-value值，@RequestPart可以接收复杂的请求域（像json、xml）
• @RequestParam 依赖Converter or PropertyEditor进行数据解析， @RequestPart参考'Content-Type' header，依赖HttpMessageConverters进行数据解析
• 当请求头中指定Content-Type:multipart/form-data时，传递的json参数，@RequestPart注解可以用对象来接收，@RequestParam只能用字符串接收
• @RequestParam适用于name-valueString类型的请求域，@RequestPart适用于复杂的请求域（像JSON，XML）；他们最大的不同是，当请求方法的请求参数类型不再是String类型的时候

前言Ⅱ：getParameter() 和 getPart() 区别

代码测试

/**
     * 测试 RequestParam 和 RequestPart区别1
     * @param request
     * @param name
     * @param file1
     * @return
     * @throws IOException
     * @throws ServletException
     */
@RequestMapping(value = "/upload1",method = RequestMethod.POST)
@ResponseBody
public String readFile(HttpServletRequest request,@RequestParam("name") String name ,@RequestPart("file1") MultipartFile file1) throws IOException, ServletException {

    String ageParameter = request.getParameter("age");
    Part agePart = request.getPart("age");

    String file2Parameter = request.getParameter("file2");
    Part file2Part = request.getPart("file2");

    Enumeration<String> parameterNames = request.getParameterNames();
    Collection<Part> parts = request.getParts();
    return "";
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

传递参数

DeBug分析：

• request：可以看到request有两个 Parameter 和 两个 Part 参数

  

• Parameter和Part：request.getParameter获得的值以及request.getPart获得的值

  

  结果发现：使用 request.getParameter() 获取文件类型参数为空，使用 request.getPart() 获取非文件类型为空

• ParameterNames和Parts：getParameterNames()和getParts()获取参数名

  

  

  结果：使用 request.getParameterNames() 只能获取非文件类型的参数名, 使用 request.getParts() 可以获取全部参数名

结论

• Part 能获取所有的请求参数的参数名，而 Parameter 只能获取非文件类型的参数名
• Part 不能获得非文件类型参数的参数值，Part获得二进制的输入流
• Parameter 只能获得非文件类型参数值
• 使用 Part 获取文件很方便，可以获取文件大小文件类型

Ⅰ：文件上传

① form-data 类型上传

form-data 类型即常用的表单提交，可以通过两种方式接收前端传过来的文件

• 通过上述讲的Part 接收字节流，即@RequestPart注解以及request.getParts()
• 通过MultipartFile类来接收前端传过来的文件

说明：两种方法差不多

前端接口提交

上传文件的后端代码（接口）

/**
     * form-data 类型(前端表单上传)
     * @param request
     * @param name
     * @param file3
     * @param photo
     * @return
     * @throws IOException
     * @throws ServletException
     */
@RequestMapping(value = "/upload", method = RequestMethod.POST)
@ResponseBody
public String readFile(HttpServletRequest request,
                       @RequestParam("name") String name,
                       @RequestPart("file1") MultipartFile file3,
                       @RequestPart("photo") MultipartFile photo
                      ) throws IOException, ServletException {



    System.out.println(name);
    /*
            第一种 ： 使用 MultipartFile 封装好的 transferTo() 方法保存文件
            photo.transferTo(new File(path + photo.getOriginalFilename()));
         */
    /*
            第二种 ：  使用 MultipartFile 字节流保存文件
            fileUtil(file3, String.valueOf(path));
         */


    /*第三种 ：用 Part 接收文件字节流
            Part file2 = request.getPart("file2");
            file2.write(path + file2.getSubmittedFileName());
            request.getParts() 获取的是全部参数（name,age,file1,file2），包括文件参数和非文件参数
		 */
    for (Part part : request.getParts()) {
        // 获取文件类型
        part.getContentType();
        // 获取文件大小
        part.getSize();
        // 获取文件名
        part.getSubmittedFileName();
        // 获取参数名 （name,age,file1,file2）
        part.getName();
        if(part.getContentType()!=null){
            part.write(path + part.getSubmittedFileName());
        }else{
            // 可以获取文本参数值,文本参数 part.getContentType()为 null
            System.out.println(request.getParameter(part.getName()));
        }
    }
    return "success";
}


/**
     * 字节流上传文件工具方法
     * @param file
     * @param path
     * @return
     */
public String fileUtil(MultipartFile file, String path) {
    if (!file.isEmpty()) {
        try {
            // 转化成字节流
            byte[] bytes = file.getBytes();
            bufferedOutputStream = new BufferedOutputStream(new FileOutputStream(
                new File(path + file.getOriginalFilename())));
            // 写出
            bufferedOutputStream.write(bytes);
            // 关闭资源
            bufferedOutputStream.close();
            return file.getOriginalFilename() + " 上传成功";
        } catch (Exception e) {
            return file.getOriginalFilename() + " failed to upload ---> " + e;
        }
    } else {
        return file.getOriginalFilename() + "You failed to upload file was empty.";
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

测试

② binary 类型上传

binary 这一类型，指的就是一些二进制文件类型，如application/pdf，指定了特定二进制文件的MIME类型。就像对于text文件类型若没有特定的子类型

（subtype），就使用 text/plain。类似的，二进制文件没有特定或已知的 subtype，即使用 application/octet-stream，这是应用程序文件的默认值。

对于application/octet-stream，只能提交二进制，而且只能提交一个二进制，如果提交文件的话，只能提交一个文件，后台接收参数只能有一个，而且只能是流

（或者字节数组）

前端接口提交

上传文件的后端代码（接口）

/**
     * binary 类型上传
     * @param request
     * @return
     * @throws IOException
     */
@RequestMapping(value = "/upload2",method = RequestMethod.POST)
public String upload2(HttpServletRequest request) throws IOException {
    ServletInputStream inputStream = null;
    FileOutputStream fileOutputStream = null;
    try {
        // 获取上传的文件流
        inputStream = request.getInputStream();
        // 定义输出流 上传到哪里
        fileOutputStream = new FileOutputStream(new File(path + "a.pdf"));

        int len;
        byte[] bytes = new byte[1024];
        while((len = inputStream.read(bytes))!=-1){
            fileOutputStream.write(bytes,0,len);
        }
    } catch (IOException e) {
        e.printStackTrace();
        return "上传失败";
    } finally {
        // 关闭资源
        if(fileOutputStream!=null){
            fileOutputStream.close();
        }
        if(inputStream!=null){
            inputStream.close();
        }
    }
    return "上传成功";
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

测试

说明：part 使用起来比较方便，接受的就是字节流，读取文件类型，文件名，文件大小也比较方便

③ 配置说明

如果不自定义配置的话，他会默认上传大小1M\

SpringBoot项目的话通过配置文件配置

server:
  port: 8888
spring:
  servlet:
    multipart:
      max-file-size: 10MB   # 最大上传大小
      max-request-size: 100MB   # 单文件最大上传大小 
1
2
3
4
5
6
7

Ⅱ：文件下载

① 补充说明

Content-Disposition

• 在常规的 HTTP 应答中，Content-Disposition 响应头指示回复的内容该以何种形式展示，是以内联的形式（即网页或者页面的一部分），还是以附件的形式下载并保存到本地
• 在 multipart/form-data 类型的应答消息体中，Content-Disposition 消息头可以被用在 multipart 消息体的子部分中，用来给出其对应字段的相关信息。各个子部分由在Content-Type 中定义的分隔符分隔。用在消息体自身则无实际意义。

语法：

• 作为消息主体中的消息头：在 HTTP 场景中，第一个参数或者是 inline（默认值，表示回复中的消息体会以页面的一部分或者整个页面的形式展示），或者是 attachment（意味着消息体应该被下载到本地；大多数浏览器会呈现一个“保存为”的对话框，将 filename 的值预填为下载后的文件名，假如它存在的话）。

  Content-Disposition: inline
  Content-Disposition: attachment
  Content-Disposition: attachment; filename="filename.jpg"
  1
  2
  3

• 作为 multipart body 中的消息头：在 HTTP 场景中。第一个参数总是固定不变的 form-data；附加的参数不区分大小写，并且拥有参数值，参数名与参数值用等号 ('=') 连接，参数值用双引号括起来。参数之间用分号 (';') 分隔。

  Content-Disposition: form-data
  Content-Disposition: form-data; name="fieldName"
  Content-Disposition: form-data; name="fieldName"; filename="filename.jpg"
  1
  2
  3

response.setContentType()的String参数及对应类型

② 下载本地资源

下载代码

/**
     * 下载本地资源
     * @param fileName  下载的文件名
     * @param response  响应头
     * @param isOnLine  是否默认下载  true浏览器中打开
     * @throws IOException
     */
@GetMapping("/download")
public void download(String fileName, HttpServletResponse response, boolean isOnLine) throws IOException {
    // 路径可以指定当前项目相对路径
    File file = new File(path + fileName);
    if (file.exists()) {
        // 把文件转化成流
        FileInputStream fileInputStream = new FileInputStream(file);
        ServletOutputStream outputStream = response.getOutputStream();
        // 是否立即下载
        if(!isOnLine){
            response.setContentType("application/octet-stream");
            // 如果文件名为中文需要设置编码
            response.setHeader("Content-Disposition", "attachment;fileName=" + URLEncoder.encode("背景.jpg", "utf8"));
        }
        byte[] bytes = new byte[1024];
        int len;
        // 把文件流写入响应头
        while ((len = fileInputStream.read(bytes)) != -1) {
            outputStream.write(bytes, 0, len);
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

测试链接：http://localhost:8888/download?fileName=背景.jpg

​ 或者http://localhost:8888/download?isOnLine=true&fileName=背景.jpg

③ 下载网络资源

代码演示

说明：首先要获取到正确的url才能获取到想要的资源

/**
     * 下载网络资源
     * @param response
     * @throws IOException
     */
@RequestMapping("/downLoadMusic")
public void downloadNetworkFile(HttpServletResponse response) throws IOException {
    // 创建url对象
    URL url = new URL("https://m701.music.126.net/20221009103058/70acd1fa2256e82ae0a90f833aec1072/jdyyaac/obj/w5rDlsOJwrLDjj7CmsOj/18195365565/53a1/ad15/9e1c/1b3457995065a152f56f61c38eda1914.m4a");
    // 建立连接
    URLConnection urlConnection = url.openConnection();
    // 获取到输入流
    InputStream inputStream = urlConnection.getInputStream();
    // 获取到响应头的输出流
    ServletOutputStream outputStream = response.getOutputStream();
    // 设置响应头
    response.setContentType("application/octet-stream");
    response.setHeader("Content-Disposition","attachment;fileName=" + URLEncoder.encode("爱似水仙.m4a", "utf8"));
    int len;
    // 通过字节流下载下来
    byte[] bytes = new byte[1024];
    while ((len = inputStream.read(bytes)) != -1){
        outputStream.write(bytes,0, len);
    }
    // 关闭资源
    inputStream.close();
    outputStream.close();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

测试链接：http://localhost:8888/downLoadMusic

参考文章1

参考文章2