SpringBoot2.x系列教程23--SpringBoot中实现文件上传-阿里云开发者社区

SpringBoot2.x系列教程23--SpringBoot中实现文件上传

2022-08-21 556

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

本文涉及的产品

云解析 DNS，旗舰版 1个月

全局流量管理 GTM，标准版 1个月

公共DNS（含HTTPDNS解析），每月1000万次HTTP解析

简介： 前言文件上传是开发时比较常见的功能之一，但是SpringBoot并没有提供额外的文件上传技术，还是依赖于SpringMVC的文件上传技术。因为在SpringBoot中集成了SpringMVC的很多常用功能，所以SpringBoot的Web模块中也包含了文件上传部分，其实实现起来没有太多的难度。本章节壹哥就给大家讲一下在Spring Boot中如何实现单个文件和多个文件的上传功能。一. 概述1. MultipartFile简介在SpringMVC时代，就提供了MultipartFile这个封装类，它包含了文件的二进制流和文件相关属性(文件名、大小等)，而在Spring Boot中

前言

文件上传是开发时比较常见的功能之一，但是SpringBoot并没有提供额外的文件上传技术，还是依赖于SpringMVC的文件上传技术。因为在SpringBoot中集成了SpringMVC的很多常用功能，所以SpringBoot的Web模块中也包含了文件上传部分，其实实现起来没有太多的难度。

本章节壹哥就给大家讲一下在Spring Boot中如何实现单个文件和多个文件的上传功能。

一. 概述

1. MultipartFile简介

在SpringMVC时代，就提供了MultipartFile这个封装类，它包含了文件的二进制流和文件相关属性(文件名、大小等)，而在Spring Boot中也是使用此封装类进行文件上传。

MultipartFile是个接口，它的实现类有CommonsMultipartFile和StandardMultipartFile，这里我做一下简单说明：

1️⃣. CommonsMultipartFile: 是基于apache fileupload的解析；

2️⃣. StandardMultipartFile: 是基于j2ee自带的文件上传进行解析，也就是使用Servlet3.0提供的javax.servlet.http.Part上传方式。

我们在正常使用MultipartFile时，无需关心底层是以哪种方式进行文件上传处理的，SpringMVC会给我们做相应的转换。

另外我们要注意，如果想要实现文件上传，必须将表单的method设置为post，并将enctype设置为multipart/form-data。只有这样，浏览器才会把用户所选择文件的二进制数据发送给服务器。SpringMVC在文件上传时，会将上传的文件映射为MultipartFile对象，并对MultipartFile对象进行文件的解析和保存。

2. MultipartFile内的API方法

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

String getContentType(): 获取文件MIME类型,如application/pdf、image/pdf等;

InputStream getInputStream(): 获取文件流;

String getOriginalFileName(): 获取上传文件的原名称;

long getSize(): 获取文件的字节大小,单位为byte;

boolean isEmpty(): 是否上传的文件是否为空;

void transferTo(File dest): 将上传的文件保存到目标文件中

二. SpringBoot中实现单文件上传

1. 创建一个新模块module

我们继续在之前的项目中，创建一个新的项目模块，具体创建过程请参考之前的文章，创建过程略过。

2. 添加相关依赖包

这里我们要添加一些重要依赖包，主要是web依赖和thymeleaf模板依赖。

<dependencies><dependency><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><!--为了解决thymeleaf模板中,对html标签要求太严格的问题!--><dependency><groupId>net.sourceforge.nekohtml</groupId><artifactId>nekohtml</artifactId><version>1.9.22</version></dependency><!--简化bean的代码--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency></dependencies>

3. 编写文件上传页面picUpload.html

我们在resource/templates目录下，创建一个文件上传页面，用于提交文件上传表单。

<!DOCTYPE HTML><html><head><title>pictureUploading</title><metahttp-equiv="Content-Type"content="text/html;charset=UTF-8"></head><body><formenctype="multipart/form-data"method="post"action="/upload">    文件: <inputtype="file"name="fileUpload"/><inputtype="submit"value="上传"/></form></body></html>

