IT俱乐部 Java SpringBoot文件上传与下载功能实现详解

SpringBoot文件上传与下载功能实现详解

前言

文件上传与下载是Web应用开发中常用的功能之一,在实际的Web应用开发中,为了成功上传文件,必须将表单的method设置为post,并将enctype设置为multipart/form-data 只有这样设置,浏览器才能将所选文件的二进制数据发送给服务器

从Servlet3.0开始,就提供了处理文件上传的方法,但这种文件上传需要在Java Servlet中完成,而Spring MVC提供了更简单的封装。Spring MVC是通过Apache Commons FileUpload技术实现一个MultipartResolver的实现类CommonsMultipartResovler完成文件上传的。因此,Spring MVC的文件上传需要依赖Apache Commons FileUpload组件

Spring MVC将上传文件自动绑定到MultipartFile对象中,MultipartFile提供了获取上传文件内容,文件名等方法。并通过transferTo方法将文件上传到服务器的磁盘中,MultipartFile常用方法如下

byte[]getBytes() 获取文件数据

String getContentType() 获取文件MIME类型

InputStream getInputStream() 获取表单中文件组件的名字

String getName() 获取表单中文件组件的名字

String getOriginalFilename() 获取上传文件的原名

long getSize() 获取文件的字节大小

boolean isEmpty() 是否有选择上传文件

void transferTo() 将上传文件保存到一个目标文件中

Spring Boot的spring-boot-starter-web已经集成了Spring MVC 所以使用Spring Boot实现文件上传更加敏捷,只需引入Apache Commons FileUpload组件依赖即可

下面通过一个实例来加深理解

操作步骤如下

1、引入Apache Commons FileUpload组件依赖

在Web应用的ch5_2的pom.xml文件中 添加Apache Commons FileUpload组件依赖 代码如下

1
2
3
4
5
6
7
8
9
10
11
-4.0.0
-org.springframework.bootspring-boot-starter-parent2.1.5.RELEASEcom.chch5_20.0.1-SNAPSHOTch5_2Demo project for Spring Boot
-11
-
-commons-fileuploadcommons-fileupload1.3.3
-org.springframework.bootspring-boot-starter-thymeleaf
-org.springframework.bootspring-boot-starter-web
-org.springframework.bootspring-boot-starter-testtest
-
-
-org.springframework.bootspring-boot-maven-plugin

2、设置上传文件大小限制

在Web应用的ch5_2的配置文件application。properties中 添加如下配置限制上传文件大小

server.servlet.context-path=/ch5_2
#上传文件时,默认单个上传文件大小是1MB,max-file-size设置单个上传文件大小
spring.servlet.multipart.max-file-size=50MB
#默认总文件大小是10MB,max-request-size设置总上传文件大小
spring.servlet.multipart.max-request-size=500MB

3、创建选择文件视图页面

在ch5_2应用的src/main/resources/templates目录下 创建选择文件视图页面uploadFile.html 该页面中有一个enctype属性值为multipart/form-data的form表单 部分代码如下

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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<title>Insert title here</title><div class="panel panel-primary">
        <div class="panel-heading">
            <h3 class="panel-title">文件上传示例</h3>
        </div>
    </div>
    <div class="container">
        <div class="row">
            <div class="col-md-6 col-sm-6">
                 
                    <div class="form-group">
                        <div class="input-group col-md-6">
                            <span class="input-group-addon">
                                <i class="glyphicon glyphicon-pencil"></i>
                            </span>
                             
</div>
        </div>
     
</div>
 
</div>
<p class="maodian"><a name="_label4"></a></p>
<h2>4、创建控制器</h2>
<p>在ch5_2应用的com.ch.ch5_2.controller包中 创建控制器类TestFileUpload 在该类中有4个处理方法一个是界面导航方法,uploadfile 一个是实现文件上传的upload方法,一个是显示将要被下载文件的showDownLoad 方法,一个是实现下载功能的download方法 部分代码如下</p>
<div class="jb51code"><pre class="brush:java;">package com.ch.ch5_2.controller;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.io.FileUtils;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.ResponseEntity.BodyBuilder;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;
@Controller
public class TestFileUpload {
    /**
     * 进入文件选择页面
     */
    @RequestMapping("/uploadFile")
    public String uploadFile() {
        return "uploadFile";
    }
    /**
     * 上传文件自动绑定到MultipartFile对象中,
     * 在这里使用处理方法的形参接收请求参数。
     * @throws IOException
     * @throws IllegalStateException
     */
    @RequestMapping("/upload")
    public String upload(
            HttpServletRequest request,
            @RequestParam("description") String description,
            @RequestParam("myfile") MultipartFile myfile) throws IllegalStateException, IOException {
        System.out.println("文件描述:" + description);
        //如果选择了上传文件,将文件上传到指定的目录uploadFiles
        if(!myfile.isEmpty()) {
            //上传文件路径
            String path = request.getServletContext().getRealPath("/uploadFiles/");
            //获得上传文件原名
            String fileName = myfile.getOriginalFilename();
    }
    /**
     * 实现下载功能
     * @throws IOException
     */
    @RequestMapping("/download")
    public ResponseEntity download(
            HttpServletRequest request,
            @RequestParam("filename") String filename,
            @RequestHeader("User-Agent") String userAgent) throws IOException {
        //下载文件路径
        String path = request.getServletContext().getRealPath("/uploadFiles/");
        //构建将要下载的文件对象
        File downFile = new File(path + File.separator + filename);
        //ok表示HTTP中的状态是200
        BodyBuilder builder =  ResponseEntity.ok();
        //内容长度
        builder.contentLength(downFile.length());
        //application/octet-stream:二进制流数据(最常见的文件下载)
        builder.contentType(MediaType.APPLICATION_OCTET_STREAM);
        //使用URLEncoder.encode对文件名进行编码
        filename = URLEncoder.encode(filename,"UTF-8");
        /**
         * 设置实际的响应文件名,告诉浏览器文件要用于“下载”和“保存”。
         * 不同的浏览器,处理方式不同,根据浏览器的实际情况区别对待。
         */
        if(userAgent.indexOf("MSIE") > 0) {
            //IE浏览器,只需要用UTF-8字符集进行URL编码
            builder.header("Content-Disposition", "attachment; filename=" + filename);
        }else {
            /**非IE浏览器,如FireFox、Chrome等浏览器,则需要说明编码的字符集
             * filename后面有个*号,在UTF-8后面有两个单引号
             */
            builder.header("Content-Disposition", "attachment; filename*=UTF-8''" + filename);
        }
        return builder.body(FileUtils.readFileToByteArray(downFile));
    }
}</pre>
</div>
<p class="maodian"><a name="_label5"></a></p>
<h2>5、创建文件下载视图页面</h2>
<p>创建视图页面showFile.html</p>
<div class="jb51code">
<pre class="brush:xhtml;">
 
<title>Insert t
                </title></pre>
</div></div>
<p></p>
本文收集自网络,不代表IT俱乐部立场,转载请注明出处。https://www.2it.club/code/java/6504.html
上一篇
下一篇
联系我们

联系我们

在线咨询: QQ交谈

邮箱: 1120393934@qq.com

工作时间:周一至周五,9:00-17:30,节假日休息

关注微信
微信扫一扫关注我们

微信扫一扫关注我们

返回顶部