SpringBoot配置和使用Multipart并实现上传下载文件

发布时间:2020-05-29 17:57:01 作者:鸽子
来源:亿速云 阅读:8075

SpringBoot是Java开发时常用框架,有非常丰富的组件和易用的功能。Multipart用于支持客户端将文件上传到服务器,服务器从请求流中得到文件内容,保存到本地或者云端。系统架构示意图如下:

SpringBoot配置和使用Multipart并实现上传下载文件

主要类和接口关系如下:

SpringBoot配置和使用Multipart并实现上传下载文件

开发步骤:


代码文件

功能要点

SpringBoot配置Multipart

application.yml

SpringBoot Web已经引入依赖,在application.yml中配置multipart

ServerConfig.java

读取服务地址,拼接url

MultipartConfig.java

读取本地存储地址,保存文件

文件操作

FileHelper.java

读写文件, 以及辅助功能

API开发

FileController.java

增加REST接口POST /upload/{file}, GET /download/{name}

单元测试

FileControllerTest.java

测试功能,MockHttpServletResponse, MockMultipartFile

功能扩展

集成DB读写功能,建立数据表File

在数据库中存储文件名称,MD5等信息,上传时判断MD5一样就重用,下载时返回源文件名。

FileTypeEnum.java

声明文件类型,归类存储

LocationEnum.java

支持本地或云端存储,比如阿里云、七牛云


一,SpringBoot配置Multipart

1. SpringBoot Web项目,已经包含了Multipart依赖,需要在application.yml中配置如下,开启multipart功能,指定文件大小范围和存储路径:

spring:
  servlet:
    multipart:
      enabled: true
      location: files
      file-size-threshold: 0B
      max-file-size: 10MB
      max-request-size: 10MB

2. 配置ServerConfig,读取API服务的IP地址或者域名,在返回文件信息时拼接url。

3. 配置MultipartConfig,读取文件存储路径,FileHelper写入文件时使用。


二,封装文件操作

文件读写,生成存储路径和网络url,实现代码详见FileHelper.java

1. save()将MultipartFile文件流保存到服务器或云端。

2. read()将文件内容读出并写如HttpServletResponse中。

3. getFilePath()得到文件存储路径。

4. getFileUrl()得到访问文件的网络url


三,上传下载API开发FileController.java

增加两个REST接口,上传接口/file/upload是POST请求,处理单个或者多个文件;下载接口/file/download/{name}是GET请求,name是根据文件唯一编号+扩展名生成的名称。实现代码详见FileController.java

@RestController
@RequestMapping("/file")
public class FileController {
    @PostMapping("/upload")
    public Object upload(
            @RequestParam(value = "file", required = false) MultipartFile file,
            @RequestParam(value = "files", required = false) MultipartFile[] files
    ) {
        if (file != null) {
            LogUtil.info("/file/upload", file.getName());
        }

        if (!EmptyUtil.isEmpty(files)) {
            LogUtil.info("/file/upload", files.length);
        }
    }

    @GetMapping("/{name}")
    public Object download(HttpServletResponse response, @PathVariable("name") String name) {
        LogUtil.info("/file", name);
    }
}

1,文件上传时首先根据内容生成MD5,通过MD5判断文件是否重复,然后保存文件并记录信息到数据库,返回文件url,时序图如下。


问答:为什么要保存文件信息到数据库?

- 首先将文件MD5保存起来,可以有效的避免文件重复。

- 存储在服务器时,文件名称使用一个新生成的唯一编号,这个编号也是url关键字。

- 文件原名保存到数据库,下载时可以返回给客户端。

SpringBoot配置和使用Multipart并实现上传下载文件

2,下载文件时,从请求参数中获取文件编号,根据服务器存储路径查找文件。通过根据文件编号在数据库中查询并返回信息,流程图如下。

SpringBoot配置和使用Multipart并实现上传下载文件

四,单元测试FileControllerTest.java

Spring框架提供了Mock功能辅助测试HTTP,我们用到org.springframework.mock.web包中的两个类:MockMultipartFile在上传时模拟文件,MockHttpServletResponse在下载时模拟HttpResponse响应。

1,创建一个临时文件,然后构建一个MockMultipartFile,测试upload()函数时传入。

File file = File.createTempFile("tmp", ".txt");
FileUtil.write(file.getPath(), "tmp file".getBytes());


MockMultipartFile multipart = new MockMultipartFile(
        file.getName(), file.getName(), null,
        new FileInputStream(file)
);

Object ret = fileController.doUpload(multipart, null);

2,新建一个MockHttpServletResponse实例,传入download()函数,将下载文件内容写入Response。

HttpServletResponse response = new MockHttpServletResponse();
Object ret = fileController.download(response, f200216377344237183100944.jpg);

3,运行FileControllerTest.java,,测试结果:

SpringBoot配置和使用Multipart并实现上传下载文件

五,功能扩展

1. 存储文件时,将文件信息和MD5存入数据库,MD5用于检查重复文件,文件原名称等信息在下载时返回。

2. 文件存储时使用新生成的唯一编号作为文件名称,编号也是网络url关键字。

3. 文件存储可以扩展到云端,比如阿里云、七牛云,在FileController的upload()和download()函数流程中切换。


常见问题和解决方法

独立部署在Tomcat中时,文件存储路径不正确

解决:在application.yml中配置文件存储路径时,使用绝对路径,比如:spring.servlet.multipart.location=/tmp/files

原因:在Tomcat容器中运行时,相对路径在Tomcat主目录内。


上传文件2M时提示错误,如何控制允许的文件大小?

解决:在application.yml中配置multipart允许的文件大小,比如:

spring:
  servlet:
    multipart:
      enabled: true
      file-size-threshold: 0B
      max-file-size: 10MB
      max-request-size: 10MB

原因:没有配置时,将使用默认值:

file-size-threshold: 单个数据size,默认0B

max-file-size: 最大文件size,默认1MB

max-request-size: 最大请求size,默认10MB


附录:如何高效率的调试REST接口?

有多种方法和API调式工具可用,介绍3个方式:

1,单元测试:上文介绍过Spring框架提供了Mock功能辅助HTTP测试,单元测试覆盖主要功能函数,并且和自动构建系统集成,能及时发现功能缺陷和代码改动带来的bug,保证项目质量。

SpringBoot配置和使用Multipart并实现上传下载文件

2,Swagger接口文档和调用:Swagger框架定义了完整的REST接口文档规范,提供了强大的页面测试功能,能够调试和可视化API接口服务,并且将文档融合到代码中,让维护文档和修改代码整合为一体,使得修改代码逻辑的同时方便的修改文档说明。


浏览器打开http://localhost:8011/swagger-ui.html,展开接口信息,选择文件然后Try it ou!

SpringBoot配置和使用Multipart并实现上传下载文件

3,Postman是一个常用的API调试工具,支持各种请求方式和配置环境变量,并对返回结果进行测试校验,支持批量自动化运行,可以和自动构建系统集成,而且可以导入导出JSON文件,高效团队协作。

更多相关资讯:

springboot上传文件时出现错误“spring.servlet.multipart.max-file-size”的解决方法

解决Spring Boot应用上传文件时报错“spring.servlet.multipart.location”的方法


推荐阅读:
  1. 使用spring boot和MVC上传下载文件
  2. SpringBoot的配置和使用

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

springboot multipart file upload

上一篇:kubernetes svc设置externalTraffi

下一篇:Weak关键字介绍

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》