Spring 注解学习手札(二) 控制层梳理

言归正传,研究一下注解下的控制层。
我习惯于使用JSTL展示页面,因此需要在原lib基础上增加jstl.jar和standard.jar,详细lib依赖如下:
引用

aopalliance-1.0.jar
commons-logging-1.1.1.jar
log4j-1.2.15.jar
spring-beans-2.5.6.jar
spring-context-2.5.6.jar
spring-context-support-2.5.6.jar
spring-core-2.5.6.jar
spring-tx-2.5.6.jar
spring-web-2.5.6.jar
spring-webmvc-2.5.6.jar
standard.jar
jstl.jar

上一篇文中,我们定义了控制器AccountController:
AccountController.java
Java代码 收藏代码
  1. /**
  2. *2010-1-23
  3. */
  4. packageorg.zlex.spring.controller;
  5. importjavax.servlet.http.HttpServletRequest;
  6. importjavax.servlet.http.HttpServletResponse;
  7. importorg.springframework.beans.factory.annotation.Autowired;
  8. importorg.springframework.stereotype.Controller;
  9. importorg.springframework.web.bind.ServletRequestUtils;
  10. importorg.springframework.web.bind.annotation.RequestMapping;
  11. importorg.springframework.web.bind.annotation.RequestMethod;
  12. importorg.zlex.spring.service.AccountService;
  13. /**
  14. *
  15. *@author<ahref="mailto:[email protected]">梁栋</a>
  16. *@version1.0
  17. *@since1.0
  18. */
  19. @Controller
  20. @RequestMapping("/account.do")
  21. publicclassAccountController{
  22. @Autowired
  23. privateAccountServiceaccountService;
  24. @RequestMapping(method=RequestMethod.GET)
  25. publicvoidhello(HttpServletRequestrequest,HttpServletResponseresponse)
  26. throwsException{
  27. Stringusername=ServletRequestUtils.getRequiredStringParameter(
  28. request,"username");
  29. Stringpassword=ServletRequestUtils.getRequiredStringParameter(
  30. request,"password");
  31. System.out.println(accountService.verify(username,password));
  32. }
  33. }

先说注解 @RequestMapping
这里使用注解 @RequestMapping(method = RequestMethod.GET) 指定这个方法为get请求时调用。同样,我们可以使用注解 @RequestMapping(method = RequestMethod.POST) 指定该方法接受post请求。
Java代码 收藏代码
  1. @Controller
  2. @RequestMapping("/account.do")
  3. publicclassAccountController{
  4. @RequestMapping(method=RequestMethod.GET)
  5. publicvoidget(){
  6. }
  7. @RequestMapping(method=RequestMethod.POST)
  8. publicvoidpost(){
  9. }
  10. }

