Spring MVC 中 HandlerInterceptorAdapter的使用

瓜瓜東西發表於2014-11-28
SpringMVCAPT
一般情況下，對來自瀏覽器的請求的攔截，是利用Filter實現的，這種方式可以實現Bean預處理、後處理。 
Spring MVC的攔截器不僅可實現Filter的所有功能，還可以更精確的控制攔截精度。 

Spring為我們提供了org.springframework.web.servlet.handler.HandlerInterceptorAdapter這個介面卡，繼承此類，可以非常方便的實現自己的攔截器。他有三個方法：


[java] view plaincopy
  1. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)    
  2.         throws Exception {    
  3.         return true;    
  4.     }    
  5.     public void postHandle(    
  6.             HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)    
  7.             throws Exception {    
  8.     }    
  9.     public void afterCompletion(    
  10.             HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)    
  11.             throws Exception {    
  12.     }    

分別實現預處理、後處理（呼叫了Service並返回ModelAndView，但未進行頁面渲染）、返回處理（已經渲染了頁面） 
在preHandle中，可以進行編碼、安全控制等處理； 
在postHandle中，有機會修改ModelAndView； 
在afterCompletion中，可以根據ex是否為null判斷是否發生了異常，進行日誌記錄。 

如果基於xml配置使用Spring MVC，
可以利用SimpleUrlHandlerMapping、BeanNameUrlHandlerMapping進行Url對映（相當於struts的path對映）和攔截請求（注入interceptors），
如果基於註解使用Spring MVC，可以使用DefaultAnnotationHandlerMapping注入interceptors。
注意無論基於xml還是基於註解，HandlerMapping bean都是需要在xml中配置的。 

一個demo： 
在這個例子中，我們假設UserController中的註冊操作只在9：00-12：00開放，那麼就可以使用攔截器實現這個功能。 


[java] view plaincopy
  1. public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {    
  2.     private int openingTime;    
  3.     private int closingTime;    
  4.     private String mappingURL;//利用正則對映到需要攔截的路徑    
  5.     public void setOpeningTime(int openingTime) {    
  6.         this.openingTime = openingTime;    
  7.     }    
  8.     public void setClosingTime(int closingTime) {    
  9.         this.closingTime = closingTime;    
  10.     }    
  11.     public void setMappingURL(String mappingURL) {    
  12.         this.mappingURL = mappingURL;    
  13.     }    
  14.     @Override    
  15.     public boolean preHandle(HttpServletRequest request,    
  16.             HttpServletResponse response, Object handler) throws Exception {    
  17.         String url=request.getRequestURL().toString();    
  18.         if(mappingURL==null || url.matches(mappingURL)){    
  19.             Calendar c=Calendar.getInstance();    
  20.             c.setTime(new Date());    
  21.             int now=c.get(Calendar.HOUR_OF_DAY);    
  22.             if(now<openingTime || now>closingTime){    
  23.                 request.setAttribute("msg", "註冊開放時間：9：00-12：00");    
  24.                 request.getRequestDispatcher("/msg.jsp").forward(request, response);    
  25.                 return false;    
  26.             }    
  27.             return true;    
  28.         }    
  29.         return true;    
  30.     }    
  31. }    

xml配置： 


[html] view plaincopy
  1. <bean id="timeBasedAccessInterceptor" class="com.spring.handler.TimeBasedAccessInterceptor">    
  2.     <property name="openingTime" value="9" />    
  3.     <property name="closingTime" value="12" />    
  4.     <property name="mappingURL" value=".*/user\.do\?action=reg.*" />    
  5. </bean>    
  6. <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">    
  7.     <property name="interceptors">    
  8.         <list>    
  9.             <ref bean="timeBasedAccessInterceptor"/>    
  10.         </list>    
  11.     </property>    
  12. </bean>    

這裡我們定義了一個mappingURL屬性，實現利用正規表示式對url進行匹配，從而更細粒度的進行攔截。當然如果不定義mappingURL，則預設攔截所有對Controller的請求。 

UserController： 

[java] view plaincopy
  1. @Controller    
  2. @RequestMapping("/user.do")    
  3. public class UserController{    
  4.     @Autowired    
  5.     private UserService userService;    
  6.     @RequestMapping(params="action=reg")    
  7.     public ModelAndView reg(Users user) throws Exception {    
  8.         userService.addUser(user);    
  9.         return new ModelAndView("profile","user",user);    
  10.     }    
  11.     // other option ...    
  12. }    

這個Controller相當於Struts的DispatchAction 

你也可以配置多個攔截器，每個攔截器進行不同的分工. 

相關文章