Spring拦截器中通过request获取到该请求对应Controller中的method对象

转别人的，非原创

背景：项目使用Spring 3.1.0.RELEASE，从dao到Controller层全部是基于注解配置。我的需求是想在自定义的Spring拦截器中通过request获取到该请求对应于Controller中的目标method方法对象。Controller和拦截器代码如下：

 

AdminController

 

Java代码  

1. @Controller  
2. @RequestMapping("/admin")  
3. public class AdminController {  
4.   
5.     /** 
6.      * init:初始页面. <br/> 
7.      * 
8.      * @author chenzhou 
9.      * @param request 请求 
10.      * @param response 响应 
11.      * @return 登陆页 
12.      * @since JDK 1.6 
13.      */  
14.     @RequestMapping("/init")  
15.     public ModelAndView init(HttpServletRequest request,  
16.             HttpServletResponse response){  
17.         Map<String, Object> model = new HashMap<String, Object>();  
18.         List<Role> roleList = this.adminService.getRoleList();  
19.         model.put("roleList", roleList);  
20.         return new ModelAndView(this.getLoginPage(), model);  
21.     }  
22.   
23.     //……  
24. }  

 

 

LoginInterceptor

 

Java代码  

1. public class LoginInterceptor extends HandlerInterceptorAdapter {  
2.     /** 
3.      * This implementation always returns <code>true</code>. 
4.      */  
5.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)  
6.         throws Exception {  
7.         return true;  
8.     }  
9.   
10.     /** 
11.      * This implementation is empty. 
12.      */  
13.     public void postHandle(  
14.             HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)  
15.             throws Exception {  
16.     }  
17.   
18.     /** 
19.      * This implementation is empty. 
20.      */  
21.     public void afterCompletion(  
22.             HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)  
23.             throws Exception {  
24.     }  
25. }  

 

servlet xml配置文件定义：

Xml代码  

1. <bean class="org.springframework.aop.aspectj.annotation.AnnotationAwareAspectJAutoProxyCreator" />   
2. <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>  
3. <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">  
4.     <property name="interceptors">  
5.         <list>  
6.             <bean class="com.chenzhou.examples.erm.util.interceptor.LoginInterceptor"/>  
7.         </list>  
8.     </property>  
9. </bean>    

     我的需求是想在preHandle方法中通过request获取该请求访问的目标Controller中的方法对象。之前找了很久也没有找到比较好的方案，就采取了最老土的通过比较requestURL和Controller类和方法上的RequestMappingURL来进行获取，这样也能勉强实现，但是这种方式我自己都觉得特别恶心。首先，这种方式需要使用反射来获取Controller中的所有方法，然后遍历method数组，逐个进行RequestMappingURL的比对，效率低下。其次，如果RequestMapping定义了类似于@RequestMapping("/{id}")这种动态参数url，则无法进行比较。

     因为上面这种方式不好，我就一直想找一个更好的方案。不得已只能向人求助，第一个就想到了Iteye上对于Spring研究得很熟悉的jinnianshilongnian龙年兄，我相信经常上iteye的博友们对龙年兄应该都很熟悉。龙年兄给了我一个方案，就是通过把handler对象转换为HandlerMethod类型，然后直接getMethod，代码如下：

 

Java代码  

1. /** 
2.  * This implementation always returns <code>true</code>. 
3.  */  
4. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)  
5.     throws Exception {  
6.     System.out.println("*********************preHandle********************");  
7.     System.out.println(handler.getClass());  
8.     HandlerMethod handlerMethod = (HandlerMethod) handler;  
9.     System.out.println(handlerMethod.getMethod());  
10.     return true;  
11. }  

 

注：HandlerMethod类是Spring 3.1.0.RELEASE版本中才有的，之前我使用的Spring 3.0.6.RELEASE版本，里面是找不到这个类的

 

根据龙年兄提供的方法，测试之后报错，报错信息如下：

 

Shell代码  

1. *********************preHandle********************  
2. class com.chenzhou.examples.erm.web.AdminController  
3. 2012-10-21 16:28:25 org.apache.catalina.core.StandardWrapperValve invoke  
4. 严重: Servlet.service() for servlet erm threw exception  
5. java.lang.ClassCastException: com.chenzhou.examples.erm.web.AdminController cannot be cast to org.springframework.web.method.HandlerMethod  
6.     at com.chenzhou.examples.erm.util.interceptor.LoginInterceptor.preHandle(LoginInterceptor.java:37)  
7.     at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:891)  
8.     at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:827)  
9.     at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:882)  
10.     at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:778)  
11.     at javax.servlet.http.HttpServlet.service(HttpServlet.java:617)  
12.     at javax.servlet.http.HttpServlet.service(HttpServlet.java:717)  
13. ……  

 

    根据错误提示可以看出是HandlerMethod handlerMethod = (HandlerMethod) handler;这一步报错了，根据System.out.println(handler.getClass());打印的结果可以得知handler是该请求访问的Controller类，无法转换成HandlerMethod对象。这次还是龙年兄帮我找出了原因，解决方案是使用

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"> 
替换 
<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/> 

因为DefaultAnnotationHandlerMapping只能返回Controller对象，不会映射到Controller中的方法级别。替换之后servlet xml配置如下：

 

Xml代码  

1. <bean class="org.springframework.aop.aspectj.annotation.AnnotationAwareAspectJAutoProxyCreator" />   
2. <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>  
3. <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">   
4.     <property name="interceptors">  
5.         <list>  
6.             <bean class="com.chenzhou.examples.erm.util.interceptor.LoginInterceptor"/>  
7.         </list>  
8.     </property>  
9. </bean>  

 

    重启tomcat测试之后发现再次报错，报了另外一个错误，具体信息如下：

 

Shell代码  

1. 2012-10-21 16:39:39 org.apache.catalina.core.StandardWrapperValve invoke  
2. 严重: Servlet.service() for servlet erm threw exception  
3. javax.servlet.ServletException: No adapter for handler [public org.springframework.web.servlet.ModelAndView com.chenzhou.examples.erm.web.AdminController.init(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)]: Does your handler implement a supported interface like Controller?  
4. ……  

 

    这一次，请求根本没有到达拦截器容器就已经报错了，错误提示的意思是找不到handler对象对应的Adapter类。我在RequestMappingHandlerMapping类对应的spring-webmvc-3.1.0.RELEASE.jar 包里找到了该类对应的Adapter类：RequestMappingHandlerAdapter，然后在servlet xml中进行了配置：

 

Xml代码  

1. <bean class="org.springframework.aop.aspectj.annotation.AnnotationAwareAspectJAutoProxyCreator" />   
2. <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>  
3. <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">   
4.     <property name="interceptors">  
5.         <list>  
6.             <bean class="com.chenzhou.examples.erm.util.interceptor.LoginInterceptor"/>  
7.         </list>  
8.     </property>  
9. </bean>  
10. <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"/>  

 

    然后重新启动tomcat后访问http://localhost:8080/erm/admin/init 结果正常，控制台日志信息如下：

Shell代码  

1. *********************preHandle********************  
2. class org.springframework.web.method.HandlerMethod  
3. public org.springframework.web.servlet.ModelAndView com.chenzhou.examples.erm.web.AdminController.init(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)  

    从日志信息可以看出，handler对象在经过类型转换后转换成了HandlerMethod类型，通过handler.getMethod方法，获取到了该请求访问的方法为com.chenzhou.examples.erm.web.AdminController.init