How to get access to HTTP header information in Spring MVC REST controller?

In Spring MVC, accessing HTTP header information can be achieved through various methods, primarily relying on powerful annotations and objects provided by the Spring Framework. Here, I will outline several common approaches.

1. Using the @RequestHeader Annotation

This annotation can be used to bind request headers directly to parameters of controller methods. It is a straightforward and convenient way to access specific HTTP header information.

Example Code:

java
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HeaderController {

    @RequestMapping("/getHeaderInfo")
    public String getHeaderInfo(@RequestHeader("User-Agent") String userAgent) {
        return "User-Agent: " + userAgent;
    }
}

In the above example, we directly retrieve the User-Agent header information using @RequestHeader("User-Agent").

2. Using the HttpServletRequest Object

If you need to access multiple header values or perform more complex processing on header information, you can use the HttpServletRequest object to retrieve all request header information.

Example Code:

java
import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RequestController {

    @RequestMapping("/getAllHeaders")
    public String getAllHeaders(HttpServletRequest request) {
        Enumeration<String> headerNames = request.getHeaderNames();
        StringBuilder headers = new StringBuilder();

        while(headerNames.hasMoreElements()) {
            String headerName = headerNames.nextElement();
            String headerValue = request.getHeader(headerName);
            headers.append(headerName).append(" : ").append(headerValue).append("\n");
        }

        return headers.toString();
    }
}

In this example, we obtain an enumeration of all header names using the getHeaderNames() method of HttpServletRequest, and then retrieve the specific values for each header using the getHeader() method.

3. Using the HttpHeaders Class

Spring also provides the HttpHeaders class, which is a higher-level abstraction for handling HTTP header information.

Example Code:

java
import org.springframework.http.HttpHeaders;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HttpHeadersController {

    @RequestMapping("/useHttpHeaders")
    public String useHttpHeaders(@RequestHeader HttpHeaders headers) {
        return "Content-Type: " + headers.getContentType();
    }
}

In this example, we directly pass HttpHeaders as a parameter to the method, and then we can invoke various methods of HttpHeaders to manipulate and access header information, such as the getContentType() method to retrieve the value of the Content-Type header.

Summary

These methods provide various approaches ranging from simple to complex for accessing HTTP request headers. You can choose the most suitable method based on your specific requirements. In practical development, the @RequestHeader annotation offers a straightforward way to directly access specific header information, while HttpServletRequest and HttpHeaders provide more comprehensive and flexible handling options.