0
点赞
收藏
分享

微信扫一扫

spring 基于注解的控制器配置

萧萧雨潇潇 2023-07-17 阅读 62
springbeaninterceptorclassservletPython后端开发


spring 基于注解的控制器配置

  • 博客分类：
  • spring

Spring Bean Servlet MVC Web


13.12. 基于注解的控制器配置

现时对于一些类型的配置数据有一个趋势，就是偏爱注解方式而不是XML文件。为了方便实现，Spring现在（从2.5开始）提供了使用注解配置 MVC框架下的组件的支持。

Spring 2.5为MVC控制器引入了一种基于注解的编程模型，在其中使用诸如@RequestMapping 、@RequestParam 、@ModelAttribute ，等等。 这种注解支持在Servlet MVC和Portlet MVC中均可使用。通过这种方式实现的控制器不必由特定的基类继承而来，或者实现特定的接口。 更进一步的，它们通常并不直接依赖于Servlet或Portlet API，虽然如果需要，它们可以方便的访问Servlet或Portlet的功能。



提示

Spring发行版本附带了PetClinic 示例，它是一个在简单的表单处理的上下文中， 利用了本节中说明的注解支持的Web应用程序。 可以在“samples/petclinic ”目录中找到PetClinic 应用程序。

另外一个建立在基于注解的Web MVC上的示例应用程序，请见imagedb 。 这个示例集中在无状态的multi-action控制器，包括多段文件上传的处理。 可以在“samples/imagedb ”目录找到imagedb 应用程序。



下面的章节记录了这些注解以及通常如何使用它们。





基于注解风格的Spring-MVC的拦截器



 

Spring-MVC如何使用拦截器，官方文档只给出了非注解风格的例子。那么基于注解风格如何使用拦截器呢？ 基于注解基本上有2个可使用的定义类，分别是DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter


Xml代码 


1. < bean   class"org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>    
2. < bean   class"org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>


<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/> <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

 

1、DefaultAnnotationHandlerMapping
DefaultAnnotationHandlerMapping本身支持自定义拦截器，只需按如下进行配置：


Xml代码 

1. < bean   class"org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">    
2.      < property   name"interceptors">    
3.          < list >    
4.                 < bean   class"packageName.XXXInterceptor"/>    
5.          </ list >    
6.      </ property >    
7.  </ bean >

<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"> <property name="interceptors"> <list> <bean class="packageName.XXXInterceptor" /> </list> </property> </bean>

 

Interceptor的定义为：


Java代码 


1. public   class  XXXInterceptor  extends  HandlerInterceptorAdapter {   
2.       @Override    
3.       public   boolean  preHandle(HttpServletRequest req, HttpServletResponse resp, Object handler) {   
4.      
5.           String className = handler.getClass().getName();// packageName.ClassName    
6.           if  (Error) {   
7.               return   false ;   
8.           }  
9.           return   true ;   
10.      }  
11.  }



