多部分内容
如Multipart Data中所解释的,ServerWebExchange提供对多部分内容的访问。在控制器中处理文件上传表单(例如来自浏览器)的最佳方式是通过数据绑定到一个命令对象,如下例所示:
-
Java
-
Kotlin
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服务场景中从非浏览器客户端提交多部分请求。以下示例使用文件以及JSON:
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访问各个部分,如下例所示:
-
Java
-
Kotlin
@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获取文件。 |
@RequestBody),您可以声明一个具体的目标
Object,而不是
Part,如下例所示:
-
Java
-
Kotlin
@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,也可以通过在控制器方法中声明带有异步包装器的参数,然后使用与错误相关的操作符来处理。
-
Java
-
Kotlin
@PostMapping("/")
public String handle(@Valid @RequestPart("meta-data") Mono<MetaData> metadata) {
// 使用其中一个onError*操作符...
}
@PostMapping("/")
fun handle(@Valid @RequestPart("meta-data") metadata: MetaData): String {
// ...
}
如果方法验证适用于其他参数具有@Constraint注解,则会引发HandlerMethodValidationException。请参阅验证部分。
要访问所有多部分数据作为MultiValueMap,您可以使用@RequestBody,如下例所示:
-
Java
-
Kotlin
@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。
-
表单字段将产生一个
FormPartEvent,包含字段的值。 -
文件上传将产生一个或多个
FilePartEvent对象,包含上传时使用的文件名。如果文件足够大,需要分割成多个缓冲区,则第一个FilePartEvent将后跟后续事件。
例如:
-
Java
-
Kotlin
@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();
// 处理表单字段
}
else if (event instanceof FilePartEvent fileEvent) { (5)
String filename = fileEvent.filename();
Flux<DataBuffer> contents = partEvents.map(PartEvent::content); (6)
// 处理文件上传
}
else {
return Mono.error(new RuntimeException("Unexpected event: " + event));
}
}
else {
return partEvents; // 完成或错误信号
}
}));
}
| 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();
// 处理表单字段
} else if (event is FilePartEvent) { (5)
val filename: String = event.filename();
val contents: Flux<DataBuffer> = partEvents.map(PartEvent::content); (6)
// 处理文件上传
} else {
return Mono.error(RuntimeException("Unexpected event: " + event));
}
} else {
return partEvents; // 完成或错误信号
}
}
}
}
| 1 | 使用@RequestBody。 |
| 2 | 特定部分的最终PartEvent将设置isLast()为true,并且可以后跟属于后续部分的其他事件。这使得isLast属性适用于Flux::windowUntil操作符,将所有部分的事件拆分为每个属于单个部分的窗口。 |
| 3 | Flux::switchOnFirst操作符允许您查看您是在处理表单字段还是文件上传。 |
| 4 | 处理表单字段。 |
| 5 | 处理文件上传。 |
| 6 | 必须完全消耗、中继或释放主体内容,以避免内存泄漏。 |
接收到的部分事件也可以通过使用WebClient中继到另一个服务。请参阅多部分数据。