SpringBoot开发——获取HTTP请求头(Header)的三种方法

文章目录

- 方法一：使用HttpServletRequest实现原理
- 方法二：使用RequestContextHolder实现原理
- 方法三：使用@RequestHeader注解实现原理
- 总结

在Spring Boot应用中，获取HTTP请求头（Header）信息是常见的需求，Spring提供了多种机制来实现这一功能。下面将详细解析每种方法的实现原理、优缺点及适用场景。

方法一：使用HttpServletRequest实现原理

HttpServletRequest接口是Servlet API的一部分，它封装了客户端发送到服务器的请求信息。通过注入HttpServletRequest对象，可以直接调用其getHeader方法获取特定的请求头信息。

代码示例

import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class HeaderController {private final HttpServletRequest request;public HeaderController(HttpServletRequest request) {this.request = request;}@GetMapping("/headers")public String getHeader() {String headerValue = request.getHeader("My-Header");return headerValue;}
}

优点

全面性：可以访问HttpServletRequest的所有功能，包括获取参数、Cookie、Session等。
直观：直接使用Servlet API，对于熟悉Servlet的开发者来说非常直接。

缺点

耦合性：控制器类与HttpServletRequest耦合，增加了测试难度。
代码冗余：在多处需要获取相同的Header时，代码重复。

适用场景
当需要访问HttpServletRequest的其他功能时，如读取参数、Cookie等。
对于复杂的应用逻辑，需要更精细的请求控制。

方法二：使用RequestContextHolder实现原理

RequestContextHolder是Spring Web MVC提供的工具类，用于存储当前线程的请求信息。通过RequestContextHolder.getRequestAttributes()可以获取当前请求的ServletRequestAttributes，进而访问HttpServletRequest。

代码示例

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class HeaderController {@GetMapping("/headers")public String getHeader() {ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();HttpServletRequest request = attributes.getRequest();String headerValue = request.getHeader("My-Header");return headerValue;}
}

优点

减少耦合：不需要直接注入HttpServletRequest，降低了控制器与其他组件的耦合度。
灵活性：可以在任何需要的地方获取请求信息，而不仅仅是控制器中。

缺点

复杂性：实现方式较为间接，对初学者来说理解成本较高。
异常处理：如果请求上下文未正确设置，可能抛出NullPointerException。

适用场景
当需要在非控制器类中访问请求信息时。
希望降低控制器与其他组件之间的耦合度。

方法三：使用@RequestHeader注解实现原理

@RequestHeader是Spring MVC提供的注解，用于自动绑定HTTP请求头到方法参数。Spring会自动从请求头中读取指定名称的值，并将其转换为对应类型，然后传递给方法参数。

代码示例

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;@RestController
public class HeaderController {@GetMapping("/headers")public String getHeader(@RequestHeader("My-Header") String headerValue) {return headerValue;}
}