public class XXXInterceptor extends HandlerInterceptorAdapter { @Override public boolean preHandle(HttpServletRequest req, HttpServletResponse resp, Object handler) { String className = handler.getClass().getName();// packageName.ClassName if (Error) { return false; } return true; } }

 

2、AnnotationMethodHandlerAdapter
目前，笔者没找到如何给AnnotationMethodHandlerAdapter配置自定义Interceptor的方法，但是有个customArgumentResolver可以利用一下，来充当Interceptor。


Xml代码 



1. < bean   class"org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">    
2.      < property   name"customArgumentResolver">    
3.          < bean   class"packageName.XXXResolver"/>    
4.      </ property >    
5.  </ bean >

<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> <property name="customArgumentResolver"> <bean class="packageName.XXXResolver"/> </property> </bean>

 

Resolver的定义为：


Java代码 



1. public   class  XXXResolver  implements  WebArgumentResolver {   
2.      
3.       @Override    
4.       public  Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest)  throws  Exception {   
5.      
6.           String className = methodParameter.getMethod().getDeclaringClass().getName();// packageName.ClassName    
7.     
8.           // 如何取得Response和Request    
9.           HttpServletResponse resp = (HttpServletResponse) webRequest.getNativeResponse();  
10.         HttpServletRequest req = (HttpServletRequest) webRequest.getNativeRequest();  
11.     
12.         if  (Error) {   
13.             if  (!resp.isCommitted()) resp.sendError(ERROR_STATUS);   
14.         }  
15.         return  UNRESOLVED;       
16.      }  
17.  }


public class XXXResolver implements WebArgumentResolver { @Override public Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) throws Exception { String className = methodParameter.getMethod().getDeclaringClass().getName();// packageName.ClassName // 如何取得Response和Request HttpServletResponse resp = (HttpServletResponse) webRequest.getNativeResponse(); HttpServletRequest req = (HttpServletRequest) webRequest.getNativeRequest(); if (Error) { if (!resp.isCommitted()) resp.sendError(ERROR_STATUS); } return UNRESOLVED; } }

 

仔细的人会看出，第二种方法其实根本不是拦截。其实第二种只是在映射Controller，调用方法的时候，给每一个方法的参数增加了一个切点。
上例在出错的时候往HttpServletResponse 写错误状态，来通知web容器进行错误重定向，达到了拦截器的作用。
这么做有一个缺点，就是每个参数都有自己的切点，比如方法有3个参数就会调3次resolveArgument。为了避免出错，需要判断一下 resp.isCommitted 。

customArgumentResolver的初衷不是用来做Interceptor的，但有些环境却不得不使用它，比如部署在GAE上。
GAE 是不支持DefaultAnnotationHandlerMapping的，因为此类用到了 org.springframework.beans.BeanUtils.findEditorByConvention，这个方法会调用 java.lang.ClassLoader.getSystemClassLoader，而这正是GAE所不允许的。

PS：
文中提到软件的版本：
spring - 2.5.X
google app engine - 1.2.5

参考资料
http://www.scottmurphy.info/spring_framework_annotation_based_controller_interceptorshttp://groups.google.com/group/google-appengine-java/browse_thread/thread/54aadf8164be7bf0

 

Spring-MVC如何使用拦截器，官方文档只给出了非注解风格的例子。那么基于注解风格如何使用拦截器呢？ 基于注解基本上有2个可使用的定义类，分别是DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter


Xml代码 

1. < bean   class"org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>    
2. < bean   class"org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/> <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

 

1、DefaultAnnotationHandlerMapping
DefaultAnnotationHandlerMapping本身支持自定义拦截器，只需按如下进行配置：


Xml代码 


1. < bean   class"org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">    
2.      < property   name"interceptors">    
3.          < list >    
4.                 < bean   class"packageName.XXXInterceptor"/>    
5.          </ list >    
6.      </ property >    
7.  </ bean >


<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"> <property name="interceptors"> <list> <bean class="packageName.XXXInterceptor" /> </list> </property> </bean>

 

Interceptor的定义为：


Java代码 



1. public   class  XXXInterceptor  extends  HandlerInterceptorAdapter {   
2.       @Override    
3.       public   boolean  preHandle(HttpServletRequest req, HttpServletResponse resp, Object handler) {   
4.      
5.           String className = handler.getClass().getName();// packageName.ClassName    
6.           if  (Error) {   
7.               return   false ;   
8.           }  
9.           return   true ;   
10.      }  
11.  }



public class XXXInterceptor extends HandlerInterceptorAdapter { @Override public boolean preHandle(HttpServletRequest req, HttpServletResponse resp, Object handler) { String className = handler.getClass().getName();// packageName.ClassName if (Error) { return false; } return true; } }

 

2、AnnotationMethodHandlerAdapter
目前，笔者没找到如何给AnnotationMethodHandlerAdapter配置自定义Interceptor的方法，但是有个customArgumentResolver可以利用一下，来充当Interceptor。


Xml代码 

1. < bean   class"org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">    
2.      < property   name"customArgumentResolver">    
3.          < bean   class"packageName.XXXResolver"/>    
4.      </ property >    
5.  </ bean >


<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> <property name="customArgumentResolver"> <bean class="packageName.XXXResolver"/> </property> </bean>

 

Resolver的定义为：


Java代码 


