|
对于最新的稳定版本,请使用 Spring Framework 7.0.6! |
多部分
在 MultipartResolver 被 启用 后,POST 请求中包含 multipart/form-data 的内容将被解析并可作为常规请求参数访问。以下示例访问了一个常规表单字段和一个上传文件:
-
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> 时,如果没有在注解中指定参数名称,则会使用每个给定参数名称的multipart文件填充映射。
在使用Servlet多部分解析时,您也可以将Spring的MultipartFile声明为jakarta.servlet.http.Part,作为方法参数或集合值类型。 |
您也可以将multipart内容作为数据绑定到命令对象的一部分使用。例如,前面示例中的表单字段和文件可以是表单对象上的字段,如下例所示:
-
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 ...
你可以通过使用 @RequestParam 作为 String 来访问 "meta-data" 部分,但你可能希望它从 JSON 反序列化(类似于 @RequestBody)。使用 @RequestPart 注解来在将其与 HttpMessageConverter 转换后访问 multipart。
-
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 {
// ...
}
您可以使用 @RequestPart 结合 jakarta.validation.Valid 或使用 Spring 的
@Validated 注解,这两种方式都会导致 Standard Bean Validation 被应用。
默认情况下,验证错误会导致 MethodArgumentNotValidException,这会被转换为 400 (BAD_REQUEST) 响应。或者,您可以在控制器中通过 Errors 或 BindingResult 参数本地处理验证错误,
如下例所示:
-
Java
-
Kotlin
@PostMapping("/")
public String handle(@Valid @RequestPart("meta-data") MetaData metadata,
BindingResult result) {
// ...
}
@PostMapping("/")
fun handle(@Valid @RequestPart("meta-data") metadata: MetaData,
result: BindingResult): String {
// ...
}