对于最新的稳定版本,请使用 Spring Framework 7.0.6!spring-doc.cadn.net.cn

Multipart Content

多部分数据中所述,ServerWebExchange提供了对多部分内容的访问。处理文件上传表单(例如,来自浏览器)的最佳方式是通过数据绑定到命令对象,如下例所示:spring-doc.cadn.net.cn

class MyForm {

	private String name;

	private MultipartFile file;

	// ...

}

@Controller
public class FileUploadController {

	@PostMapping("/form")
	public String handleFormUpload(MyForm form, BindingResult errors) {
		// ...
	}

}
class MyForm(
		val name: String,
		val file: MultipartFile)

@Controller
class FileUploadController {

	@PostMapping("/form")
	fun handleFormUpload(form: MyForm, errors: BindingResult): String {
		// ...
	}

}

您也可以在RESTful服务场景中从非浏览器客户端提交multipart请求。以下示例使用了一个文件和JSON:spring-doc.cadn.net.cn

POST /someUrl
Content-Type: multipart/mixed

--edt7Tfrdusa7r3lNQc79vXuhIIMlatb7PQg7Vp
Content-Disposition: form-data; name="meta-data"
Content-Type: application/json; charset=UTF-8
Content-Transfer-Encoding: 8bit

{
	"name": "value"
}
--edt7Tfrdusa7r3lNQc79vXuhIIMlatb7PQg7Vp
Content-Disposition: form-data; name="file-data"; filename="file.properties"
Content-Type: text/xml
Content-Transfer-Encoding: 8bit
... File Data ...

你可以通过 @RequestPart 访问各个部分,如下例所示:spring-doc.cadn.net.cn

@PostMapping("/")
public String handle(@RequestPart("meta-data") Part metadata, (1)
		@RequestPart("file-data") FilePart file) { (2)
	// ...
}
1 使用 @RequestPart 来获取元数据。
2 使用 @RequestPart 来获取文件。
@PostMapping("/")
fun handle(@RequestPart("meta-data") Part metadata, (1)
		@RequestPart("file-data") FilePart file): String { (2)
	// ...
}
1 使用 @RequestPart 来获取元数据。
2 使用 @RequestPart 来获取文件。

要反序列化原始部分内容(例如,到JSON——类似于@RequestBody), 你可以声明一个具体的目标Object,而不是Part,如下例所示:spring-doc.cadn.net.cn

@PostMapping("/")
public String handle(@RequestPart("meta-data") MetaData metadata) { (1)
	// ...
}
1 使用 @RequestPart 来获取元数据。
@PostMapping("/")
fun handle(@RequestPart("meta-data") metadata: MetaData): String { (1)
	// ...
}
1 使用 @RequestPart 来获取元数据。

您可以使用 @RequestPart 结合 jakarta.validation.Valid 或 Spring 的 @Validated 注解,这会导致应用标准的 Bean 验证。验证 错误会导致一个 WebExchangeBindException,从而产生 400 (BAD_REQUEST) 响应。 异常包含一个 BindingResult,其中包含错误详细信息,也可以在 控制器方法中通过声明带有异步包装器的参数然后使用 与错误相关的操作符来处理:spring-doc.cadn.net.cn

@PostMapping("/")
public String handle(@Valid @RequestPart("meta-data") Mono<MetaData> metadata) {
	// use one of the onError* operators...
}
@PostMapping("/")
fun handle(@Valid @RequestPart("meta-data") metadata: MetaData): String {
	// ...
}

要访问所有多部分数据作为 MultiValueMap,你可以使用 @RequestBody, 如下例所示:spring-doc.cadn.net.cn

@PostMapping("/")
public String handle(@RequestBody Mono<MultiValueMap<String, Part>> parts) { (1)
	// ...
}
1 使用 @RequestBody
@PostMapping("/")
fun handle(@RequestBody parts: MultiValueMap<String, Part>): String { (1)
	// ...
}
1 使用 @RequestBody

PartEvent

要以流式方式顺序访问多部分数据,可以使用@RequestBody配合Flux<PartEvent>(或在Kotlin中使用Flow<PartEvent>)。 多部分HTTP消息中的每个部分将产生至少一个PartEvent,其中包含头部信息和一个存储部分内容的缓冲区。spring-doc.cadn.net.cn

  • 表单字段将生成一个单一FormPartEvent,该值包含字段的内容。spring-doc.cadn.net.cn

  • 文件上传将产生一个或多个 FilePartEvent对象,其中包含上传时使用的文件名。如果文件足够大,需要分块到多个缓冲区,第一个FilePartEvent之后将跟随后续事件。spring-doc.cadn.net.cn

@PostMapping("/")
public void handle(@RequestBody Flux<PartEvent> allPartsEvents) { (1)
    allPartsEvents.windowUntil(PartEvent::isLast) (2)
            .concatMap(p -> p.switchOnFirst((signal, partEvents) -> { (3)
                if (signal.hasValue()) {
                    PartEvent event = signal.get();
                    if (event instanceof FormPartEvent formEvent) { (4)
                        String value = formEvent.value();
                        // handle form field
                    }
                    else if (event instanceof FilePartEvent fileEvent) { (5)
                        String filename = fileEvent.filename();
                        Flux<DataBuffer> contents = partEvents.map(PartEvent::content); (6)
                        // handle file upload
                    }
                    else {
                        return Mono.error(new RuntimeException("Unexpected event: " + event));
                    }
                }
                else {
                    return partEvents; // either complete or error signal
                }
            }));
}
1 使用 @RequestBody
2 对于特定部分的最后一个PartEvent,其isLast()将设置为true,并且可以 之后跟随属于后续部分的其他事件。 这使得isLast属性适合作为Flux::windowUntil运算符的谓词,以便 将来自所有部分的事件分割成每个部分单独所属的窗口。
3 Flux::switchOnFirst 运算符使您能够判断当前处理的是表单字段还是文件上传。
4 处理表单字段。
5 处理文件上传。
6 正文内容必须被完全消耗、转发或释放,以避免内存泄漏。
	@PostMapping("/")
	fun handle(@RequestBody allPartsEvents: Flux<PartEvent>) = { (1)
      allPartsEvents.windowUntil(PartEvent::isLast) (2)
          .concatMap {
              it.switchOnFirst { signal, partEvents -> (3)
                  if (signal.hasValue()) {
                      val event = signal.get()
                      if (event is FormPartEvent) { (4)
                          val value: String = event.value();
                          // handle form field
                      } else if (event is FilePartEvent) { (5)
                          val filename: String = event.filename();
                          val contents: Flux<DataBuffer> = partEvents.map(PartEvent::content); (6)
                          // handle file upload
                      } else {
                          return Mono.error(RuntimeException("Unexpected event: " + event));
                      }
                  } else {
                      return partEvents; // either complete or error signal
                  }
              }
          }
}
1 使用 @RequestBody
2 对于特定部分的最后一个PartEvent,其isLast()将设置为true,并且可以 之后跟随属于后续部分的其他事件。 这使得isLast属性适合作为Flux::windowUntil运算符的谓词,以便 将来自所有部分的事件分割成每个部分单独所属的窗口。
3 Flux::switchOnFirst 运算符使您能够判断当前处理的是表单字段还是文件上传。
4 处理表单字段。
5 处理文件上传。
6 正文内容必须被完全消耗、转发或释放,以避免内存泄漏。

接收到的部分事件也可以通过使用 WebClient 转发到另一个服务。 请参阅 多部分内容spring-doc.cadn.net.cn