跳至主要內容

24. SpringBoot实现多文件上传

PangHu大约 3 分钟

一、前言

环境说明：Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

二、需求分析

突然加了这么个需求，要求对用户材料文件需要手动上传并指定文件路径保存。好家伙，一听，觉得没啥问题，又觉得有点欠妥，于是我便问了这么一句，需要支持文件批量嘛？你不问我还没觉得，那就加上吧！可支持用户批量上传。

这不是自己给自己加戏么?这开过光的嘴！说啥来啥，那能咋办，干就完了！

三、实现思路

其实对于文件上传，还是老样子，通过formData表单提交的方式进行文件附件上传，而不是现在所谓的json接收格式数据，比如@RequestBody注解；那为什么不能用它来接收？因为@RequestBody默认接收的enctype(MIME编码)是application/json，因此发送POST请求时需要设置请求报文头信息，否则SpringMVC在解析集合请求参数时是不会自动转换成JSON数据再解析成相应的集合。

那对于multipart/form-data 提交方式，那我们就可以通过使用@RequestParam(springmvc中接收普通参数的注解)，将请求参数绑定到控制器的方法参数上，或者你也省略映射不需要绑定(这就要求命名必须一致)，那就靠spring对于formdata带文件和数据字段一起上传的情况做自动映射。如果需要对参数进行重命名， 那么你就可以使用@RequestParam 映射前端传过来的字段名，而接收的时候自己自定义就行，比如如下这种方式，前端传给你的参数字段叫id，而你接收则是用dfId。

@RequestParam("id") String dfId

而对于多文件的话，我们就可以定义一个 MultipartFile [] 数组接收即可。比如如下演示：

@RequestParam("files") MultipartFile[] files

这样的话，结合一下不就支持多文件上传协同其他字段一并提交处理了。

四、实现方案

通过上方我们对此的分析可得，我们可以有两种方式可以进行实现，虽然大同小异，但是论标准，我就给大家讲一种最合理的实现方式，接下来我以实际例子作为演示。

比如，批量文件+数据字段的情况，论这种需求接口应该怎么定义呢？很好办呀？看我给大家露一手。仅供参考：

具体实现代码如下：

@PostMapping(value = "/upload-files")
@ApiOperation(value = "文件上传(支持批量)", notes = "文件上传(支持批量)")
public ResultResponse<Boolean> uploadFiles(@RequestParam("files") MultipartFile[] files,
                                           @RequestParam("type")  Integer type,
                                           @RequestParam("id") String dfId) throws IOException {
    return declarationFormService.uploadFiles(files, type, dfId);
}

然后我们来通过postman来测试下该接口，看看是否能拿到该参数信息，包括文件。

image-20231121204556741
image-20231121204556741

接下来我们在接口上打个断点，查看一下这些参数能否都被正常接收？

如下是实际断点截图：

image-20231121204609912
image-20231121204609912

接收到的参数信息与我postman所添加的参数内容完全一致，接收正常，能看到文件也是以数组的格式展示(MultipartFile [ 2 ])，这就意味着你待会儿如果要进行文件保存，那你就可以通过使用files进行循环一波即可。

比如我实际保存写法，仅供参考：

image-20231121204625972
image-20231121204625972