【雜談】tocmat是何時寫回響應資料包的

貓毛·波拿巴發表於2019-02-13

疑問的產生

這個疑問是我在寫檔案下載的時候產生的，我是用HttpServletResponse獲取到Outputstream，然後利用OutputStream直接寫資料的。當時我就想這個OutputStream是不是就是對應的Socket連線的OutputStream。即是不是的程式在用stream寫的時候，資料也同時在發？

Response的OutputStream把資料寫到哪去？

於是我看了下HttpServletResponse的getOutputStream方法，看看它註釋是怎麼說的。

    /**
     * Returns a {@link ServletOutputStream} suitable for writing binary 
     * data in the response. The servlet container does not encode the
     * binary data.  
     *
     * <p> Calling flush() on the ServletOutputStream commits the response.
     *
     * Either this method or {@link #getWriter} may 
     * be called to write the body, not both, except when {@link #reset}
     * has been called.
     *
     * @return a {@link ServletOutputStream} for writing binary data 
     *
     * @exception IllegalStateException if the <code>getWriter</code> method
     * has been called on this response
     *
     * @exception IOException if an input or output exception occurred
     *
     * @see #getWriter
     * @see #reset
     */
    public ServletOutputStream getOutputStream() throws IOException;

以上，註釋有說明是OutputStream是用來寫響應body內容的，也有提到flush()方法，說明肯定是有緩衝的，所以應該不是直接操作socket寫資料。我猜測應該是有一個位元組陣列用來暫時儲存，然後統一flush。但是還是不太確定，於是簡單翻閱了下tomcat原始碼。

 

找到ServletOutputStream的實現類CoyoteOuputStream。它實現了OutputStream的抽象方法write，把資料寫入到OutputBuffer型別的欄位中存著。而這個OutputBuffer物件來自於coyote/Response。其實這個OutputBuffer也只是一個介面，具體實現一直向下翻是StreamOutputBuffer。資料大小沒有限制，是用連結串列儲存的，每個連結串列節點儲存8196位元組。

什麼時候把響應資料包返回給客戶端？

其實就是檢視，它是何時呼叫OutputBuffer的flush方法的。我逐層檢視，最終定位到了connector/Response的finishResponse()方法。這個方法，會先傳送響應行和響應頭。然後再傳送響應body。Tomcat的原始碼我看的不多，這裡找到一張不錯的時序圖，描述的是一個HTTP請求的處理過程。如下，我們把重點放在servlet的service方法呼叫，和Response的fininshResponse方法呼叫上。可以得到，在service方法返回後，執行的就是finishResponse操作。也就是說，當servlet程式處理完這個請求後，tomcat就會把響應結果發回客戶端

注意：servlet的程式不參與底層資料的收發，或者說不控制

servlet的service方法呼叫在圖中哪裡？

包含在ApplicationFilterChain的internalDoFilter方法中。

servlet程式處理請求指的是什麼？

根本上servlet程式做的工作就是，根據Request的資訊，填充Response資訊而已。

servlet程式與Spring MVC是什麼關係？

Spring MVC底層還是Serlvet，它是把所有請求都用一個servlet處理，這個servlet叫做DispatcherServlet，而它又把請求分發給對應的@RequestMapping標註的方法進行處理。整體上來說就是完成一個service方法的呼叫。

那MVC的返回頁面，返回REST資料是怎麼回事？

返回頁面就是把頁面資料寫入到響應Body中；@ResponseBody註解，實際上就是把@RequestMapping標註的方法的返回值轉為JSON字串寫入到響應Body中。這裡的響應Body指的就是前文中的OutputBuffer.

Tomcat與Servlet程式的職責

《How Tomcat works》中講到，Servlet容器（Tomcat就是一種Servlet容器）的任務有概括地講有三個

1.建立一個Request物件，並填充相關資訊（parameters、headers、cookie、uri等）

2.建立一個Response物件

3.呼叫與此請求關聯的Servlet的service方法，把Request和Response傳給它。

這裡我用自己的話講一下：當瀏覽器向服務端發來一個請求時，服務端會將請求資料包的內容解析出來，建立一個填充有請求資訊的Request物件，同時建立一個"空的"Response物件，然後把這兩個物件傳給servlet的service方法，讓它來完成Response物件的填充，最後把Response資料傳送給客戶端。

為什麼要傳Request物件？

你不傳Request物件，Servlet程式就不知道該填充什麼。換句話說，它不知道你到底想要什麼資源。

Tomcat是如何找到請求關聯的Servlet的？

我們知道，Tomcat在開發的時候不可能知道你會往它裡面部署什麼專案，servlet程式叫什麼。所以它不可能硬編碼來呼叫service方法，它所使用的就是反射機制。

想想在使用spring boot框架開發之前，我們是怎麼部署專案的？就是把專案打包，然後放到Tomcat的webapp目錄下。跑起來後，專案對應的URL就是localhost:8080/projectName/xxx這樣是吧。而且，在專案中，不管是註解式的，還是web.xml式，都會配置Servlet程式的對映。把URL對映到某個Servlet類檔案。

當請求來臨時，先根據projectName找到對應專案，再根據後續的URL對映到對應的Servlet類名。之後Tomcat就會利用反射機制載入Servlet類檔案，獲取例項，然後再呼叫service方法。

coyote/Response、connector/Response、connector/ResponseFacade之間的關係？

 coyote/Response主要就是跟底層的資料傳遞掛鉤的，而connector/Response是coyote/Response的上層包裝，它實現了HttpServletResponse介面。但是如果將它直接傳給service方法，則害怕使用者直接將HttpServletResponse強轉為connector/Response，直接呼叫底層的一些方法。所以引入了一個使用"Facade模式"，將connector/Response除了HttpServletResponse介面定義的public方法都遮蔽掉。也就是說，傳遞給service的實際上是connector/ResponseFacade物件，就算強轉為實際型別，也只能看到HttpServletResponse介面定義的方法。

相關文章