SpringMVC之RequestContextHolder詳細解析

更新時間：2023年11月28日 10:35:34 作者：ZhaoJuFei

這篇文章主要介紹了SpringMVC之RequestContextHolder詳細解析,正常來說在service層是沒有request的,然而直接從controlller傳過來的話解決方法太粗暴,后來發(fā)現(xiàn)了SpringMVC提供的RequestContextHolder,需要的朋友可以參考下

前言

最近遇到的問題是在service獲取request和response,正常來說在service層是沒有request的,然而直接從controlller傳過來的話解決方法太粗暴,后來發(fā)現(xiàn)了SpringMVC提供的RequestContextHolder遂去分析一番,并借此對SpringMVC的結構深入了解一下,后面會再發(fā)文章詳細分析源碼。

ps:正常情況下，service應該是無狀態(tài)的，這個RequestContextHolder可以在一些工具類里使用。

1.RequestContextHolder的使用

RequestContextHolder顧名思義,持有上下文的Request容器.使用是很簡單的,具體使用如下:

//兩個方法在沒有使用JSF的項目中是沒有區(qū)別的
RequestAttributes requestAttributes = RequestContextHolder.currentRequestAttributes();
//RequestContextHolder.getRequestAttributes();
//從session里面獲取對應的值
String str = (String) requestAttributes.getAttribute("name",RequestAttributes.SCOPE_SESSION);
 
HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();
HttpServletResponse response = ((ServletRequestAttributes)requestAttributes).getResponse();

看到這一般都會想到幾個問題:

request和response怎么和當前請求掛鉤?
request和response等是什么時候設置進去的?

2.解決疑問

2.1 request和response怎么和當前請求掛鉤?

首先分析RequestContextHolder這個類,里面有兩個ThreadLocal保存當前線程下的request。

// 得到存儲進去的request
private static final ThreadLocal<RequestAttributes> requestAttributesHolder =
new NamedThreadLocal<RequestAttributes>("Request attributes");
// 可被子線程繼承的request
private static final ThreadLocal<RequestAttributes> inheritableRequestAttributesHolder =
new NamedInheritableThreadLocal<RequestAttributes>("Request context");

再看`getRequestAttributes()`方法,相當于直接獲取ThreadLocal里面的值,這樣就保證了每一次獲取到的Request是該請求的request.

public static RequestAttributes getRequestAttributes() {
        RequestAttributes attributes = requestAttributesHolder.get();
        if (attributes == null) {
            attributes = inheritableRequestAttributesHolder.get();
        }
        return attributes;
    }

2.2request和response等是什么時候設置進去的?

找這個的話需要對springMVC結構的`DispatcherServlet`的結構有一定了解才能準確的定位該去哪里找相關代碼.

在IDEA中會顯示如下的繼承關系.

左邊1這里是Servlet的接口和實現(xiàn)類.

右邊2這里是使得SpringMVC具有Spring的一些環(huán)境變量和Spring容器.類似的XXXAware接口就是對該類提供Spring感知,簡單來說就是如果想使用Spring的XXXX就要實現(xiàn)XXXAware,spring會把需要的東西傳送過來.

那么剩下要分析的的就是三個類,簡單看下源碼

1. HttpServletBean 進行初始化工作

2. FrameworkServlet 初始化 WebApplicationContext,并提供service方法預處理請

3. DispatcherServlet 具體分發(fā)處理.

那么就可以在FrameworkServlet查看到該類重寫了service(),doGet(),doPost()...等方法,這些實現(xiàn)里面都有一個預處理方法`processRequest(request, response);`,所以定位到了我們要找的位置

查看`processRequest(request, response);`的實現(xiàn),具體可以分為三步:

獲取上一個請求的參數(shù)
重新建立新的參數(shù)
設置到XXContextHolder
父類的service()處理請求
恢復request
發(fā)布事

protected final void processRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
long startTime = System.currentTimeMillis();
Throwable failureCause = null;
//獲取上一個請求保存的LocaleContext
    LocaleContext previousLocaleContext = LocaleContextHolder.getLocaleContext();
//建立新的LocaleContext
    LocaleContext localeContext = buildLocaleContext(request);
//獲取上一個請求保存的RequestAttributes
    RequestAttributes previousAttributes = RequestContextHolder.getRequestAttributes();
//建立新的RequestAttributes
    ServletRequestAttributes requestAttributes = buildRequestAttributes(request, 
response, previousAttributes);
    WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
asyncManager.registerCallableInterceptor(FrameworkServlet.class.getName(), 
new RequestBindingInterceptor());
//具體設置的方法
    initContextHolders(request, localeContext, requestAttributes);
try {
        doService(request, response);
    }
catch (ServletException ex) {
failureCause = ex;
throw ex;
    }
catch (IOException ex) {
   failureCause = ex;
   throw ex;
    }
catch (Throwable ex) {
   failureCause = ex;
   throw new NestedServletException("Request processing failed", ex);
    }
finally {
//恢復
        resetContextHolders(request, previousLocaleContext, previousAttributes);
if (requestAttributes != null) {
requestAttributes.requestCompleted();
        }
if (logger.isDebugEnabled()) {
if (failureCause != null) {
this.logger.debug("Could not complete request", failureCause);
            }
else {
if (asyncManager.isConcurrentHandlingStarted()) {
                    logger.debug("Leaving response open for concurrent processing");
                }
else {
this.logger.debug("Successfully completed request");
                }
            }
        }
//發(fā)布事件
        publishRequestHandledEvent(request, response, startTime, failureCause);
    }
}

再看initContextHolders(request, localeContext, requestAttributes)方法,把新的RequestAttributes設置進LocalThread,實際上保存的類型為ServletRequestAttributes,這也是為什么在使用的時候可以把RequestAttributes強轉為ServletRequestAttributes.

private void initContextHolders(HttpServletRequest request, 
                                LocaleContext localeContext, 
                                RequestAttributes requestAttributes) {
if (localeContext != null) {
        LocaleContextHolder.setLocaleContext(localeContext, 
this.threadContextInheritable);
    }
if (requestAttributes != null) {
        RequestContextHolder.setRequestAttributes(requestAttributes, 
this.threadContextInheritable);
    }
if (logger.isTraceEnabled()) {
        logger.trace("Bound request context to thread: " + request);
    }
}

因此RequestContextHolder里面最終保存的為ServletRequestAttributes,這個類相比`RequestAttributes`方法是多了很多

到此這篇關于SpringMVC之RequestContextHolder詳細解析的文章就介紹到這了,更多相關RequestContextHolder詳細解析內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: