多部分

启用 MultipartResolver 后,multipart/form-data POST 请求的内容将被解析并可作为常规请求参数访问。以下示例访问了一个常规表单字段和一个上传的文件:

  • Java

  • Kotlin

@Controller
public class FileUploadController {

	@PostMapping("/form")
	public String handleFormUpload(@RequestParam("name") String name,
			@RequestParam("file") MultipartFile file) {

		if (!file.isEmpty()) {
			byte[] bytes = file.getBytes();
			// store the bytes somewhere
			return "redirect:uploadSuccess";
		}
		return "redirect:uploadFailure";
	}
}
@Controller
class FileUploadController {

	@PostMapping("/form")
	fun handleFormUpload(@RequestParam("name") name: String,
						@RequestParam("file") file: MultipartFile): String {

		if (!file.isEmpty) {
			val bytes = file.bytes
			// store the bytes somewhere
			return "redirect:uploadSuccess"
		}
		return "redirect:uploadFailure"
	}
}

将参数类型声明为 List<MultipartFile> 允许为相同的参数名称解析多个文件。

@RequestParam 注解被声明为 Map<String, MultipartFile>MultiValueMap<String, MultipartFile>,且未在注解中指定参数名称时,该 Map 将填充每个给定参数名称的多部分文件。

使用 Servlet 多部分解析时,您还可以将 jakarta.servlet.http.Part 声明为方法参数或集合值类型,而不是 Spring 的 MultipartFile

您还可以将多部分内容作为数据绑定的一部分,绑定到命令对象。例如,上一个示例中的表单字段和文件可以是表单对象上的字段,如下例所示:

  • Java

  • Kotlin

class MyForm {

	private String name;

	private MultipartFile file;

	// ...
}

@Controller
public class FileUploadController {

	@PostMapping("/form")
	public String handleFormUpload(MyForm form, BindingResult errors) {
		if (!form.getFile().isEmpty()) {
			byte[] bytes = form.getFile().getBytes();
			// store the bytes somewhere
			return "redirect:uploadSuccess";
		}
		return "redirect:uploadFailure";
	}
}
class MyForm(val name: String, val file: MultipartFile, ...)

@Controller
class FileUploadController {

	@PostMapping("/form")
	fun handleFormUpload(form: MyForm, errors: BindingResult): String {
		if (!form.file.isEmpty) {
			val bytes = form.file.bytes
			// store the bytes somewhere
			return "redirect:uploadSuccess"
		}
		return "redirect:uploadFailure"
	}
}

在 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 ...

您可以使用 @RequestParamString 形式访问“元数据”部分,但您可能希望将其从 JSON 反序列化(类似于 @RequestBody)。使用 @RequestPart 注解在通过 HttpMessageConverter 转换后访问多部分:

  • Java

  • Kotlin

@PostMapping("/")
public String handle(@RequestPart("meta-data") MetaData metadata,
		@RequestPart("file-data") MultipartFile file) {
	// ...
}
@PostMapping("/")
fun handle(@RequestPart("meta-data") metadata: MetaData,
		@RequestPart("file-data") file: MultipartFile): String {
	// ...
}

您可以将 @RequestPartjakarta.validation.Valid 结合使用,或者使用 Spring 的 @Validated 注解,两者都会导致应用标准 Bean 验证。默认情况下,验证错误会导致 MethodArgumentNotValidException,这会转换为 400 (BAD_REQUEST) 响应。另外,您可以通过 ErrorsBindingResult 参数在控制器内部本地处理验证错误,如下例所示:

  • Java

  • Kotlin

@PostMapping("/")
public String handle(@Valid @RequestPart("meta-data") MetaData metadata, Errors errors) {
	// ...
}
@PostMapping("/")
fun handle(@Valid @RequestPart("meta-data") metadata: MetaData, errors: Errors): String {
	// ...
}

如果由于其他参数具有 @Constraint 注解而应用了方法验证,则会引发 HandlerMethodValidationException。有关更多详细信息,请参阅 验证 部分。

© . This site is unofficial and not affiliated with VMware.