4. 配置application.properties

接着在resources目录下，创建application.properties配置文件，并设置相关配置属性，这里主要是对文件上传路径做了配置。

# Template mode to be applied to templates. See also StandardTemplateModeHandlers.spring.thymeleaf.mode=LEGACYHTML5
spring.servlet.multipart.enabled=truespring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB
#文件上传目录（注意Linux和Windows上的目录结构不同）#uploadFolder=/root/upload/#特别要注意此位置uploadFolder=E:/upload/

5. 创建信息提示类Message

创建一个实体类，用于对外展示文件上传后的状态信息。

packagecom.yyg.boot.domain;
importlombok.AllArgsConstructor;
importlombok.Data;
importlombok.NoArgsConstructor;
/*** 采用lombok简化bean*/@Data@NoArgsConstructor@AllArgsConstructorpublicclassMessage {
/***0表示成功,-1表示失败*/intstatus;
/*** 向前端返回的内容*/Stringmassage;
}

6. 创建文件上传的UploadController类

然后我们创建一个Controller，在这里编写文件上传接口，文件上传要使用post请求方式。

packagecom.syc.boot.web;
importcom.syc.boot.domain.Message;
importorg.springframework.beans.factory.annotation.Value;
importorg.springframework.stereotype.Controller;
importorg.springframework.web.bind.annotation.PostMapping;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.ResponseBody;
importorg.springframework.web.multipart.MultipartFile;
importjava.io.File;
importjava.util.UUID;
/*** 实现文件上传的控制器*/@ControllerpublicclassUploadController {
@Value("${uploadFolder}")
privateStringfileDir;
@RequestMapping("/picUpload")
publicStringpicUpload(){
//跳转到picUpload.htmlreturn"picUpload";
    }
@ResponseBody@PostMapping("/upload")
publicObjectupload(MultipartFilefileUpload){
//获取文件名StringfileName=fileUpload.getOriginalFilename();
//获取文件后缀名StringsuffixName=fileName.substring(fileName.lastIndexOf("."));
//重新生成文件名fileName=UUID.randomUUID()+suffixName;
//指定本地文件夹存储图片try {
System.out.println("------->>"+fileDir);
Filedir=newFile(fileDir);
if (!dir.exists()) {
dir.mkdirs();
            }
Fileupload_file=newFile(fileDir+fileName);
fileUpload.transferTo(upload_file);
returnnewMessage(0,"success to upload");
        } catch (Exceptione) {
e.printStackTrace();
returnnewMessage(-1,"fail to upload");
        }
    }
}

7. 应用程序入口类

最后编写项目入口类。

packagecom.syc.boot;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplicationpublicclassUploadWebApplication {
publicstaticvoidmain(String[] args) {
SpringApplication.run(UploadWebApplication.class, args);
    }
}

8. 运行程序，实现文件上传

接下来我们启动程序，访问文件上传界面，选择文件进行上传，如果可以看到如下效果，则说明文件上传成功。

我这里是把文件上传到了本机的E盘目录下，真正开发时一般是上传到Linux服务器的某个目录下，过程都一样的，主要是存储位置的不同。当然现在也有很多项目是采用云存储，关于云存储我会在下一章节中带大家实现。

9. 项目结构

最后我们看一下项目的代码结构，各位可以参考创建。

三. SpringBoot中实现多文件上传

上面我们实现了单个文件的上传，但有时我们也需要同时上传多个文件，那这该如何实现呢？

1. 创建多文件上传的html页面

我们在上面的项目基础之上，创建多文件上传的html页面，页面名称是multiUpload.html。

