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

多部分内容

Multipart Data 中所述,ServerWebExchange提供对 Multipart 的访问 内容。在控制器中处理文件上传表单(例如,从浏览器)的最佳方法 是通过数据绑定到 Command 对象, 如下例所示: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 服务中的非浏览器客户端提交分段请求 场景。以下示例将文件与 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以获取元数据。

您可以使用@RequestPartjakarta.validation.Valid或 Spring 的@Validated注解,这会导致应用 Standard Bean Validation。验证 错误会导致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

要以流式方式按顺序访问分片数据,您可以使用@RequestBodyFlux<PartEvent>(或Flow<PartEvent>在 Kotlin 中)。 多部分 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 处理 form 字段。
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 处理 form 字段。
5 处理文件上传。
6 正文内容必须完全使用、中继或释放,以避免内存泄漏。

接收的 part 事件也可以使用WebClient. 请参见Multipart Dataspring-doc.cadn.net.cn