Package org.springframework.web.bind.annotation

Annotation Interface RequestAttribute

@Target(PARAMETER)
@Retention(RUNTIME)
@Documented
public @interface RequestAttribute

Annotation to bind a method parameter to a request attribute.

The main motivation is to provide convenient access to request attributes from a controller method with an optional/required check and a cast to the target method parameter type.

Since:

4.3

Author:

Rossen Stoyanchev

See Also:

• RequestMapping
• SessionAttribute

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	name	The name of the request attribute to bind to.
boolean	required	Whether the request attribute is required.
String	value	Alias for name().

Element Details

value

@AliasFor("name")
String value

Alias for name().

Default:

""

name

@AliasFor("value")
String name

The name of the request attribute to bind to.

The default name is inferred from the method parameter name.

Default:

""

required

boolean required

Whether the request attribute is required.

Defaults to true, leading to an exception being thrown if the attribute is missing. Switch this to false if you prefer a null or Java 8 java.util.Optional if the attribute doesn't exist.

Default:

true