Top Description Methods
org.springframework.web.bind.annotation

public @Interface RequestPart

extends Annotation
Annotations
@Target:PARAMETER
@Retention:RUNTIME
@Documented
Imports
java.beans.PropertyEditor, java.lang.annotation.Documented, .ElementType, .Retention, .RetentionPolicy, .Target, org.springframework.core.annotation.AliasFor, org.springframework.core.convert.converter.Converter, org.springframework.http.converter.HttpMessageConverter, org.springframework.web.multipart.MultipartFile, .MultipartResolver

Annotation that can be used to associate the part of a "multipart/form-data" request with a method argument.

Supported method argument types include MultipartFile in conjunction with Spring's MultipartResolver abstraction, jakarta.servlet.http.Part in conjunction with Servlet multipart requests, or otherwise for any other method argument, the content of the part is passed through an HttpMessageConverter taking into consideration the 'Content-Type' header of the request part. This is analogous to what @RequestBody does to resolve an argument based on the content of a non-multipart regular request.

Note that @RequestParam annotation can also be used to associate the part of a "multipart/form-data" request with a method argument supporting the same method argument types. The main difference is that when the method argument is not a String or raw MultipartFile / Part, @RequestParam relies on type conversion via a registered Converter or PropertyEditor while RequestPart relies on HttpMessageConverters taking into consideration the 'Content-Type' header of the request part. RequestParam is likely to be used with name-value form fields while RequestPart is likely to be used with parts containing more complex content e.g. JSON, XML).

Authors
Rossen Stoyanchev, Arjen Poutsma, Sam Brannen
Since
3.1
See Also
RequestParam, org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter

Method Summary

Modifier and TypeMethod and Description
public String
name()

The name of the part in the "multipart/form-data" request to bind to.

public boolean
required()

Whether the part is required.

public String
value()

Alias for name.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

nameback to summary
public String name()

The name of the part in the "multipart/form-data" request to bind to.

Annotations
@AliasFor:value
Since
4.2
requiredback to summary
public boolean required()

Whether the part is required.

Defaults to true, leading to an exception being thrown if the part is missing in the request. Switch this to false if you prefer a null value if the part is not present in the request.

valueback to summary
public String value()

Alias for name.

Annotations
@AliasFor:name