Java interceptor 攔截器

百聯達發表於2016-12-08
Java
一：攔截器的應用場景

1、日誌記錄：記錄請求資訊的日誌，以便進行資訊監控、資訊統計、計算PV（Page VIEW）等。
2、許可權檢查：如登入檢測，進入處理器檢測檢測是否登入，如果沒有直接返回到登入頁面；
3、效能監控：有時候系統在某段時間莫名其妙的慢，可以通過攔截器在進入處理器之前記錄開始時間，在處理完後記錄結束時間，從而得到該請求的處理時間（如果有反向代理，如apache可以自動記錄）；
4、通用行為：讀取cookie得到使用者資訊並將使用者物件放入請求，從而方便後續流程使用，還有如提取Locale、Theme資訊等，只要是多個處理器都需要的即可使用攔截器實現。
5、OpenSessionInView：如Hibernate，在進入處理器開啟SESSION，在完成後關閉SESSION。

二：攔截器與過濾器的區別

 1、攔截器是基於Java的反射機制的，而過濾器是基於函式回撥。
 2、攔截器不依賴與servlet容器，過濾器依賴與servlet容器。
 3、攔截器只能對ACTION請求起作用，而過濾器則可以對幾乎所有的請求起作用。
 4、攔截器可以訪問ACTION上下文、值棧裡的物件，而過濾器不能訪問。
 5、在ACTION的生命週期中，攔截器可以多次被呼叫，而過濾器只能在容器初始化時被呼叫一次。
 6、攔截器可以獲取IOC容器中的各個bean，而過濾器就不行，這點很重要，在攔截器裡注入一個service，可以呼叫業務邏輯。


三：攔截器的實現

1.過濾器是JavaEE標準，採用函式回撥的方式進行。是在請求進入容器之後，還未進入Servlet之前進行預處理，並且在請求結束返回給前端這之間進行後期處理。

點選(此處)摺疊或開啟

  1. @Override
  2.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
  3.         System.out.println("before...");
  4.         chain.doFilter(request, response);
  5.         System.out.println("after...");
  6.     }
chain.doFilter(request, response);這個方法的呼叫作為分水嶺。事實上呼叫Servlet的doService()方法是在chain.doFilter(request, response);這個方法中進行的。

2.攔截器是被包裹在過濾器之中的。

點選(此處)摺疊或開啟

  1. @Override
  2.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  3.         System.out.println("preHandle");
  4.         return true;
  5.     }

  7.     @Override
  8.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  9.         System.out.println("postHandle");
  10.     }

  12.     @Override
  13.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  14.         System.out.println("afterCompletion");
  15.     }
a.preHandle()這個方法是在過濾器的chain.doFilter(request, response)方法的前一步執行，也就是在 [System.out.println("before...")][chain.doFilter(request, response)]之間執行。
b.preHandle()方法之後，在RETURN ModelAndView之前進行，可以操控Controller的ModelAndView內容。
c.afterCompletion()方法是在過濾器返回給前端前一步執行，也就是在[chain.doFilter(request, response)][System.out.println("after...")]之間執行。

四：SpringMvc 攔截器和過濾器執行流程




五：例項

