Spring Boot的文件上传与下载
Posted nuist__NJUPT
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Boot的文件上传与下载相关的知识，希望对你有一定的参考价值。
SpringBoot的文件上传与下载
文件上传和下载是Web开发应用中最常用的功能之一，本次将学习在Spring Boot的web开发实例中实现文件的上传和下载。
在实际web开发中，为了文件上传成功，必须将表单的method方法设置post，并将enctype设置为mutipart/form-data,只有这样设置，浏览器才能将所选文件的二进制数据发送给服务器。
从Servlet3.0开始，就提供了处理文件上传的方法，但这种文件上传需要在Java Servlet中完成，而SpringMVC提供了更简单的封装，在SpringMVC中通过Apache Commons FileUpload技术实现一个MultipartResolver的实现类CommonsMultipartResolver完成文件的上传，因此在SpringMVC文件上传需要依赖Apache Commons FileUpload组件。
SpringMVC将上传文件绑定到MultipartFile对象，该对象提供了上传文件名，上传文件等方法，并通过transferTo方法及将文件上传到服务器的磁盘中。
Spring Boot的spring-boot-stater-web已经集成了SpringMVC,所以使用SpringBoot上传文件更加便捷，只需要引入Apache Commons FileUpLoad组件依赖即可。
下面通过一个实例学习Spring Boot的文件上传与下载。
1-创建Maven项目，在pom.xml中添加相关依赖。
主要添加启动类依赖，starter，Apache Commons FileUpload组件依赖.
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>Thymeleaf</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<!--配置SpringBoot的核心启动器-->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.4.RELEASE</version>
</parent>
<dependencies>
<dependency>
<!--添加starter模块-->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!--添加文件上传与下载组件依赖-->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.3</version>
</dependency>
</dependencies>
</project>
2-在全局配置文件application.properties中设置限制上传文件的大小。
#上传文件时候，默认上传文件大小是1MB，max-file-size设置单个文件上传大小
spring.servlet.multipart.max-file-size=50MB
#默认总文件大小为10MB，max-request-size设置总上传文件的大小
spring.servlet.multipart.max-request-size=500MB
3-在src/main/resources/templates目录下创建文件视图选择页面uploadFile.html文件。该页面引入了BootStrap框架。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
<meta charset="UTF-8">
<title>文件上传与下载</title>
<!--引入BootStrap框架-->
<link rel = "stylesheet" th:href = "@{css/bootstrap.min.css}"/>
<link rel = "stylesheet" th:href = "@{css/bootstrap-theme.min.css}"/>
</head>
<body>
<!--面板-->
<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">
<form class = "form-horizontal" action="upload" method="post" enctype="multipart/form-data">
<div class = "form-group">
<div class = "input-group col-md-6">
<span class = "input-group-addon">
<i class = "glyphicon glyphicon-pencil"></i>
</span>
<input class = "form-control" type = "text" name = "description" th:placeholder="文件描述"/>
</div>
</div>
<div class = "form-group">
<div class = "input-group col-md-6">
<span class = "input-group-addon">
<i class = "glyphicon glyphicon-search"></i>
</span>
<input class = "form-control" type = "file" name = "myfile" th:placeholder = "请选择文件"/>
</div>
</div>
<div class = "form-group">
<div class = "col-md-6">
<div class = "btn-group">
<button type="submit" class = "btn btn-success">
<span class = "glyphicon glyphicon-share"></span>
上传文件
</button>
</div>
</div>
</div>
</form>
</div>
</div>
</div>
</body>
</html>
4-在src/main/java目录创建com.controller包，在该包中创建控制器类TestFileUpload，该控制器类中共包含四个方法，一个是页面导航方法uploadFile，一个是实现文件上传的upload方法，一个是实现显示将要被下载文件的showDowwnLoad方法，一个是实现下载功能的download方法。
import org.apache.commons.io.FileUtils;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
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;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
@Controller
public class TestFileUpload {
//进入选择页面
@RequestMapping("/uploadFile")
public String uploadFile() {
return "uploadFile";
}
//上传文件自动绑定到MultipartFile对象中，在这里使用处理方法的形参接收请求参数
@RequestMapping("/upload")
public String upload(HttpServletRequest request, @RequestParam("description") String description, @RequestParam("myfile") MultipartFile myfile) throws IOException {
System.out.println("文件描述：" + description);
//如果选择了上传文件，这里需要将文件上传到指定目录uploadFiles
if (!myfile.isEmpty()) {
//上传文件路径
String path = request.getServletContext().getRealPath("/uploadFiles/");
//获得上传文件原名
String fileName = myfile.getOriginalFilename();
File filePath = new File(path + File.separator + fileName);
//如果目录不存在。就创建目录
if (!filePath.getParentFile().exists()) {
filePath.getParentFile().mkdirs();
}
//将上传文件保存到一个目标文件中
myfile.transferTo(filePath);
//转发到另外一个请求处理方法，查询要下载的文件
}
return "forward:/showDownLoad";
}
//显示要下载的文件
@RequestMapping("/showDownLoad")
public String showDownLoad(HttpServletRequest request, Model model){
String path = request.getServletContext().getRealPath("/uploadFiles/") ;
File fileDir = new File(path) ;
//从指定目录获得文件列表
File [] filesList = fileDir.listFiles() ;
model.addAttribute("filesList", filesList) ;
return "showFile" ;
}
//实现下载功能
@RequestMapping("/download")
public ResponseEntity<byte[]> 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
ResponseEntity.BodyBuilder builder = ResponseEntity.ok() ;
//内容长度
builder.contentLength(downFile.length()) ;
//二进制流数据最常见的下载方式
builder.contentType(MediaType.APPLICATION_OCTET_STREAM) ;
//对文件名进行编码
filename = URLEncoder.encode(filename, "UTF-8") ;
/**
* 根据实际的响应文件名，告诉浏览器文件要用于下载和保存
* 不同的浏览器，处理方式不同，根据浏览器的实际情况区别对待
*/
if(userAgent.indexOf("MSIE") > 0){
//IE浏览器，只需要用UTF-8字符集进行URL编码
builder.header("Content-Disposition", "attachment; filename = " + filename) ;
}else{
//非IE浏览器，则需要说明编码的字符集
builder.header("Content-Disposition", "attachment; filename*= UTF-8''" + filename) ;
}
return builder.body(FileUtils.readFileToByteArray(downFile)) ;
}
}
5-在src/main/resources/templates目录下创建文件下载视图页面showFile.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
<meta charset="UTF-8">
<title>文件展示页面</title>
<!--引入BootStrap框架-->
<link rel = "stylesheet" th:href = "@{css/bootstrap.min.css}"/>
<link rel = "stylesheet" th:href = "@{css/bootstrap-theme.min.css}"/>
</head>
<body>
<!--面板-->
<div class = "panel panel-primary">
<div class = "panel-heading">
<h3 class = "panel-title">文件下载示例</h3>
</div>
</div>
<!--容器-->
<div class = "container">
<div class = "panel panel-primary">
<div class = "panel-heading">
<h3 class = "panel-title">文件列表</h3>
</div>
<div class = "panel-body">
<div class = "table table-responsive">
<table class = "table table-bordered table-hover">
<tbody class = "text-center">
<tr th:each = "file,fileStat:${filesList}">
<td>
<span th:text = "${fileStat.count}"></span>
</td>
<td>
<!--file.name相当于调用getName()方法获得文件名称-->
<a th:href = "@{download(filename = ${file.name})}">
<span th:text = "${file.name}"></span>
</a>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</body>
</html>
6-在src/main/java目录下创建com.test包，在该包中创建启动类，运行启动类。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication(scanBasePackages = {"com"})
public class TestApplication {
public static void main(String以上是关于Spring Boot的文件上传与下载的主要内容，如果未能解决你的问题，请参考以下文章