多部分内容
-
Java
-
Kotlin
class MyForm {
private String name;
private FilePart file;
// ...
}
@Controller
public class FileUploadController {
@PostMapping("/form")
public String handleFormUpload(MyForm form, BindingResult errors) {
// ...
}
}
class MyForm(
val name: String,
val file: FilePart)
@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 获取文件。 |
要反序列化原始部分内容(例如,到 JSON——类似于 @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) {
// use one of the onError* operators...
}
@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();
// 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 转发到另一个服务。请参阅多部分数据。