这与我们久别的Servlet很相像,类似于doGet()和doPost()方法!
我们也可以将其改造为多动作控制器,如下代码所示:
Java代码 收藏代码
  1. @Controller
  2. @RequestMapping("/account.do")
  3. publicclassAccountController{
  4. @RequestMapping(params="method=login")
  5. publicvoidlogin(){
  6. }
  7. @RequestMapping(params="method=logout")
  8. publicvoidlogout(){
  9. }

这样,我们可以通过参数“method”指定不同的参数值从而通过请求("/account.do?method=login"和"/account.do?method=logout")调用不同的方法!
注意:使用多动作控制器必须在配置文件中加入注解支持!
Xml代码 收藏代码
  1. <bean
  2. class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

当然,我们也可以将注解 @RequestMapping 指定到某一个方法上,如:
Java代码 收藏代码
  1. @Controller
  2. publicclassAccountController{
  3. @RequestMapping("/a.do")
  4. publicvoida(){}
  5. @RequestMapping("/b.do")
  6. publicvoidb(){}
  7. }

这样,请求“a.do”和“b.do”将对应不同的方法a() 和b()。这使得一个控制器可以同时承载多个请求!
@RequestMapping("/account.do") @RequestMapping(value="/account.do") 的简写!
再说输入参数!
这里的方法名可以随意定义,但是参数和返回值却又要求!
为什么?直接看源代码,我们就能找到答案!
AnnotationMethodHandlerAdapter.java部分源代码——有关参数部分:
Java代码 收藏代码
  1. @Override
  2. protectedObjectresolveStandardArgument(ClassparameterType,NativeWebRequestwebRequest)
  3. throwsException{
  4. HttpServletRequestrequest=(HttpServletRequest)webRequest.getNativeRequest();
  5. HttpServletResponseresponse=(HttpServletResponse)webRequest.getNativeResponse();
  6. if(ServletRequest.class.isAssignableFrom(parameterType)){
  7. returnrequest;
  8. }
  9. elseif(ServletResponse.class.isAssignableFrom(parameterType)){
  10. this.responseArgumentUsed=true;
  11. returnresponse;
  12. }
  13. elseif(HttpSession.class.isAssignableFrom(parameterType)){
  14. returnrequest.getSession();
  15. }
  16. elseif(Principal.class.isAssignableFrom(parameterType)){
  17. returnrequest.getUserPrincipal();
  18. }
  19. elseif(Locale.class.equals(parameterType)){
  20. returnRequestContextUtils.getLocale(request);
  21. }
  22. elseif(InputStream.class.isAssignableFrom(parameterType)){
  23. returnrequest.getInputStream();
  24. }
  25. elseif(Reader.class.isAssignableFrom(parameterType)){
  26. returnrequest.getReader();
  27. }
  28. elseif(OutputStream.class.isAssignableFrom(parameterType)){
  29. this.responseArgumentUsed=true;
  30. returnresponse.getOutputStream();
  31. }
  32. elseif(Writer.class.isAssignableFrom(parameterType)){
  33. this.responseArgumentUsed=true;
  34. returnresponse.getWriter();
  35. }
  36. returnsuper.resolveStandardArgument(parameterType,webRequest);
  37. }

也就是说,如果我们想要在自定义的方法中获得一些个“标准”输入参数,参数类型必须包含在以下类型中:
引用

ServletRequest
ServletResponse
HttpSession
Principal
Locale
InputStream
OutputStream
Reader
Writer

当然,上述接口其实都是对于HttpServletRequest和HttpServletResponse的扩展。
此外,我们还可以定义自己的参数。
注意:自定义参数必须是实现类,绝非接口!Spring容器将帮你完成对象初始化工作!
比如说上文中,我们需要参数username和password。我们可以这么写:
Java代码 收藏代码
  1. @RequestMapping(method=RequestMethod.GET)
  2. publicvoidhello(Stringusername,Stringpassword){
  3. System.out.println(accountService.verify(username,password));
  4. }

如果参数名不能与这里的变量名保持一致,那么我们可以使用注解 @RequestParam 进行强制绑定,代码如下所示:
Java代码 收藏代码
  1. @RequestMapping(method=RequestMethod.GET)
  2. publicvoidhello(@RequestParam("username")Stringu,
  3. @RequestParam("password")Stringp){
  4. System.out.println(accountService.verify(u,p));
  5. }

这比起我们之前写的代码有所简洁:
Java代码 收藏代码
  1. @RequestMapping(method=RequestMethod.GET)
  2. publicvoidhello(HttpServletRequestrequest,HttpServletResponseresponse)
  3. throwsException{
  4. Stringusername=ServletRequestUtils.getRequiredStringParameter(
  5. request,"username");
  6. Stringpassword=ServletRequestUtils.getRequiredStringParameter(
  7. request,"password");
  8. System.out.println(accountService.verify(username,password));
  9. }

ServletRequestUtils类的工作已经由Spring底层实现了,我们只需要把参数名定义一致即可,其内部取参无需关心!
除了传入参数,我们还可以定义即将传出的参数,如加入ModelMap参数:
Java代码 收藏代码
  1. @SuppressWarnings("unchecked")
  2. @RequestMapping(method=RequestMethod.GET)
  3. publicMaphello(Stringusername,Stringpassword,ModelMapmodel){
  4. System.out.println(accountService.verify(username,password));
  5. model.put("msg",username);
  6. returnmodel;
  7. }

这时,我们没有定义页面名称,Spring容器将根据请求名指定同名view,即如果是jap页面,则account.do->account.jsp!
不得不承认,这样写起来的确减少了代码量!
接着说输出参数!
通过ModelMap,我们可以绑定输出到的页面的参数,但最终我们将要返回到何种页面呢?再次查看AnnotationMethodHandlerAdapter源代码!
AnnotationMethodHandlerAdapter.java部分源代码——有关返回值部分:
Java代码 收藏代码
  1. @SuppressWarnings("unchecked")
  2. publicModelAndViewgetModelAndView(MethodhandlerMethod,ClasshandlerType,ObjectreturnValue,
  3. ExtendedModelMapimplicitModel,ServletWebRequestwebRequest){
  4. if(returnValueinstanceofModelAndView){
  5. ModelAndViewmav=(ModelAndView)returnValue;
  6. mav.getModelMap().mergeAttributes(implicitModel);
  7. returnmav;
  8. }
  9. elseif(returnValueinstanceofModel){
  10. returnnewModelAndView().addAllObjects(implicitModel).addAllObjects(((Model)returnValue).asMap());
  11. }
  12. elseif(returnValueinstanceofMap){
  13. returnnewModelAndView().addAllObjects(implicitModel).addAllObjects((Map)returnValue);
  14. }
  15. elseif(returnValueinstanceofView){
  16. returnnewModelAndView((View)returnValue).addAllObjects(implicitModel);
  17. }
  18. elseif(returnValueinstanceofString){
  19. returnnewModelAndView((String)returnValue).addAllObjects(implicitModel);
  20. }
  21. elseif(returnValue==null){
  22. //Eitherreturnednullorwas'void'return.
  23. if(this.responseArgumentUsed||webRequest.isNotModified()){
  24. returnnull;
  25. }
  26. else{
  27. //Assumingviewnametranslation...
  28. returnnewModelAndView().addAllObjects(implicitModel);
  29. }
  30. }
  31. elseif(!BeanUtils.isSimpleProperty(returnValue.getClass())){
  32. //Assumeasinglemodelattribute...
  33. ModelAttributeattr=AnnotationUtils.findAnnotation(handlerMethod,ModelAttribute.class);
  34. StringattrName=(attr!=null?attr.value():"");
  35. ModelAndViewmav=newModelAndView().addAllObjects(implicitModel);
  36. if("".equals(attrName)){
  37. ClassresolvedType=GenericTypeResolver.resolveReturnType(handlerMethod,handlerType);
  38. attrName=Conventions.getVariableNameForReturnType(handlerMethod,resolvedType,returnValue);
  39. }
  40. returnmav.addObject(attrName,returnValue);
  41. }
  42. else{
  43. thrownewIllegalArgumentException("Invalidhandlermethodreturnvalue:"+returnValue);
  44. }
  45. }

返回值的定义十分庞大,或者说可怕的if-else多少有点让我觉得厌恶!
我们可以定义以下类型的返回值:
引用

ModelAndView
Model
View
Map
String
null

ModelAndView、Model和View都是Spring之前版本所特有的元素,Map对应于传入参数ModelMap,String定义页面名称,null即对应void类型方法!
最常用的实现方式如下:
Java代码 收藏代码
  1. @SuppressWarnings("unchecked")
  2. @RequestMapping(method=RequestMethod.GET)
  3. publicStringhello(Stringusername,Stringpassword,ModelMapmodel){
  4. System.out.println(accountService.verify(username,password));
  5. model.put("msg",username);
  6. return"account";
  7. }

当然,对于我来说在返回值中写入这么一个字符串多少有点不能接受,于是我还是乐于使用输入参数ModelMap+输出参数Map的方式。
给出一个完整的AccountController实现:
AccountController.java
Java代码 收藏代码
  1. /**
  2. *2010-1-23
  3. */
  4. packageorg.zlex.spring.controller;
  5. importjava.util.Map;
  6. importorg.springframework.beans.factory.annotation.Autowired;
  7. importorg.springframework.stereotype.Controller;
  8. importorg.springframework.ui.ModelMap;
  9. importorg.springframework.web.bind.annotation.RequestMapping;
  10. importorg.springframework.web.bind.annotation.RequestMethod;
  11. importorg.zlex.spring.service.AccountService;
  12. /**
  13. *
  14. *@author<ahref="mailto:[email protected]">梁栋</a>
  15. *@version1.0
  16. *@since1.0
  17. */
  18. @Controller
  19. @RequestMapping("/account.do")
  20. publicclassAccountController{
  21. @Autowired
  22. privateAccountServiceaccountService;
  23. @SuppressWarnings("unchecked")
  24. @RequestMapping(method=RequestMethod.GET)
  25. publicMaphello(Stringusername,Stringpassword,ModelMapmodel){
  26. System.out.println(accountService.verify(username,password));
  27. model.put("msg",username);
  28. returnmodel;
  29. }
  30. }

最后说注解 @Session
如果想将某个ModelMap中的参数指定到Session中,可以使用 @Session 注解,将其绑定为Session熟悉,代码如下所示:
Java代码 收藏代码
  1. @Controller
  2. @RequestMapping("/account.do")
  3. @SessionAttributes("msg")
  4. publicclassAccountController{
  5. @Autowired
  6. privateAccountServiceaccountService;
  7. @SuppressWarnings("unchecked")
  8. @RequestMapping(method=RequestMethod.GET)
  9. publicMaphello(Stringusername,Stringpassword,ModelMapmodel){
  10. System.out.println(accountService.verify(username,password));
  11. model.put("msg",username);
  12. returnmodel;
  13. }
  14. }

当然,我们还需要配置一下对应的视图解析器,给出完整配置:
servelt.xml
Xml代码 收藏代码
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <beans
  3. xmlns="http://www.springframework.org/schema/beans"
  4. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5. xmlns:p="http://www.springframework.org/schema/p"
  6. xmlns:context="http://www.springframework.org/schema/context"
  7. xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsd
  8. http://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsd">
  9. <context:component-scan
  10. base-package="org.zlex.spring.controller"/>
  11. <bean
  12. id="urlMapping"
  13. class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>
  14. <bean
  15. class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>
  16. <bean
  17. id="jstlViewResolver"
  18. class="org.springframework.web.servlet.view.InternalResourceViewResolver"
  19. p:viewClass="org.springframework.web.servlet.view.JstlView"
  20. p:prefix="/WEB-INF/page/"
  21. p:suffix=".jsp"/>
  22. </beans>

这里使用了JstlView作为视图解析器。同时,指定前缀路径为"/WEB-INF/page/",后缀路径为".jsp"。也就是说,Spring容器将会在这个路径中寻找匹配的jsp文件!
注意加入 xmlns:p="http://www.springframework.org/schema/p" 命名空间!
再给出页面内容:
taglib.jsp
Jsp代码 收藏代码
  1. <%@taglibprefix="c"uri="http://java.sun.com/jsp/jstl/core"%>
  2. <%@taglibprefix="fmt"uri="http://java.sun.com/jsp/jstl/fmt"%>
  3. <%@taglibprefix="sql"uri="http://java.sun.com/jsp/jstl/sql"%>
  4. <%@taglibprefix="x"uri="http://java.sun.com/jsp/jstl/xml"%>
  5. <%@taglibprefix="fn"uri="http://java.sun.com/jsp/jstl/functions"%>
  6. <%@taglibprefix="spring"uri="http://www.springframework.org/tags"%>
  7. <%@taglibprefix="form"uri="http://www.springframework.org/tags/form"%>

account.jap
Jsp代码 收藏代码
  1. <%@pagelanguage="java"contentType="text/html;charset=UTF-8"
  2. pageEncoding="UTF-8"%>
  3. <%@includefile="/WEB-INF/page/taglib.jsp"%>
  4. <!DOCTYPEhtmlPUBLIC"-//W3C//DTDHTML4.01Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
  5. <html>
  6. <head>
  7. <metahttp-equiv="Content-Type"content="text/html;charset=UTF-8">
  8. <title>Account</title>
  9. </head>
  10. <body>
  11. <c:outvalue="${msg}"></c:out>
  12. </body>
  13. </html>

目录结构如图所示:
Spring 注解学习手札(二) 控制层梳理_第1张图片
启动应用,最后将得到一个带有内容的页面,如图:
Spring 注解学习手札(二) 控制层梳理_第2张图片
代码见附件!

你可能感兴趣的:(Spring 注解学习手札(二) 控制层梳理)