Spring Web 6.1.4 · org.springframework.web.bind.support.WebRequestDataBinder

Special org.springframework.validation.DataBinder to perform data binding from web request parameters to JavaBeans, including support for multipart files.

Warning

Data binding can lead to security issues by exposing parts of the object graph that are not meant to be accessed or modified by external clients. Therefore the design and use of data binding should be considered carefully with regard to security. For more details, please refer to the dedicated sections on data binding for Spring Web MVC and Spring WebFlux in the reference manual.

See the DataBinder/WebDataBinder superclasses for customization options, which include specifying allowed/required fields, and registering custom property editors.

Can also used for manual data binding in custom web controllers or interceptors that build on Spring's org.springframework.web.context.request.WebRequest abstraction: e.g. in a org.springframework.web.context.request.WebRequestInterceptor implementation. Simply instantiate a WebRequestDataBinder for each binding process, and invoke bind with the current WebRequest as argument:

MyBean myBean = new MyBean();
// apply binder to custom target object
WebRequestDataBinder binder = new WebRequestDataBinder(myBean);
// register custom editors, if desired
binder.registerCustomEditor(...);
// trigger actual binding of request parameters
binder.bind(request);
// optionally evaluate binding errors
Errors errors = binder.getErrors();
...

Field Summary

Inherited from org.springframework.web.bind.WebDataBinder:: DEFAULT_FIELD_DEFAULT_PREFIX DEFAULT_FIELD_MARKER_PREFIX

Constructor Summary

Access	Constructor and Description
public	WebRequestDataBinder(Object the target object to bind onto (or `null` if the binder is just used to convert a plain parameter value) target) Create a new WebRequestDataBinder instance, with default object name.
public	WebRequestDataBinder(Object the target object to bind onto (or `null` if the binder is just used to convert a plain parameter value) target, String the name of the target object objectName) Create a new WebRequestDataBinder instance.

Method Summary

Modifier and Type	Method and Description
public void	bind(WebRequest the request with parameters to bind (can be multipart) request) Bind the parameters of the given request to this binder's target, also binding multipart files in case of a multipart request.
public void	closeNoCatch() Treats errors as fatal.
public void	construct(WebRequest the request to bind request) Use a default or single data constructor to create the target by binding request parameters, multipart files, or parts to constructor args.
protected boolean	shouldConstructArgument(MethodParameter param) Overrides org.springframework.validation.DataBinder.shouldConstructArgument. Whether to instantiate the constructor argument of the given type, matching its own constructor arguments to bind values.

Inherited from org.springframework.web.bind.WebDataBinder:: adaptEmptyArrayIndices bindMultipart checkFieldDefaults checkFieldMarkers doBind getEmptyValue getEmptyValue getFieldDefaultPrefix getFieldMarkerPrefix isBindEmptyMultipartFiles resolvePrefixValue setBindEmptyMultipartFiles setFieldDefaultPrefix setFieldMarkerPrefix

Constructor Detail

WebRequestDataBinder back to summary

WebRequestDataBinder	back to summary
public WebRequestDataBinder(Object target) Create a new WebRequestDataBinder instance, with default object name. Parameters target:Object the target object to bind onto (or `null` if the binder is just used to convert a plain parameter value) See Also `DEFAULT_OBJECT_NAME`

public WebRequestDataBinder(Object target)

Create a new WebRequestDataBinder instance, with default object name.

Parameters

target:Object: the target object to bind onto (or null if the binder is just used to convert a plain parameter value)

See Also

DEFAULT_OBJECT_NAME

WebRequestDataBinder back to summary

WebRequestDataBinder	back to summary
public WebRequestDataBinder(Object target, String objectName) Create a new WebRequestDataBinder instance. Parameters target:Object the target object to bind onto (or `null` if the binder is just used to convert a plain parameter value) objectName:String the name of the target object

public WebRequestDataBinder(Object target, String objectName)