    1. public   class  XXXResolver  implements  WebArgumentResolver {   
2.      
3.       @Override    
4.       public  Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest)  throws  Exception {   
5.      
6.           String className = methodParameter.getMethod().getDeclaringClass().getName();// packageName.ClassName    
7.     
8.           // 如何取得Response和Request    
9.           HttpServletResponse resp = (HttpServletResponse) webRequest.getNativeResponse();  
10.         HttpServletRequest req = (HttpServletRequest) webRequest.getNativeRequest();  
11.     
12.         if  (Error) {   
13.             if  (!resp.isCommitted()) resp.sendError(ERROR_STATUS);   
14.         }  
15.         return  UNRESOLVED;       
16.      }  
17.  }


    public class XXXResolver implements WebArgumentResolver { @Override public Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) throws Exception { String className = methodParameter.getMethod().getDeclaringClass().getName();// packageName.ClassName // 如何取得Response和Request HttpServletResponse resp = (HttpServletResponse) webRequest.getNativeResponse(); HttpServletRequest req = (HttpServletRequest) webRequest.getNativeRequest(); if (Error) { if (!resp.isCommitted()) resp.sendError(ERROR_STATUS); } return UNRESOLVED; } }

     

    仔细的人会看出，第二种方法其实根本不是拦截。其实第二种只是在映射Controller，调用方法的时候，给每一个方法的参数增加了一个切点。
    上例在出错的时候往HttpServletResponse 写错误状态，来通知web容器进行错误重定向，达到了拦截器的作用。
    这么做有一个缺点，就是每个参数都有自己的切点，比如方法有3个参数就会调3次resolveArgument。为了避免出错，需要判断一下 resp.isCommitted 。

    customArgumentResolver的初衷不是用来做Interceptor的，但有些环境却不得不使用它，比如部署在GAE上。
    GAE 是不支持DefaultAnnotationHandlerMapping的，因为此类用到了 org.springframework.beans.BeanUtils.findEditorByConvention，这个方法会调用 java.lang.ClassLoader.getSystemClassLoader，而这正是GAE所不允许的。

    PS：
    文中提到软件的版本：
    spring - 2.5.X
    google app engine - 1.2.5

    参考资料
    http://www.scottmurphy.info/spring_framework_annotation_based_controller_interceptorshttp://groups.google.com/group/google-appengine-java/browse_thread/thread/54aadf8164be7bf0

    举报

    相关推荐

    注解与控制器注解

    spring

    注解式控制器

    MVC参数类型解析器虚拟化云计算

    码农小汪-Spring MVC注解式控制器简介

    spring处理方法html

    m基于simulink的PID控制器,模糊PID控制器以及MPC控制器性能对比仿真

    5ef5Time数据仓库大数据

    m基于强化学习的PID控制器simulink仿真,对比PI控制器和变结构PI控制器

    强化学习监督学习d3数据仓库大数据

    Phpstorm配置git版本控制器

    PhpStormgitphpbashPHP前端开发

    AC控制器配置分流规则

    网络配置配置分流规则AC配置配置带宽限速策略网络管理网络/安全51CTO博主之星评选

    Spring实战—1.8 测试基本的控制器

    Java后端Java编程后端开发

    jmeter控制器之随机控制器

    Random ControllerIT职场yyds干货盘点

    基于X86视觉控制器+光源控制器方案设计

    视觉控制器参数配置解决方案线或HarmonyOS后端开发
    0 条评论