<!DOCTYPE html><htmlxmlns:th="http://www.thymeleaf.org"><head><title>多文件上传</title><metacharset="utf-8"/><metahttp-equiv="X-UA-Compatible"content="IE=edge"/><metaname="viewport"content="width=device-width,initial-scale=1,user-scalable=no"/></head><body><div><div><div><h3>多个文件上传</h3></div><div><formmethod="post"enctype="multipart/form-data"th:action="@{/uploadMultifile}"><div><labelfor="attachment1">文件上传: </label><div><inputtype="file"name="attachment"id="attachment1"placeholder="请选择邮件附件"/></div></div><div><labelfor="attachment2">文件上传: </label><divclass="col-sm-5"><inputtype="file"name="attachment"id="attachment2"placeholder="请选择邮件附件"/></div></div><div><labelfor="attachment3">文件上传: </label><div><inputtype="file"name="attachment"id="attachment3"placeholder="请选择邮件附件"/></div></div><div><div><buttontype="submit">上&nbsp;传</button></div></div></form></div></div></div></body></html>

2. 创建一个多文件上传的方法

我们直接在上面的Controller中添加一个新的多文件上传接口。

@RequestMapping("/multiUpload")
publicStringmultiUpload(){
//跳转到multiUpload.htmlreturn"multiUpload";
    }
@RequestMapping(value="/uploadMultifile", method=RequestMethod.POST)
@ResponseBodypublicObjectuploadMultiFile(@RequestParam("attachment") MultipartFile[] fileUpload) {
try {
for (inti=0;i<fileUpload.length;i++){
//获取文件名StringfileName=fileUpload[i].getOriginalFilename();
//指定本地文件夹存储图片Filedir=newFile(fileDir);
if (!dir.exists()) {
dir.mkdirs();
                }
if (fileUpload[i]!=null){
Fileupload_file=newFile(fileDir+fileName);
fileUpload[i].transferTo(upload_file);
                }
            }
returnnewMessage(0,"success to upload");
        } catch (Exceptione) {
e.printStackTrace();
returnnewMessage(-1,"fail to upload");
        }
    }

3. 多文件上传验证

重启项目后，我们测试一下这个多文件上传功能。

正常情况下，我们就看到了多文件上传的测试结果，我这里一次性上传了3张图片。

最终我们就实现了在Spring Boot中的多文件上传功能。

结语

这样我们就实现了在SpringBoot环境中的文件上传功能，最后壹哥再把文件上传时的重点给大家总结强调一下。

1️⃣. 表单method要设置为post，并将enctype设置为 multipart/form-data；

2️⃣. 文件映射为MultipartFile对象进行解析；

3️⃣. 上传文件大小spring.http.multipart.max-file-size 限制。

SpringBoot2.x系列教程23--SpringBoot中实现文件上传

前言

一. 概述

1. MultipartFile简介

2. MultipartFile内的API方法

二. SpringBoot中实现单文件上传

1. 创建一个新模块module

2. 添加相关依赖包

3. 编写文件上传页面picUpload.html

4. 配置application.properties

5. 创建信息提示类Message

6. 创建文件上传的UploadController类

7. 应用程序入口类

8. 运行程序，实现文件上传

9. 项目结构

三. SpringBoot中实现多文件上传

1. 创建多文件上传的html页面

2. 创建一个多文件上传的方法

3. 多文件上传验证

结语

热门文章

最新文章

相关课程

相关电子书

相关实验场景

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

SpringBoot2.x系列教程23--SpringBoot中实现文件上传

前言

一. 概述

1. MultipartFile简介

2. MultipartFile内的API方法

二. SpringBoot中实现单文件上传

1. 创建一个新模块module

2. 添加相关依赖包

3. 编写文件上传页面picUpload.html

4. 配置application.properties

5. 创建信息提示类Message

6. 创建文件上传的UploadController类

7. 应用程序入口类

8. 运行程序，实现文件上传

9. 项目结构

三. SpringBoot中实现多文件上传

1. 创建多文件上传的html页面

2. 创建一个多文件上传的方法

3. 多文件上传验证

结语

热门文章

最新文章

相关课程

相关电子书

相关实验场景