@RequestHeader annotation
@RequestHeader annotation is used to bind a specific HTTP request header to a method parameter. The header value will be injected.
Syntax:
@RequestHeader(
value = "headerName",
required = true,
defaultValue = "",
)
Attributes
- value: The name of the HTTP request header to bind to. This attribute is also aliased to the name.
- required: Specify true/false whether the header is required.
- defaultValue: Default value if the header is missing.
How to Retrieve Header Values From the HTTP Request
- Using the HttpHeaders object in the controller method
- Using the HttpHeaders class
- Using the HttpServletRequest object
Use Cases For @RequestHeader in Controller Methods:
- Authentication and Authorization
- Content Negotiation
- Caching Control
- Debugging and Logging
Working With HTTP Headers in Spring MVC: A Guide to @RequestHeader and @ResponseHeader
HTTP headers are key-value pairs that are sent along with HTTP requests from clients and responses from servers. Spring MVC provides various ways to access and manipulate HTTP headers in controllers.
Below are some ways to access and manipulate HTTP headers:
- HttpServletRequest and HttpServletResponse object
- Filter interfaces
- WebMvcConfigurer
- @ModelAttribute