一【BUG描述】

最近開發一個Web系統的過程中遇到了一個詭異的BUG，花了2天時間解決，感覺如釋重負。

這個BUG的現象是這樣的：一個很普通的JSP網頁，本來顯示很正常，後來我在這個html頁面上加了一些控制元件元素，並修改了下CSS, JavaScript程式碼，並加入了些中文字元。本來是覺得沒什麼問題，可是在伺服器上跑起來就發現瀏覽器上這個頁面顯示一片空白，同時其他頁面卻顯示正常。另外，我用的Tomcat版本是8.0.17。

那麼我第一反應就是這個頁面程式碼哪裡改錯了，可是我仔細看了下覺得又沒什麼問題，然後頁面字元編碼和Content-type都是顯示設定UTF-8編碼。看來前端好像沒什麼問題，然後我就在瀏覽器上檢視頁面原始碼，結果發現瀏覽器上顯示的HTML原始碼居然不完整，html頁面尾部的4~5行程式碼全部不見了。這就是導致頁面無法正常顯示的直接原因。

這個無非就兩種可能：瀏覽器資料沒有全部接收，或者伺服器資料沒有全部發送。這時，我就用WireShark抓包觀察，結果顯示tomcat伺服器在傳送資料時最後幾行資料根本就沒有傳送過來。而且這兒非常巧合，因為html資料以chunked的方式傳送，最後那幾行資料恰好應該全部在最後的一個chunked包裡面，換句話說，就是最後一個chunked包丟了。

為啥偏偏這個頁面的最後一個chunked包丟了，而其他頁面好好的呢？

這時沒別的辦法啦，只能一步一步除錯JSP頁面程式碼咯（這個耗費了我1天多的時間）。通過觀察其他正常顯示的JSP頁面與這個出問題的JSP頁面的執行流程，我發現問題出在：JSP頁面在tomcat中輸出的時候，最後一個chunked資料包在快取中沒有被flush。

二【定位】

為啥不flush？這個多種原因造成的:

1. JSP頁面在通過JspWriter輸出之後，其實還留了點在快取裡面。以前一般是在JSP執行完，銷燬PageContext的時候將快取中的資料flush到網路流上，可現在作者為了提高網路效能，只是將資料flush到了較低一層的CoyoteWriter的快取中，等到整個請求-響應過程結束，再flush到網路流上。如下圖：            
2. 作者想法是不錯，可惜少算了一步。CoyoteWriter物件是通過一個org.apache.catalina.connector.OutputBuffer來完成資料輸出的。這個OutputBuffer物件有個suspended（暫停）標誌位，用來隨時暫停這個輸出物件，處於暫停狀態的OutputBuffer物件是不會進行資料輸出的。tomcat在完成JspWriter輸出的工作後，提前將OutputBuffer的狀態設定為suspended狀態，這一步的意思防止響應資料輸出之後又輸出其他不該輸出的資料。這個本意是好的，可是等到整個過程結束，關閉OutputBuffer物件的時候，就因為這個suspended狀態導致close這個函式還沒來得及執行flush就直接退出了。如下圖： 

               

1. 當頁面通過OutputBuffer輸出第1個chunked包的資料的時候，這個物件偷偷將這個chunked包的字元資料轉換成二進位制資料快取了起來，並沒有真正輸出到網路流中。只有等到要輸出第二個chunked包的時候，才flush快取，將第一個包的資料輸出到網路中，為第二個chunked包騰出足夠的快取空間，並快取第二個chunked包。
2. 當OutputBuffer輸出第一個chunked資料包到網路中的時候，會搶先輸出的Http 響應頭，並將response物件的commited標誌設定為true（這就表示響應頭已經發送）。
3. 在ErrorReportValve.invoke函式中，處理完http請求後，會判斷response物件的commited標誌是否為true，如果不是true，則將OutputBuffer的suspended標誌設定為false，保證響應資料能夠輸出。
4. 好了，原因找到了：因為其他web網頁比較小，導致jsp頁面處理結束了，所有的chunked資料還在緩衝中，完全並沒有被輸出到網路中（一部分在OutputBuffer快取中，一部分在JspWriter快取中），commited標誌此時為false，等到ErrorReportValve處理時，根據commited標誌，將suspended標誌重置為false，這樣在最後關閉OutputBuffer的時候，就將所有這些快取中的資料一個個都flush到了網路上。相反，我修改的那個網頁比較大，導致OutputBuffer中途就將部分資料flush到了網路上，是的commited標誌位true，那麼ErrorReportValve也就不會將suspended標誌重置為false，導致OutputBuffer在關閉時，並不會flush殘留在快取中的資料。

三【解決】

1. 在JSP頁面最後加<% out.flush %>強制重新整理；
2. 升級或者回退Tomcat 伺服器版本；