點選(此處)摺疊或開啟

  1. public class SystemAccessInterceper extends HandlerInterceptorAdapter {

  3.     private final String checkpointName = "DO_CHECKPOINT";
  4.     private final String shareType = "enjoylink_share";
  5.     String[] noFilters = ConfigureUtil.getStringArray("nofilter.urls");

  7.     private final Logger logger = Logger.getLogger(getClass());

  9.     @Override
  10.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
  11.             throws Exception {
  12.         String userAgent = request.getHeader("user-agent");
  13.         userAgent = StringUtils.startsWith(userAgent, Constants.USER_AGENT) ? userAgent
  14.                 : request.getHeader("x-user-agent");
  15.         String type = request.getParameter("shareType");
  16.         String requestUri = request.getRequestURI();
  17.         if (isFilter(requestUri)) {
  18.             return true;
  19.         }
  20.         logger.info("User-Agent:" + userAgent);
  21.         if (!StringUtils.equalsIgnoreCase(shareType, type) && (!StringUtils.startsWith(userAgent, Constants.USER_AGENT)
  22.                 || 2 > StringUtils.indexOfAny(userAgent, "|"))) {
  23.             logger.info("非法請求介面！！");
  24.             return false;
  25.         }

  27.         try {
  28.             if (StringUtils.contains(userAgent, "|")) {
  29.                 String[] agts = userAgent.split("\\|");
  30.                 request.setAttribute(Constants.HEAD_SYS, agts[1]);
  31.                 request.setAttribute(Constants.HEAD_VERSION, agts[2]);
  32.             }
  33.             request.setAttribute(Constants.LOG_ACCESS_TIME, System.currentTimeMillis());
  34.             return super.preHandle(request, response, handler);
  35.         }
  36.         catch (Exception e) {
  37.             logger.error("攔截器驗證失敗！", e);
  38.             return false;
  39.         }
  40.     }

  42.     /**
  43.      * TODO: 檢查是否需要過濾
  44.      *
  45.      * @param uri
  46.      * @return
  47.      */
  48.     private boolean isFilter(String uri) {
  49.         if (org.apache.commons.lang3.ArrayUtils.isEmpty(noFilters)) {
  50.             return Boolean.TRUE;
  51.         }

  53.         for (String noFilter : noFilters) {
  54.             if (StringUtils.contains(uri, noFilter)) {
  55.                 return Boolean.TRUE;
  56.             }
  57.         }

  59.         return Boolean.FALSE;
  60.     }

  62.     @Override
  63.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
  64.             throws Exception {
  65.         super.afterCompletion(request, response, handler, ex);
  66.         Object obj = request.getAttribute(Constants.LOG_ACCESS_TIME);
  67.         if (null != obj) {
  68.             Object rb = request.getAttribute(Constants.RETURN_BODY);
  69.             long accessTime = (long) obj;
  70.             if (null == rb || StringUtils.isEmpty(rb.toString())) {
  71.                 logger.info("不進行檢查點處理！");
  72.                 logger.info("處理請求" + request.getRequestURI() +"耗時"+ (System.currentTimeMillis() - accessTime) + "毫秒！");
  73.                 return;
  74.             }
  75.             Object userId = request.getAttribute(Constants.REQUEST_USERID);
  76.             String system = request.getAttribute(Constants.HEAD_SYS).toString();
  77.             String version = request.getAttribute(Constants.HEAD_VERSION).toString();

  79.             logger.warn("處理請求|" + ((null == userId || "".equals(userId.toString())) ? "0" : userId.toString()) + "|"
  80.                     + system + "|" + version + "|" + request.getRequestURI() + "|"
  81.                     + GbdDateUtils.format(Calendar.getInstance().getTime(), "yyyy-MM-dd HH:mm:ss") + "|"
  82.                     + (System.currentTimeMillis() - accessTime) + "|毫秒！");
  83.             try {
  84.                 HandlerMethod handlerMethod = (HandlerMethod) handler;
  85.                 BusinessCheckPoint checkPoint = handlerMethod.getMethodAnnotation(BusinessCheckPoint.class);
  86.                 if (null != checkPoint) {
  87.                     String checkpointKey = checkPoint.checkName();

  89.                     // 業務處理結果為正確時。傳送積分或者信用累積
  90.                     if (null != rb && null != userId && StringUtils.isNotEmpty(userId.toString())) {
  91.                         ReturnBody returnBody = (ReturnBody) rb;
  92.                         // 檢查點檢測，如果是檢查點則傳送訊息
  93.                         if (returnBody.getCode() > 0) {
  94.                             // 傳送檢查點訊息
  95.                             CodeDesc codeDesc = new CodeDesc();
  96.                             codeDesc.setJmsType(checkpointName);
  97.                             codeDesc.setName(checkpointKey);
  98.                             codeDesc.setBusinessCode(returnBody.getCheckpointCode());
  99.                             codeDesc.setUserId(Integer.valueOf(userId.toString()));
  100.                             JmsUtil.pushToUserQueue(codeDesc);
  101.                         }
  102.                     }
  103.                 }
  104.             }
  105.             catch (Exception e) {
  106.                 logger.error("傳送積分訊息失敗！", e);
  107.             }
  108.         }
  109.     }

  111. }


點選(此處)摺疊或開啟

  1. <!-- 攔截器配置 -->
  2.     <mvc:interceptors>
  3.         <bean class="com.gemdale.ghome.business.intercepter.SystemAccessInterceper" />
  4.     </mvc:interceptors>



來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/28624388/viewspace-2130071/，如需轉載，請註明出處，否則將追究法律責任。

相關文章