使用Spring的攔截器監測每個Controller或方法的執行時長

Posted on by

Spring攔截器監測每個Controller或方法的執行時長

首先寫一個類（TestInterceptor）

讓他繼承HandlerInterceptorAdapter，並重寫其中的三個方法，例如：

package com.wechat.test;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import java.util.Calendar;
import java.util.Date;
/**
 * Created by lenovo on 2017/3/14.
 */
public class TestInterceptor extends HandlerInterceptorAdapter {
    private long time;
    private int openingTime;
    private int closingTime;
    private String mappingURL;//利用正則映射到需要攔截的路徑
    public void setOpeningTime(int openingTime) {
        this.openingTime = openingTime;
    }
    public void setClosingTime(int closingTime) {
        this.closingTime = closingTime;
    }
    public void setMappingURL(String mappingURL) {
        this.mappingURL = mappingURL;
    }
    /**
     * 1.進入Controller方法之前執行
     * @param request
     * @param response
     * @param handler
     * @return 返回值為true時可繼續執行Controller，preHandle()和afterCompletion()，為false時停止執行任何方法。
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        time = System.currentTimeMillis();
        String url=request.getRequestURL().toString();
        if(mappingURL==null || url.matches(mappingURL)){
            Calendar c=Calendar.getInstance();
            c.setTime(new Date());
            int now=c.get(Calendar.HOUR_OF_DAY);
            if(now<openingTime || now>closingTime){
                request.setAttribute("msg", "註冊開放時間：" + openingTime + "：00-" + closingTime + "：00");
//                request.getRequestDispatcher("/msg.jsp").forward(request, response);
                return false;
            }
            return true;
        }
        return true;
    }
    /**
     * 2.Controller方法執行完畢但是未進行視圖渲染時執行
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        super.postHandle(request, response, handler, modelAndView);
    }
    /**
     * 3.視圖渲染完成（整個請求結束）執行
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("請求處理完成啦！用時："+(System.currentTimeMillis() - time)+"ms");
        super.afterCompletion(request, response, handler, ex);
    }
}

接下來是spring配置文件

<!--攔截器-->
<mvc:interceptors>
   <mvc:interceptor>
      <!--配置哪些請求會攔截-->
      <mvc:mapping path="/**"/>
      <bean class="com.wechat.test.TestInterceptor">
         <!--為這個類中的參數寫入值-->
         <property name="openingTime" value="16" />
         <property name="closingTime" value="18" />
         <property name="mappingURL" value=".*/index" />
      </bean>
   </mvc:interceptor>
</mvc:interceptors>

攔截器三個方法的執行時機

攔截器三個方法分別是

1. preHandle

預處理回調方法，實現處理器的預處理（如登錄檢查），第三個參數為響應的處理器（如具體的Controller實現）；

返回值：true表示繼續流程（如調用下一個攔截器或處理器）；false表示流程中斷（如登錄檢查失敗），不會繼續調用其他的攔截器或處理器，此時我們需要通過response來產生響應；

2. postHandle

後處理回調方法，實現處理器的後處理（但在渲染視圖之前），此時我們可以通過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能為null。

3. afterCompletion

整個請求處理完畢回調方法，即在視圖渲染完畢時回調，如性能監控中我們可以在此記錄結束時間並輸出消耗時間，還可以進行一些資源清理，類似於try-catch-finally中的finally，但僅調用處理器執行鏈中preHandle返回true的攔截器的afterCompletion.

首先用戶請求到達前端控制器 DispatcherServlet，前端控制器找到處理器映射器，根據請求的方法找到對應的處理器handler，生成攔截器和handler執行順序的執行鏈，交給DispatcherServlet，

dispatcherServlet找到對應的處理器適配器進行處理.

prehandler在請求處理之前執行.該方法的返回值是佈爾值 Boolean 類型的，當它返回為 false 時，表示請求結束，後續的 Interceptor 和 Controller 都不會再執行；當返回值為 true 時，就會繼續調用下一個 Interceptor 的 preHandle 方法，如果已經是最後一個 Interceptor 的時候，就會是調用當前請求的 Controller 中的方法。

postHandler 方法在當前請求進行處理之後，也就是在 Controller 中的方法調用之後執行，但是它會在 DispatcherServlet 進行視圖返回渲染之前被調用，所以我們可以在這個方法中對 Controller 處理之後的 ModelAndView 對象進行操作。

afterCompletion該方法將在整個請求結束之後，也就是在 DispatcherServlet 渲染瞭對應的視圖之後執行，這個方法的主要作用是用於進行資源清理的工作。像異常處理資源釋放會放在這一步.

多個攔截器的執行順序是: 攔截器A的preHandler–>攔截器B的preHandler–>B的postHandler–>A的postHandler–>B的afterCompletion–>A的afterCompletion

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：