多部分内容

参见 Servlet 堆栈中的等效项

如 多部分数据 中所述，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 获取文件。

要反序列化原始部分内容（例如，反序列化为 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将接收到的部分事件转发到另一个服务。请参阅多部分数据。