深入理解org.springframework.web.context.request.RequestContextHolder

深入理解 org.springframework.web.context.request.RequestContextHolder

在Spring Web应用中，RequestContextHolder是一个非常有用的工具类，用于在任何地方访问当前请求的上下文信息。它解决了非Controller层或非过滤器层需要访问请求上下文的问题，如在Service层或DAO层。以下是对 RequestContextHolder的详细解析。

1. RequestContextHolder简介

RequestContextHolder是Spring提供的一个持有器（holder）类，用于存储和获取当前线程的请求相关信息。它通过ThreadLocal机制，将当前请求的上下文信息与线程绑定，从而使得在应用的任何地方都能访问到这些信息。

2. RequestContextHolder的主要方法

2.1 getRequestAttributes

public static RequestAttributes getRequestAttributes() {
    return requestAttributesHolder.get();
}
​

返回当前线程绑定的 RequestAttributes，如果没有绑定则返回 null。

2.2 setRequestAttributes

public static void setRequestAttributes(@Nullable RequestAttributes attributes) {
    requestAttributesHolder.set(attributes);
}
​

将 RequestAttributes绑定到当前线程。

2.3 resetRequestAttributes

public static void resetRequestAttributes() {
    requestAttributesHolder.remove();
}
​

解除当前线程的 RequestAttributes绑定。

2.4 currentRequestAttributes

public static RequestAttributes currentRequestAttributes() throws IllegalStateException {
    RequestAttributes attributes = getRequestAttributes();
    if (attributes == null) {
        throw new IllegalStateException("No thread-bound request found: " +
            "Are you referring to request attributes outside of an actual web request, " +
            "or processing a request outside of the originally receiving thread? " +
            "If you are actually operating within a web request and still receive this message, " +
            "your code is probably running outside of DispatcherServlet: " +
            "In this case, use RequestContextListener or RequestContextFilter to expose the current request.");
    }
    return attributes;
}
​

获取当前线程的 RequestAttributes，如果没有绑定则抛出 IllegalStateException。

3. RequestContextHolder的应用场景

3.1 在Service层访问请求信息

在Service层或其他非Controller的地方，需要访问当前请求的信息，可以使用 RequestContextHolder。

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

public class MyService {

    public void logRequestDetails() {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes != null) {
            HttpServletRequest request = attributes.getRequest();
            String sessionId = request.getSession().getId();
            System.out.println("Current Session ID: " + sessionId);
        }
    }
}
​

3.2 在自定义拦截器中使用

自定义拦截器中可以通过 RequestContextHolder获取请求信息来做日志记录或其他处理。

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes != null) {
            HttpServletRequest currentRequest = attributes.getRequest();
            String requestURI = currentRequest.getRequestURI();
            System.out.println("Incoming request: " + requestURI);
        }
        return true;
    }
}
​

4. 注意事项

1. ThreadLocal的使用：RequestContextHolder使用 ThreadLocal存储请求上下文，因此在并发环境下，每个线程都有独立的请求上下文。
2. 请求生命周期：确保在请求生命周期内使用 RequestContextHolder，否则可能会抛出 IllegalStateException。
3. 集成RequestContextListener或RequestContextFilter：在非Spring管理的线程中，需要使用 RequestContextListener或 RequestContextFilter来确保请求上下文的可用性。

分析说明表

结论

RequestContextHolder是Spring提供的一个便捷工具类，用于在非Controller层访问请求上下文信息。通过理解其工作原理和应用场景，可以更好地在Spring应用中管理和使用请求信息，提升代码的可维护性和扩展性。