Spring多文件带参数上传接口实现及Postman调用方法咨询

你当前控制器的consumes同时配置了JSON和multipart/form-data属于错误配置，JSON格式无法传输二进制文件内容，必须先调整consumes仅保留MediaType.MULTIPART_FORM_DATA_VALUE，之后才能正常接收请求。
正确的请求必须是multipart/form-data类型，参数为按索引排列的数组格式，Postman操作步骤如下：

• 新建POST请求，地址填写你的服务域名+路径/file/{实际id数值}，替换路径中的id为实际业务值
• 切换到Body标签页，勾选form-data选项
• 按文件数量依次添加参数，示例传2个文件的参数配置：
  1. 第一个文件参数：
  • 参数名filesRequestList[0].name，值填第一个文件的自定义名称
  • 参数名filesRequestList[0].type，值填第一个文件的自定义类型
  • 参数名filesRequestList[0].file，参数类型切换为File，选择本地对应文件
  2. 第二个文件参数：
  • 参数名filesRequestList[1].name，值填第二个文件的自定义名称
  • 参数名filesRequestList[1].type，值填第二个文件的自定义类型
  • 参数名filesRequestList[1].file，参数类型切换为File，选择本地对应文件
    更多文件按索引[2]、[3]依次递增配置即可
• 无需手动设置Content-Type请求头，Postman会自动生成带boundary标识的请求头，直接发送即可。

现有实现问题 #

• 如上述提到的consumes配置错误，会导致合法的文件上传请求被拦截
• 直接使用@ModelAttribute接收List<FilesDTO>在部分低版本Spring Boot中会出现参数绑定失效的问题，兼容性一般

不用DTO的实现方案 #

如果额外参数只有name、type两类和文件一一对应，可以不用定义DTO，直接用三个平行的List接收参数，代码示例：

@PostMapping(value = "file/{id}", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public ResponseEntity<?> addFile(@PathVariable Long id, 
                                 @RequestParam("name") List<String> nameList,
                                 @RequestParam("type") List<String> typeList,
                                 @RequestParam("file") List<MultipartFile> fileList) throws IOException {
    // 校验三个列表长度一致，保证每个文件都对应上name和type参数
    if (nameList.size() != fileList.size() || typeList.size() != fileList.size()) {
        return ResponseEntity.badRequest().body("文件与附加参数数量不匹配");
    }
    // 后续业务逻辑
}

该方案对应的Postman配置更简单，直接重复添加同名参数即可，不需要加数组索引前缀：依次添加n个name参数、n个type参数、n个file参数，按顺序对应即可。

方案取舍建议 #

• 如果后续可能新增和单个文件绑定的扩展参数，保留DTO的方案更易维护，参数对应关系更清晰，不易出错
• 如果附加参数固定且数量极少，不需要DTO的轻量方案更简洁，代码冗余度更低

内容的提问来源于stack exchange，提问作者eva_mila