Create a new WebRequestDataBinder instance.

Parameters

target:Object: the target object to bind onto (or null if the binder is just used to convert a plain parameter value)
objectName:String: the name of the target object

Method Detail

bind back to summary

bind	back to summary
public void bind(WebRequest request) Bind the parameters of the given request to this binder's target, also binding multipart files in case of a multipart request. This call can create field errors, representing basic binding errors like a required field (code "required"), or type mismatch between value and bean property (code "typeMismatch"). Multipart files are bound via their parameter name, just like normal HTTP parameters: i.e. "uploadedFile" to an "uploadedFile" bean property, invoking a "setUploadedFile" setter method. The type of the target property for a multipart file can be MultipartFile, byte[], or String. Servlet Part binding is also supported when the request has not been parsed to MultipartRequest via MultipartResolver. Parameters request:WebRequest the request with parameters to bind (can be multipart) See Also `org.springframework.web.multipart.MultipartRequest`, `org.springframework.web.multipart.MultipartFile`, `jakarta.servlet.http.Part`, `bind(org.springframework.beans.PropertyValues)`

public void bind(WebRequest request)

Bind the parameters of the given request to this binder's target, also binding multipart files in case of a multipart request.

This call can create field errors, representing basic binding errors like a required field (code "required"), or type mismatch between value and bean property (code "typeMismatch").

Multipart files are bound via their parameter name, just like normal HTTP parameters: i.e. "uploadedFile" to an "uploadedFile" bean property, invoking a "setUploadedFile" setter method.

The type of the target property for a multipart file can be MultipartFile, byte[], or String. Servlet Part binding is also supported when the request has not been parsed to MultipartRequest via MultipartResolver.

Parameters

request:WebRequest: the request with parameters to bind (can be multipart)

closeNoCatch	back to summary
public void closeNoCatch() throws BindException Treats errors as fatal. Use this method only if it's an error if the input isn't valid. This might be appropriate if all input is from dropdowns, for example. Exceptions BindException: if binding errors have been encountered

closeNoCatch

back to summary

public void closeNoCatch() throws BindException

Treats errors as fatal.

Use this method only if it's an error if the input isn't valid. This might be appropriate if all input is from dropdowns, for example.

Exceptions

BindException:: if binding errors have been encountered

construct back to summary

construct	back to summary
public void construct(WebRequest request) Use a default or single data constructor to create the target by binding request parameters, multipart files, or parts to constructor args. After the call, use `getBindingResult()` to check for bind errors. If there are none, the target is set, and `bind(WebRequest)` can be called for further initialization via setters. Parameters request:WebRequest the request to bind Since 6.1

public void construct(WebRequest request)

Use a default or single data constructor to create the target by binding request parameters, multipart files, or parts to constructor args.

After the call, use getBindingResult() to check for bind errors. If there are none, the target is set, and bind(WebRequest) can be called for further initialization via setters.

Parameters

request:WebRequest: the request to bind

Since

6.1

shouldConstructArgument	back to summary
protected boolean shouldConstructArgument(MethodParameter param) Overrides org.springframework.validation.DataBinder.shouldConstructArgument. Doc from org.springframework.validation.DataBinder.shouldConstructArgument. Whether to instantiate the constructor argument of the given type, matching its own constructor arguments to bind values. By default, simple value types, maps, collections, and arrays are excluded from nested constructor binding initialization. Annotations @Override

shouldConstructArgument

back to summary

protected boolean shouldConstructArgument(MethodParameter param)

Overrides org.springframework.validation.DataBinder.shouldConstructArgument.

Doc from org.springframework.validation.DataBinder.shouldConstructArgument.

Whether to instantiate the constructor argument of the given type, matching its own constructor arguments to bind values.

By default, simple value types, maps, collections, and arrays are excluded from nested constructor binding initialization.

Annotations

@Override

public Class WebRequestDataBinder

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail