SpringBoot实现文件上传与下载功能的示例代码
作者：TiAmo?zhang 发布时间：2021-11-10 09:15:32
标签：SpringBoot,文件,上传,下载
Spring Boot文件上传与下载
在实际的Web应用开发中，为了成功上传文件，必须将表单的method设置为post，并将enctype设置为multipart/form-data。只有这种设置，浏览器才能将所选文件的二进制数据发送给服务器。
从Servlet 3.0开始，就提供了处理文件上传的方法，但这种文件上传需要在Java Servlet中完成，而Spring MVC提供了更简单的封装。Spring MVC是通过Apache Commons FileUpload技术实现一个MultipartResolver的实现类CommonsMultipartResolver完成文件上传的。因此，Spring MVC的文件上传需要依赖Apache Commons FileUpload组件。
Spring MVC将上传文件自动绑定到MultipartFile对象中，MultipartFile提供了获取上传文件内容、文件名等方法，并通过transferTo方法将文件上传到服务器的磁盘中，MultipartFile的常用方法如下：
byte[] getBytes()：获取文件数据。
String getContentType()：获取文件MIME类型，如image/jpeg等。
InputStream getInputStream()：获取文件流。
String getName()：获取表单中文件组件的名字。
String getOriginalFilename()：获取上传文件的原名。
long getSize()：获取文件的字节大小，单位为byte。
boolean isEmpty()：是否有（选择）上传文件。
void transferTo(File dest)：将上传文件保存到一个目标文件中。
Spring Boot的spring-boot-starter-web已经集成了Spring MVC，所以使用Spring Boot实现文件上传，更加便捷，只需要引入Apache Commons FileUpload组件依赖即可。
举例说明
下面通过一个实例讲解Spring Boot文件上传与下载的实现过程。
【例7】Spring Boot文件上传与下载。
具体实现步骤如下。
1.引入Apache Commons FileUpload组件依赖
在Web应用ch7_2的pom.xml文件中，添加Apache Commons FileUpload组件依赖，具体代码如下：
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<!-- 由于commons-fileupload组件不属于Spring Boot，所以需要加上版本 -->
<version>1.4</version>
</dependency>
2.设置上传文件大小限制
在Web应用ch7_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.创建选择文件视图页面
在ch7_2应用的src/main/resources/templates目录下，创建选择文件视图页面uploadFile.html。该页面中有个enctype属性值为multipart/form-data的form表单，具体代码如下：
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
<link rel="stylesheet" th:href="@{css/bootstrap.min.css}" />
<!-- 默认访问 src/main/resources/static下的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 btn-group-justified">
<div class="btn-group">
<button type="submit" class="btn btn-success">
<span class="glyphicon glyphicon-share"></span>
上传文件
</button>
</div>
</div>
</div>
</div>
</form>
</div>
</div>
</div>
</body>
</html>
4.创建控制器
在ch7_2应用的com.ch.ch7_2.controller包中，创建控制器类TestFileUpload。在该类中有4个处理方法，一个是界面导航方法uploadFile，一个是实现文件上传的upload方法，一个是显示将要被下载文件的showDownLoad方法，一个是实现下载功能的download方法。核心代码如下：
@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 IllegalStateException, 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
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));
}
}
5.创建文件下载视图页面
在ch7_2应用的src/main/resources/templates目录下，创建文件下载视图页面showFile.html。核心代码如下：
<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>
6.运行
首先，运行Ch72Application主类。然后，访问http://localhost:8080/ch7_2/uploadFile测试文件上传与下载。
来源：https://blog.csdn.net/qq_41640218/article/details/125179653
0
投稿猜你喜欢
- 在实际工作中，重试重发请求处理是一个非常常见的场景，比如:1、发送消息失败。2、调用远程服务失败。3、争抢锁失败。这些错误可能是因为网络波动
身为程序员我们对线程是再熟悉不过了，多线程并发算是Java进阶的知识，用好多线程不容易有太多的坑。创建线程也算是一个"重"- 一、 Sharding-jdbc简介“Sharding-jdbc是开源的数据库操作中间件；定位为轻量级Java框架，在Java的JDBC层提
- 1. 前言Spring的核心技术IOC(Intorol of Converse控制反转)的实现途径是DI(dependency Insert
- 本文实例讲述了Android中断线程的处理方法。分享给大家供大家参考。具体方法如下：我现在对一个用户注册的功能1.用ProgressDial
- Java8Stream流操作List去重根据属性去重整体去重使用distinctArrayList<LabelInfoDTO>
- 报错翻译： compileSdkVersion android-24”需要JDK 1.8或更高版本编译。报错现象如下图：原因：st
- 前言插入排序狭义上指的是简单插入排序(选择集合,比较大小,插入元素),广义上还应该包括希尔排序(分治思想)及其两种实现方式,最激动人心的是
- 文件上传在web应用中非常普遍，要在jsp环境中实现文件上传功能是非常容易的，因为网上有许多用java开发的文件上传组件，本文以common
- 方式一: 配置文件 application.propertiesserver.port=7788方式二: java启动命令# 以应用参数的方
- 单元测试单元测试就是针对最小的功能单元编写测试代码，Java程序最小的功能单元是方法，因此，单元测试就是针对Java方法的测试，进而检查方法
- C#串口模块的使用。使用VS .net框架下WinForm程序应用开发。C#开发的串口通信小工具。相比于QT添加的串口类，WinForm是通
- 目录1. 应用场景1.1. 保障线程安全1.2. 显示传递参数2. 实现原理3. 注意事项ThreadLocal是线程私有的局部变量存储容器
- 很多App都有这种效果，特别一些电商类的App，顶部每隔几秒钟会向右翻页显示下张图片，用来作推广或者内容展示用的。今天来简单地模仿一下，还自
- Spring Boot1.为什么要使用 Spring Boot因为Spring， SpringMVC 需要使用的大量的配置文件 （xml文件
- * 的实现使用的模式：代理模式。代理模式的作用是：为其他对象提供一种代理以控制对这个对象的访问。类似租房的中介。两种 * ：（1）jd
- List接口是Collection接口的子接口，List有一个重要的实现类--ArrayList类，List中的元素是有序排列的而且可重复，
- 1.编写核心类MainApp：package com.yiidian.gson;import com.google.gson.Gson;im
- 首先使用PImage来实例化对象，再通过loadImage赋值，两层for循环遍历图片上的像素点，每隔5个像素点，画一个直径为3的圆。颜色通
- 本文实例为大家分享了Java Swing实现扫雷源码的具体代码，供大家参考，具体内容如下先来看下效果运行时只需要创建一个GameWindow
