解释
RequestContextHolder 是 Spring 框架中用于存储和检索当前 HTTP 请求的线程局部变量(ThreadLocal)的类。
它主要用于在非 Web 层的代码中访问当前的 HTTP 请求信息。以下是一些关于 RequestContextHolder 的详细说明:
- 作用
存储请求信息:在 Web 层接收到一个 HTTP 请求时,Spring 会自动将请求信息存储到 RequestContextHolder 中。
跨层访问:允许非 Web 层的代码(如服务层、数据访问层)访问当前的 HTTP 请求信息。 - 使用场景
访问请求头:在非 Web 层的代码中,你可能需要访问请求头信息(如用户身份验证令牌)。
访问请求参数:在服务层处理业务逻辑时,可能需要访问请求参数。
访问用户会话:在需要访问用户会话信息的情况下。 - 使用方法
获取当前请求:
HttpServletRequest request = RequestContextHolder.getRequest();
获取请求头:
String token = request.getHeader(“Authorization”);
获取请求参数:
String param = request.getParameter(“paramName”);
4. 注意事项
线程安全:由于 RequestContextHolder 使用了 ThreadLocal,因此它在多线程环境中是线程安全的。
每个线程都会维护自己的请求信息。
请求结束时清理:在请求结束时,Spring 会自动清理 RequestContextHolder 中的请求信息。
如果你在自定义的过滤器或拦截器中使用 RequestContextHolder,
确保调用 RequestContextHolder.resetRequestAttributes() 来清理请求信息,避免内存泄漏。
5. 替代方案
使用 @RequestHeader 和 @RequestParam:在 Spring MVC 控制器中,可以使用这些注解直接从方法参数中获取请求头和请求参数。
使用 @SessionAttribute:在需要访问会话属性的情况下,可以使用此注解。
实例代码
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
@RestController
public class MyController {
@GetMapping("/example")
public String example() {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
String token = request.getHeader("Authorization");
return "Token: " + token;
}
}