springMVC注解

0.提示

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

2)另外一个建立在基于注解的WebMVC上的示例应用程序,请见imagedb

   这个示例集中在无状态的multi-action控制器,包括多段文件上传的处理。

   可以在samples/imagedb”目录找到imagedb应用程序。


1.建立dispatcher实现注解支持

只有对应的HandlerMapping(为了实现类型级别的注解)和/HandlerAdapter(为了实现方法级别的注解)出现在dispatcher中时,@RequestMapping才会被处理。这在DispatcherServletDispatcherPortlet中都是缺省的行为。


然而,如果是在定义自己的HandlerMappingsHandlerAdapters就需要确保一个对应的自定义的DefaultAnnotationHandlerMapping/AnnotationMethodHandlerAdapter同样被定义——假设想要使用@RequestMapping

<?xmlversion="1.0" encoding="UTF-8"?>

<beans  xmlns="http://www.springframework.org/schema/beans"

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://www.springframework.org/schema/beans

         http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">


<beanclass="org.springframework.web.servlet.mvc.

DefaultAnnotationHandlerMapping"/>

<beanclass="org.springframework.web.servlet.mvc.

AnnotationMethodHandlerAdapter"/>

           ...(controller bean definitions) ...


</beans>


1:雁联zfpt-servlet.xml

配置DefaultAnnotationHandlerMapping/AnnotationMethodHandlerAdapter

<context:component-scanbase-package="com.ylink.zfpt.web.spring"/>

<beanid="annotationHandlerMapping"class="org.springframework.web.servlet.mvc.annotation.

DefaultAnnotationHandlerMapping">

   <propertyname="order">

<value>1</value>

</property>

   <propertyname="interceptors">

   <list>

   <refbean="sessionInterceptor"/>

   <refbean="superUserInterceptor"/>

   </list>

   </property>

</bean>

<beanclass="org.springframework.web.servlet.mvc.annotation.

AnnotationMethodHandlerAdapter">

<propertyname="webBindingInitializer">

<beanclass="com.ylink.zfpt.web.spring.ZfptBindingInitializer"/>

</property>

</bean>

<beanid="sessionInterceptor"class="com.ylink.zfpt.web.intercepor.SessionInterceptor">

</bean>

<beanid="superUserInterceptor"

class="com.ylink.zfpt.web.intercepor.SuperUserAccessInterceptor"></bean>


2web.xml

<?xml version="1.0"  encoding="ISO-8859-1"?>

<web-app   version="2.4"

xmlns=http://java.sun.com/xml/ns/j2eexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee

http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

<display-name>SpringPetClinic</display-name>

  <description>SpringPetClinic sample application</description>


2.1webAppRootKey

<!--

Keyof the system property that should specify the root directory ofthis

webapp.Applied by WebAppRootListeneror Log4jConfigListener.

-->

<context-param>

<param-name>webAppRootKey</param-name>

<param-value>petclinic.root</param-value>

</context-param>


2.3log4jConfigLocation

  <!--

Locationof the Log4J configfile, for initialization and refresh checks.

Appliedby Log4jConfigListener.

-->

<context-param>

<param-name>log4jConfigLocation</param-name>

<param-value>/WEB-INF/classes/log4j.properties</param-value>

</context-param>


2.4contextConfigLocation

<!--

-Location of the XML file that defines the root applicationcontext.

-Applied by ContextLoaderServlet.

-

-Can be set to:

-"/WEB-INF/applicationContext-hibernate.xml"for the Hibernateimplementation,

-"/WEB-INF/applicationContext-jpa.xml"for the JPA one, or

-"/WEB-INF/applicationContext-jdbc.xml"for the JDBC one.

-->

<context-param>

<param-name>contextConfigLocation</param-name>

<param-value>

/WEB-INF/spring/applicationContext-jdbc.xml

/WEB-INF/applicationContext-security.xml

</param-value>

       <!--

<param-value>/WEB-INF/spring/applicationContext-hibernate.xml</param-value>

<param-value>/WEB-INF/spring/applicationContext-jpa.xml</param-value>

-->


<!--

Touse the JPA variant above, you will need to enable Springload-time

weavingin your server environment. Out of the box, Spring will try to

detectthe running environment and use the appropriate weaver but if that

fails,one must enable one by hand or use the VM-wide weaver.

SeePetClinic's readmeand/or Spring's JPA documentation for more information.

-->

</context-param>



2.5springSecurityFilterChain

<filter>

   <filter-name>springSecurityFilterChain</filter-name>

<filter-class>

org.springframework.web.filter.DelegatingFilterProxy

</filter-class>

</filter>

<filter-mapping>

   <filter-name>springSecurityFilterChain</filter-name>

   <url-pattern>/*</url-pattern>

</filter-mapping>


2.6Log4jConfigListener

<!--

-Configures Log4J for this web app.

-As this context specifies a context-param"log4jConfigLocation", its file path

-is used to load the Log4J configuration, including periodicrefresh checks.

-

-Would fall back to default Log4J initialization (non-refreshing)if no special

-context-paramsare given.

-

-Exports a "web approot key", i.e. a system property that specifies the root

-directory of this web app,for usage in log file paths.

-This web appspecifies "petclinic.root"(see log4j.properties file).

-->

<!--Leave the listener commented-out if using JBoss -->

<listener>

<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>

</listener>


2.7ContextLoaderListener

<!--

-Loads the root application context of this web appat startup,

-by default from "/WEB-INF/applicationContext.xml".

-Note that you need to fall back to Spring's ContextLoaderServletfor

-J2EE servers that do not follow the Servlet2.4 initialization order.

-

-UseWebApplicationContextUtils.getWebApplicationContext(servletContext)

-to access it anywhere in the web application, outside of theframework.

-

-The root context is the parent of all servlet-specificcontexts.

-This means that its beans are automatically available in thesechild contexts,

-both for getBean(name) calls and (external) bean references.

-->

<listener>

<listener-class>

org.springframework.web.context.ContextLoaderListener

</listener-class>

</listener>


2.8DispatcherServlet

<!--

-Servletthat dispatches request to registered handlers (Controllerimplementations).

-Has its own application context, by default defined in"{servlet-name}-servlet.xml",

-i.e. "petclinic-servlet.xml".

-

-A web appcan contain any number of such servlets.

-Note that this web apphas a shared root application context, serving as parent

-of all DispatcherServlet contexts.

-->

<servlet>

<servlet-name>petclinic</servlet-name>

   <servlet-class>

org.springframework.web.servlet.DispatcherServlet

</servlet-class>

<load-on-startup>2</load-on-startup>

</servlet>


<!--

-Maps the petclinicdispatcher to "*.do". All handler mappings in

-petclinic-servlet.xmlwill by default be applied to this subpath.

-If a mapping isn't a /* subpath,the handler mappings are considered

-relative to the web approot.

-

-NOTE: A single dispatcher can be mapped to multiple paths, likeany servlet.

-->

<servlet-mapping>

<servlet-name>petclinic</servlet-name>

<url-pattern>/</url-pattern>

</servlet-mapping>


2.9exception.java

<error-page>

<exception-type>java.lang.Exception</exception-type>

<!--Displays a stack trace -->

<location>/WEB-INF/jsp/uncaughtException.jsp</location>

</error-page>





3:雁联web.xml

如果你想要自定义映射策略,显式的定义一个DefaultAnnotationHandlerMapping/AnnotationMethodHandlerAdapter也有实际意义。例如,指定一个自定义的PathMatcher或者WebBindingInitializer


1.一个简单的基于注解的Controller

使用过低版本SpringMVC 的读者都知道:

1.当创建一个Controller时,我们需要直接或间接地实现org.springframework.web.servlet.mvc.Controller接口。一般情况下,我们是通过继承SimpleFormControllerMultiActionController来定义自己的Controller的。

2.在定义Controller后,一个重要的事件是在SpringMVC 的配置文件中通过HandlerMapping定义请求和控制器的映射关系,以便将两者关联起来。

3.来看一下基于注解的Controller是如何定义做到这一点的,下面是使用注解的BbtForumController

实现效果:

启动Tomcat,发送http://localhost/forum.doURL 请求,BbtForumControllerlistAllBoard()方法将响应这个请求,并转向WEB-INF/jsp/listBoard.jsp的视图页面。


清单1.BbtForumController.java

packagecom.baobaotao.web;


importcom.baobaotao.service.BbtForumService;

importorg.springframework.beans.factory.annotation.Autowired;

importorg.springframework.stereotype.Controller;

importorg.springframework.web.bind.annotation.ModelAttribute;

importorg.springframework.web.bind.annotation.RequestMapping;

importorg.springframework.web.bind.annotation.RequestMethod;

importjava.util.Collection;

@Controller                  //<——①

@RequestMapping("/forum.do")

publicclass BbtForumController{


    @Autowired

    privateBbtForumService bbtForumService;


    @RequestMapping//<——②

    publicString listAllBoard(){

       bbtForumService.getAllBoard();

       System.out.println("calllistAllBoard method.");

        return"listBoard";

    }

}


处使用了两个注解,分别是@Controller@RequestMapping。在使用Spring2.5 基于注解驱动的IoC这篇文章里,笔者曾经指出过@Controller@Service以及 @Repository @Component注解的作用是等价的:将一个类成为Spring容器的 Bean。由于SpringMVC Controller必须事先是一个Bean,所以@Controller注解是不可缺少的。

真正让BbtForumController具备 SpringMVC Controller 功能的是@RequestMapping这个注解。@RequestMapping可以标注在类定义处,将Controller和特定请求关联起来;还可以标注在方法签名处,以便进一步对请求进行分流。在处,我们让BbtForumController关联/forum.do的请求,而处,我们具体地指定listAllBoard()方法来处理请求。所以在类声明处标注的@RequestMapping相当于让 POJO实现了Controller接口,而在方法定义处的@RequestMapping相当于让 POJO扩展 Spring预定义的Controller(如SimpleFormController等)。


清单2.web.xml:启用Spring容器和SpringMVC 框架

为了让基于注解的SpringMVC 真正工作起来,需要在SpringMVC 对应的xxx-servlet.xml配置文件中做一些手脚。在此之前,还是先来看一下web.xml的配置吧

<?xmlversion="1.0" encoding="UTF-8"?>

<web-appxmlns="http://java.sun.com/xml/ns/javaee"

   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee

http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"version="2.5">


<display-name>SpringAnnotation MVC Sample</display-name>


   <!-- Spring 服务层的配置文件-->

    <context-param>

       <param-name>contextConfigLocation</param-name>

       <param-value>classpath:applicationContext.xml</param-value>

    </context-param>

    

   <!-- Spring 容器启动监听器-->

    <listener>

        <listener-class>

               org.springframework.web.context.ContextLoaderListener

       </listener-class>

    </listener>


<!-- Spring MVC Servlet,它将加载WEB-INF/annomvc-servlet.xml配置文件,

      以启动SpringMVC模块-->

    <servlet>

       <servlet-name>annomvc</servlet-name>

        <servlet-class>

             org.springframework.web.servlet.DispatcherServlet

        </servlet-class>

       <load-on-startup>2</load-on-startup>

    </servlet>


    <servlet-mapping>

       <servlet-name>annomvc</servlet-name>

       <url-pattern>*.do</url-pattern>

    </servlet-mapping>

</web-app>


清单3.annomvc-servlet.xml

web.xml中定义了一个名为annomvc SpringMVC 模块,按照SpringMVC 的契约,需要在WEB-INF/annomvc-servlet.xml配置文件中定义SpringMVC 模块的具体配置。annomvc-servlet.xml的配置内容如下所示:

<?xmlversion="1.0" encoding="UTF-8"?>

<beans

   xmlns="http://www.springframework.org/schema/beans"

   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

   xmlns:p="http://www.springframework.org/schema/p"

   xmlns:context="http://www.springframework.org/schema/context"

   xsi:schemaLocation="http://www.springframework.org/schema/beans

   http://www.springframework.org/schema/beans/spring-beans-2.5.xsd

   http://www.springframework.org/schema/context

   http://www.springframework.org/schema/context/spring-context-2.5.xsd">

    

    <!--①:对web包中的所有类进行扫描,以完成Bean创建和自动依赖注入的功能-->

   <context:component-scanbase-package="com.baobaotao.web"/>


   <!--②:启动SpringMVC的注解功能,完成请求和注解POJO的映射-->

    <beanclass="org.springframework.web.servlet.mvc.annotation.

                                                      AnnotationMethodHandlerAdapter"/>


   <!-- ③:对模型视图名称的解析,即在模型视图名称添加前后缀-->

<bean

   class="org.springframework.web.servlet.view.InternalResourceViewResolver"

       p:prefix="/WEB-INF/jsp/"p:suffix=".jsp"/>

</beans>


因为Spring所有功能都在Bean的基础上演化而来,所以必须事先将Controller变成Bean,这是通过在类中标注@Controller并在annomvc-servlet.xml中启用组件扫描机制来完成的,如所示。

处,配置了一个AnnotationMethodHandlerAdapter,它负责根据Bean 中的SpringMVC 注解对 Bean进行加工处理,使这些Bean变成控制器并映射特定的URL 请求。

处的工作是定义模型视图名称的解析规则,这里我们使用了Spring2.5 的特殊命名空间,即p命名空间,它将原先需要通过<property>元素配置的内容转化为<bean>属性配置,在一定程度上简化了<bean>的配置。


2.让一个Controller处理多个URL请求

在低版本的SpringMVC 中,我们可以通过继承MultiActionController让一个Controller处理多个 URL请求。使用@RequestMapping注解后,这个功能更加容易实现了。请看下面的代码:

清单3.每个请求处理参数对应一个URL

packagecom.baobaotao.web;


importcom.baobaotao.service.BbtForumService;

importorg.springframework.beans.factory.annotation.Autowired;

importorg.springframework.stereotype.Controller;

importorg.springframework.web.bind.annotation.RequestMapping;


@Controller

publicclass BbtForumController{


    @Autowired

    privateBbtForumService bbtForumService;


   @RequestMapping("/listAllBoard.do")// <——①

    publicString listAllBoard() {

       bbtForumService.getAllBoard();

       System.out.println("calllistAllBoard method.");

        return"listBoard";

    }


   @RequestMapping("/listBoardTopic.do")// <—— ②

    publicString listBoardTopic(int topicId) {

       bbtForumService.getBoardTopics(topicId);

       System.out.println("calllistBoardTopic method.");

        return"listTopic";

    }

}


在这里,我们分别在处为listAllBoard()listBoardTopic()方法标注了@RequestMapping注解,分别指定这两个方法处理的URL请求,这相当于将BbtForumController改造为MultiActionController。这样/listAllBoard.do URL请求将由listAllBoard()负责处理,而/listBoardTopic.do?topicId=1 URL请求则由listBoardTopic()方法处理。


清单4.一个Controller对应一个URL,由请求参数决定请求处理方法

对于处理多个URL 请求的Controller来说,我们倾向于通过一个URL参数指定Controller处理方法的名称(如method=listAllBoard),而非直接通过不同的URL 指定Controller的处理方法。使用@RequestMapping注解很容易实现这个常用的需求。来看下面的代码

packagecom.baobaotao.web;


importcom.baobaotao.service.BbtForumService;

importorg.springframework.beans.factory.annotation.Autowired;

importorg.springframework.stereotype.Controller;

importorg.springframework.web.bind.annotation.RequestMapping;


@Controller

@RequestMapping("/bbtForum.do") // <——① 指定控制器对应URL请求

publicclass BbtForumController{


    @Autowired

    privateBbtForumService bbtForumService;


    //<—— ② 如果URL请求中包括"method=listAllBoard"的参数,由本方法进行处理

   @RequestMapping(params= "method=listAllBoard")

    publicString listAllBoard() {

       bbtForumService.getAllBoard();

       System.out.println("calllistAllBoard method.");

        return"listBoard";

    }


    //<—— ③ 如果URL请求中包括"method=listBoardTopic"的参数,由本方法进行处理

   @RequestMapping(params= "method=listBoardTopic")

    publicString listBoardTopic(int topicId) {

       bbtForumService.getBoardTopics(topicId);

       System.out.println("calllistBoardTopic method.");

        return"listTopic";

    }

}

在类定义处标注的@RequestMappingBbtForumController处理所有包含/bbtForum.do URL请求,而BbtForumController中的请求处理方法对URL请求的分流规则在处定义分流规则按照URL method请求参数确定。所以分别在类定义处和方法定义处使用@RequestMapping注解,就可以很容易通过URL参数指定Controller的处理方法了。


清单5.让请求处理方法处理特定的HTTP请求方法

@RequestMapping注解中除了params属性外,还有一个常用的属性是method,它可以让Controller方法处理特定HTTP请求方式的请求,如让一个方法处理HTTPGET 请求,而另一个方法处理HTTPPOST 请求,如下所示:

packagecom.baobaotao.web;


importcom.baobaotao.service.BbtForumService;

importorg.springframework.beans.factory.annotation.Autowired;

importorg.springframework.stereotype.Controller;

importorg.springframework.web.bind.annotation.RequestMapping;

importorg.springframework.web.bind.annotation.RequestMethod;


@Controller

@RequestMapping("/bbtForum.do")

publicclass BbtForumController{


   @RequestMapping(params= "method=createTopic", method= RequestMethod.POST)

    publicString createTopic(){

       System.out.println("callcreateTopic method.");

        return"createTopic";

    }

}


这样只有当/bbtForum.do?method=createTopic请求以 HTTPPOST 方式提交时,createTopic()才会进行处理。


3.处理方法入参如何绑定URL参数

3.1按契约绑定

Controller的方法标注了@RequestMapping注解后,它就能处理特定的URL 请求。

我们不禁要问:请求处理方法入参是如何绑定URL参数的呢?在回答这个问题之前先来看下面的代码


清单5.按参数名匹配进行绑定

@RequestMapping(params= "method=listBoardTopic")

   //<——① topicId入参是如何绑定URL请求参数的?

    publicString listBoardTopic(inttopicId) {

       bbtForumService.getBoardTopics(topicId);

       System.out.println("calllistBoardTopic method.");

        return"listTopic";

    }

当我们发送http://localhost//bbtForum.do?method=listBoardTopic&topicId=10 URL请求时,Spring不但让listBoardTopic()方法处理这个请求,而且还将topicId请求参数在类型转换后绑定到listBoardTopic()方法的topicId入参上。而listBoardTopic()方法的返回类型是String,它将被解析为逻辑视图的名称。也就是说Spring在如何给处理方法入参自动赋值以及如何将处理方法返回值转化为ModelAndView中的过程中存在一套潜在的规则,不熟悉这个规则就不可能很好地开发基于注解的请求处理方法,因此了解这个潜在规则无疑成为理解SpringMVC 框架基于注解功能的核心问题。

我们不妨从最常见的开始说起:请求处理方法入参的类型可以是Java基本数据类型或String类型,这时方法入参按参数名匹配的原则绑定到URL请求参数,同时还自动完成String类型的 URL请求参数到请求处理方法参数类型的转换。下面给出几个例子:

listBoardTopic(inttopicId):和topicIdURL 请求参数绑定;

listBoardTopic(inttopicId,String boardName):分别和topicIdboardNameURL 请求参数绑定;

特别的,如果入参是基本数据类型(如intlongfloat等),URL请求参数中一定要有对应的参数,否则将抛出TypeMismatchException异常,提示无法将null转换为基本数据类型。


清单6.User.java:一个JavaBean

另外,请求处理方法的入参也可以一个JavaBean,如下面的User对象就可以作为一个入参

packagecom.baobaotao.web;


publicclass User {

    privateint userId;

    privateString userName;

    //省略get/setter方法

    publicString toString(){

        returnthis.userName +","+this.userId;

    }

}


清单7.使用JavaBean作为请求处理方法的入参

下面是将User 作为listBoardTopic()请求处理方法的入参:

@RequestMapping(params= "method=listBoardTopic")

    publicString listBoardTopic(inttopicId,User user){

       bbtForumService.getBoardTopics(topicId);

       System.out.println("topicId:"+topicId);

       System.out.println("user:"+user);

       System.out.println("calllistBoardTopic method.");

        return"listTopic";

    }


这时,如果我们使用以下的URL请求:

http://localhost/bbtForum.do?method=listBoardTopic&topicId=1&userId=10&userName=tom

topicIdURL 参数将绑定到topicId入参上,

userId userNameURL 参数将绑定到user对象的userId userName属性中。

URL请求中不允许没有topicId参数不同,虽然User userId属性的类型是基本数据类型,但如果URL中不存在userId参数,Spring也不会报错,此时user.userId值为 0。如果User对象拥有一个dept.deptId的级联属性,那么它将和dept.deptIdURL 参数绑定。


3.2通过注解指定绑定的URL参数

如果我们想改变这种默认的按名称匹配的策略,比如让listBoardTopic(inttopicId,User user) 中的topicId绑定到 id这个 URL参数,那么可以通过对入参使用@RequestParam注解来达到目的:

清单8.通过@RequestParam注解指定

这里,对listBoardTopic()请求处理方法的topicId入参标注了@RequestParam("id")注解,所以它将和id URL参数绑定。

packagecom.baobaotao.web;


importorg.springframework.web.bind.annotation.RequestMapping;

importorg.springframework.web.bind.annotation.RequestParam;

@Controller

@RequestMapping("/bbtForum.do")

publicclass BbtForumController{


   @RequestMapping(params= "method=listBoardTopic")

publicString listBoardTopic(@RequestParam("id")int topicId,

                                                          Useruser) {

       bbtForumService.getBoardTopics(topicId);

       System.out.println("topicId:"+topicId);

       System.out.println("user:"+user);

       System.out.println("calllistBoardTopic method.");

        return"listTopic";

    }

}


这里@RequestParam注解可以用来提取名为topicIdint类型的参数,并将之作为输入参数传入。@RequestParam支持类型转换,还有必需和可选参数。类型转换目前支持所有的基本Java类型,你可通过定制的PropertyEditors来扩展它的范围。下面是一些例子,其中包括了必需和可选参数:

@RequestParam(value="number",required=false) String number

@RequestParam("id")Long id

@RequestParam("balance")double balance

@RequestParamdouble amount

注意,最后一个例子没有提供清晰的参数名。当且仅当代码带调试符号编译时,结果会提取名为amount的参数,否则,将抛出IllegalStateException异常,因为当前的信息不足以从请求中提取参数。由于这个原因,在编码时最好显式的指定参数名。



3.3绑定模型对象中某个属性ModelMap

Spring2.0 定义了一个org.springframework.ui.ModelMap类,它作为通用的模型数据承载对象,传递数据供视图所用。我们可以在请求处理方法中声明一个ModelMap类型的入参,Spring会将本次请求模型对象引用通过该入参传递进来,这样就可以在请求处理方法内部访问模型对象了。来看下面的例子:

清单9.使用ModelMap访问请示对应的隐含模型对象

@RequestMapping(params= "method=listBoardTopic")

publicString listBoardTopic(@RequestParam("id")inttopicId,

Useruser,

ModelMapmodel){

    bbtForumService.getBoardTopics(topicId);

    System.out.println("topicId:"+ topicId);

    System.out.println("user:"+ user);

     //①user对象以currUser为键放入到model

    model.addAttribute("currUser",user);

     return"listTopic";

}


对于当次请求所对应的模型对象来说,其所有属性都将存放到request的属性列表中。

象上面的例子,ModelMap中的currUser属性将放到request的属性列表中,所以可以在JSP视图页面中通过request.getAttribute(“currUser”)或者通过${currUser}EL 表达式访问模型对象中的user对象。从这个角度上看,ModelMap相当于是一个向request属性列表中添加对象的一条管道,借由ModelMap对象的支持,我们可以在一个不依赖ServletAPI Controller中向 request中添加属性。


清单10.使模型对象的特定属性具有Session范围的作用域

在默认情况下,ModelMap中的属性作用域是request级别,也就是说,当本次请求结束后,ModelMap中的属性将销毁。如果希望在多个请求中共享ModelMap中的属性,必须将其属性转存到session中,这样ModelMap的属性才可以被跨请求访问。

Spring允许我们有选择地指定ModelMap中的哪些属性需要转存到session中,以便下一个请求属对应的ModelMap的属性列表中还能访问到这些属性。这一功能是通过类定义处标注@SessionAttributes注解来实现的。请看下面的代码:

packagecom.baobaotao.web;

importorg.springframework.ui.ModelMap;

importorg.springframework.web.bind.annotation.SessionAttributes;


@Controller

@RequestMapping("/bbtForum.do")

@SessionAttributes("currUser")//①ModelMap中属性名为currUser的属性

//放到Session属性列表中,以便这个属性可以跨请求访问

publicclass BbtForumController{

   @RequestMapping(params= "method=listBoardTopic")

publicString listBoardTopic(@RequestParam("id")inttopicId,

Useruser,

ModelMapmodel){

       bbtForumService.getBoardTopics(topicId);

       System.out.println("topicId:"+ topicId);

       System.out.println("user:"+ user);

       model.addAttribute("currUser",user);//②ModelMap中添加一个属性

        return"listTopic";

    }

}


我们在处添加了一个ModelMap属性,其属性名为currUser,而处通过@SessionAttributes注解将 ModelMap中名为 currUser的属性放置到Session中,所以我们不但可以在listBoardTopic()请求所对应的JSP视图页面中通过request.getAttribute(currUser)session.getAttribute(currUser)获取 user对象,还可以在下一个请求所对应的JSP视图页面中通过session.getAttribute(currUser)ModelMap#get(currUser)访问到这个属性。

1)这里我们仅将一个ModelMap的属性放入Session中,其实@SessionAttributes允许指定多个属性:

     你可以通过字符串数组的方式指定多个属性,如@SessionAttributes({attr1,attr2})


2)此外,@SessionAttributes还可以通过属性类型指定要session化的 ModelMap属性:

     如 @SessionAttributes(types= User.class)

   当然也可以指定多个类,如@SessionAttributes(types= {User.class,Dept.class})


3)还可以联合使用属性名和属性类型指定:

    @SessionAttributes(types= {User.class,Dept.class},value={attr1,attr2})


清单11.使模型对象的特定属性具有Session范围的作用域

上面讲述了如何往ModelMap中放置属性以及如何使ModelMap中的属性拥有Session域的作用范围。除了在JSP视图页面中通过传统的方法访问ModelMap中的属性外,读者朋友可能会问:是否可以将ModelMap中的属性绑定到请求处理方法的入参中呢?答案是肯定的。Spring为此提供了一个@ModelAttribute的注解,下面是使用@ModelAttribute注解的例子

@Controller

@RequestMapping("/bbtForum.do")

@SessionAttributes("currUser")//①ModelMapcurrUser属性拥有session级作用域

publicclass BbtForumController{

     @Autowired

privateBbtForumService bbtForumService;


   @RequestMapping(params= "method=listBoardTopic")

publicString listBoardTopic(@RequestParam("id")inttopicId,

Useruser,

ModelMapmodel) {

       bbtForumService.getBoardTopics(topicId);

       System.out.println("topicId:"+ topicId);

       System.out.println("user:"+ user);

       model.addAttribute("currUser",user);//②ModelMap中添加一个属性

        return"listTopic";

    }


//ModelMap中的currUser属性绑定到user入参中。因为currUsersession级别的

@RequestMapping(params= "method=listAllBoard")

publicString listAllBoard(@ModelAttribute("currUser")User user) {

       bbtForumService.getAllBoard();

       System.out.println("user:"+user);

        return"listBoard";

    }

}


处,我们向ModelMap中添加一个名为currUser的属性,

外的注解使这个currUser属性拥有了session级的作用域

所以,我们可以在处通过@ModelAttribute注解将ModelMap中的currUser属性绑定以请求处理方法的user入参中。

所以当我们先调用以下URL请求:

http://localhost/bbtForum.do?method=listBoardTopic&id=1&userName=tom&dept.deptId=12以执行listBoardTopic()请求处理方法,

然后再访问以下URLhttp://localhost/sample/bbtForum.do?method=listAllBoard

你将可以看到listAllBoard() user入参已经成功绑定到listBoardTopic()中注册的session级的currUser属性上了


4.请求处理方法的签名规约

4.1方法入参

我们知道标注了@RequestMapping注解的Controller方法就成为了请求处理方法,SpringMVC 允许极其灵活的请求处理方法签名方式。对于方法入参来说,它允许多种类型的入参,通过下表进行说明

请求处理方法入参的可选类型

说明

Java基本数据类型和String

默认情况下将按名称匹配的方式绑定到URL参数上,可以通过@RequestParam注解改变默认的绑定规则

request/response/session

既可以是ServletAPI 的也可以是PortletAPI 对应的对象,Spring会将它们绑定到ServletPortlet容器的相应对象上

org.springframework.web.context.request.WebRequest

内部包含了request对象

java.util.Locale

绑定到request对应的Locale对象上

java.io.InputStream/java.io.Reader

可以借此访问request的内容

java.io.OutputStream/ java.io.Writer

可以借此操作response的内容

任何标注了@RequestParam注解的入参

被标注@RequestParam注解的入参将绑定到特定的request参数上。

java.util.Map/ org.springframework.ui.ModelMap

它绑定SpringMVC 框架中每个请求所创建的潜在的模型对象,它们可以被Web视图对象访问(如JSP

命令/表单对象(注:一般称绑定使用HTTPGET 发送的URL参数的对象为命令对象,而称绑定使用HTTPPOST 发送的URL参数的对象为表单对象)

它们的属性将以名称匹配的规则绑定到URL参数上,同时完成类型的转换。而类型转换的规则可以通过@InitBinder注解或通过HandlerAdapter的配置进行调整

org.springframework.validation.Errors/org.springframework.validation.BindingResult

为属性列表中的命令/表单对象的校验结果,注意检验结果参数必须紧跟在命令/表单对象的后面

org.springframework.web.bind.support.SessionStatus

可以通过该类型status对象显式结束表单的处理,这相当于触发session清除其中的通过@SessionAttributes定义的属性


SpringMVC 框架的易用之处在于,你可以按任意顺序定义请求处理方法的入参(除了ErrorsBindingResult必须紧跟在命令对象/表单参数后面以外),SpringMVC 会根据反射机制自动将对应的对象通过入参传递给请求处理方法。这种机制让开发者完全可以不依赖ServletAPI 开发控制层的程序,当请求处理方法需要特定的对象时,仅仅需要在参数列表中声明入参即可,不需要考虑如何获取这些对象,SpringMVC 框架就象一个大管家一样不辞辛苦地为我们准备好了所需的一切。下面演示一下使用SessionStatus的例子:

清单12.使用SessionStatus控制Session级别的模型属性

@RequestMapping(method= RequestMethod.POST)

publicString processSubmit(@ModelAttributeOwner owner,

                                  BindingResultresult,

                                  SessionStatusstatus) {//<——①

       newOwnerValidator().validate(owner, result);

       if(result.hasErrors()) {

            return"ownerForm";

       }else{

           this.clinic.storeOwner(owner);

           status.setComplete();//<——②

            return"redirect:owner.do?ownerId=" + owner.getId();

       }

}


processSubmit()方法中的owner表单对象将绑定到ModelMapowner”属性中,

result参数用于存放检验owner结果的对象,

status用于控制表单处理的状态。

处,我们通过调用status.setComplete()方法,该Controller所有放在session级别的模型属性数据将从session中清空。


在默认情况下,ModelMap中的属性作用域是request级别是,也就是说,当本次请求结束后,ModelMap中的属性将销毁。如果希望在多个请求中共享ModelMap中的属性,必须将其属性转存到session中,这样ModelMap的属性才可以被跨请求访问。

Spring允许我们有选择地指定ModelMap中的哪些属性需要转存到session中,以便下一个请求属对应的ModelMap的属性列表中还能访问到这些属性。这一功能是通过类定义处标注@SessionAttributes注解来实现的。请看下面的代码:


清单10.使模型对象的特定属性具有Session范围的作用域

packagecom.baobaotao.web;

importorg.springframework.ui.ModelMap;

importorg.springframework.web.bind.annotation.SessionAttributes;


@Controller

@RequestMapping("/bbtForum.do")

@SessionAttributes("currUser")//①ModelMap中属性名为currUser的属性

//放到Session属性列表中,以便这个属性可以跨请求访问

publicclass BbtForumController{

   @RequestMapping(params= "method=listBoardTopic")

publicString listBoardTopic(@RequestParam("id")inttopicId,

Useruser,

ModelMapmodel) {

       bbtForumService.getBoardTopics(topicId);

       System.out.println("topicId:"+ topicId);

       System.out.println("user:"+ user);

       model.addAttribute("currUser",user);//②ModelMap中添加一个属性

        return"listTopic";

    }

}


我们在处添加了一个ModelMap属性,其属性名为currUser,而处通过@SessionAttributes注解将 ModelMap中名为 currUser的属性放置到Session中,所以我们不但可以在listBoardTopic()请求所对应的JSP视图页面中通过request.getAttribute(currUser)session.getAttribute(currUser)获取 user对象,还可以在下一个请求所对应的JSP视图页面中通过session.getAttribute(currUser)ModelMap#get(currUser)访问到这个属性。

1)这里我们仅将一个ModelMap的属性放入Session中,其实@SessionAttributes允许指定多个属性:

     你可以通过字符串数组的方式指定多个属性,如@SessionAttributes({attr1,attr2})


2)此外,@SessionAttributes还可以通过属性类型指定要session化的 ModelMap属性:

     如 @SessionAttributes(types= User.class)

   当然也可以指定多个类,如@SessionAttributes(types= {User.class,Dept.class})


3)还可以联合使用属性名和属性类型指定:

    @SessionAttributes(types= {User.class,Dept.class},value={attr1,attr2})


清单11.使模型对象的特定属性具有Session范围的作用域

上面讲述了如何往ModelMap中放置属性以及如何使ModelMap中的属性拥有Session域的作用范围。除了在JSP视图页面中通过传统的方法访问ModelMap中的属性外,读者朋友可能会问:是否可以将ModelMap中的属性绑定到请求处理方法的入参中呢?答案是肯定的。Spring为此提供了一个@ModelAttribute的注解,下面是使用@ModelAttribute注解的例子

@Controller

@RequestMapping("/bbtForum.do")

@SessionAttributes("currUser")//①ModelMapcurrUser属性拥有session级作用域

publicclass BbtForumController{

     @Autowired

privateBbtForumService bbtForumService;


   @RequestMapping(params= "method=listBoardTopic")

publicString listBoardTopic(@RequestParam("id")inttopicId,

Useruser, ModelMap model) {

       bbtForumService.getBoardTopics(topicId);

       System.out.println("topicId:"+ topicId);

       System.out.println("user:"+ user);

       model.addAttribute("currUser",user);//②ModelMap中添加一个属性

        return"listTopic";

    }


//ModelMap中的currUser属性绑定到user入参中。

@RequestMapping(params= "method=listAllBoard")

publicString listAllBoard(@ModelAttribute("currUser")User user) {


       bbtForumService.getAllBoard();

       System.out.println("user:"+user);

        return"listBoard";

    }

}


处,我们向ModelMap中添加一个名为currUser的属性,

外的注解使这个currUser属性拥有了session级的作用域。

所以,我们可以在处通过@ModelAttribute注解将ModelMap中的currUser属性绑定以请求处理方法的user入参中。所以当我们先调用以下URL请求:

http://localhost/bbtForum.do?method=listBoardTopic&id=1&userName=tom&dept.deptId=12以执行listBoardTopic()请求处理方法,

然后再访问以下URLhttp://localhost/sample/bbtForum.do?method=listAllBoard

你将可以看到listAllBoard() user入参已经成功绑定到listBoardTopic()中注册的session级的currUser属性上了


4.2方法返回参数

在低版本的SpringMVC 中,请求处理方法的返回值类型都必须是ModelAndView

而在Spring2.5 中,你拥有多种灵活的选择。通过下表进行说明:

请求处理方法入参的可选类型

说明

void

此时逻辑视图名由请求处理方法对应的URL确定,如以下的方法:

@RequestMapping("/welcome.do")

    publicvoid welcomeHandler() {

}

对应的逻辑视图名为welcome”

String

此时逻辑视图名为返回的字符,如以下的方法:

@RequestMapping(method= RequestMethod.GET)

publicString setupForm(

    @RequestParam("ownerId")int ownerId,

     ModelMapmodel) {

         Ownerowner = this.clinic.loadOwner(ownerId);

        model.addAttribute(owner);

         return"ownerForm";

}

对应的逻辑视图名为ownerForm

org.springframework.ui.ModelMap

和返回类型为void一样,逻辑视图名取决于对应请求的URL,如下面的例子:

@RequestMapping("/vets.do")

publicModelMap vetsHandler(){

         returnnew ModelMap(this.clinic.getVets());

}

对应的逻辑视图名为vets,返回的ModelMap将被作为请求对应的模型对象,可以在JSP视图页面中访问到。

ModelAndView

当然还可以是传统的ModelAndView

应该说使用 String作为请求处理方法的返回值类型是比较通用的方法,这样返回的逻辑视图名不会和请求URL绑定,具有很大的灵活性,而模型数据又可以通过ModelMap控制。当然直接使用传统的ModelAndView也不失为一个好的选择。


6.如何准备数据--@ModelAttribute

在编写Controller时,常常需要在真正进入请求处理方法准备一些数据,以便请求处理视图渲染时使用。在传统的SimpleFormController里,是通过复写其referenceData()方法来准备引用数据的。

Spring2.5 时,可以将任何一个拥有返回值的方法标注上@ModelAttribute,使其返回值将会进入到模型对象的属性列表中。来看下面的例子:

6.1清单16.定义为处理请求准备数据的方法

importorg.springframework.web.bind.annotation.SessionAttributes;

importjava.util.ArrayList;

importjava.util.List;

importjava.util.Set;

@Controller

@RequestMapping("/bbtForum.do")

publicclass BbtForumController{


   @Autowired

    privateBbtForumService bbtForumService;


   @ModelAttribute("items")//<——①向模型对象中添加一个名为items的属性

    publicList<String> populateItems(){

        List<String>lists = new ArrayList<String>();

       lists.add("item1");

       lists.add("item2");

        returnlists;

    }

   @RequestMapping(params= "method=listAllBoard")

publicString listAllBoard(

@ModelAttribute("currUser")Useruser,ModelMap model){

       bbtForumService.getAllBoard();

       //<——②在此访问模型中的items属性

       System.out.println("model.items:"+

                     ((List<String>)model.get("items")).size());

        return"listBoard";

    }

}


说明:

处,通过使用@ModelAttribute注解,populateItem()方法将在任何请求处理方法执行调用,SpringMVC 会将该方法返回值以items”为名放入到隐含的模型对象属性列表中。

所以在处,我们就可以通过ModelMap入参 访问到items属性,当执行listAllBoard()请求处理方法时,处将在控制台打印出model.items:2”的信息。


当然我们也可以在请求的视图中访问到模型对象中的items属性。

7.@MVC表单处理

一个典型的表单处理场景包括:获得可编辑对象,在编辑模式下显示它持有的数据、允许用户提交并最终进行验证和保存变化数据。

SpringMVC提供下列几个特性辅助进行上述所有活动:

  1. 数据绑定机制,完全用从请求参数中获得的数据填充一个对象;

  2. 支持错误处理和验证;

  3. JSP表单标记库;

  4. 基类控制器。

使用@MVC,除了由于@ModelAttribute@InitBinder@SessionAttributes这些注解的存在而不再需要基类控制器外,其它一切都不需要改变。

7.1@ModelAttribute注解

看一下这些请求处理方法签名:

@RequestMapping(method=RequestMethod.GET)

publicAccountsetupForm(){

    ...

}

@RequestMapping(method=RequestMethod.POST)

publicvoid onSubmit(Accountaccount) {

    ...

}

它们是非常有效的请求处理方法签名。

第一个方法处理初始的HTTPGET请求,准备被编辑的数据,返回一个Account对象SpringMVC表单标签使用。

第二个方法在用户提交更改时处理随后的HTTPPOST请求,并接收一个Account对象作为输入参数,它是SpringMVC的数据绑定机制用请求中的参数自动填充的。这是一个非常简单的程序模型。

1.xxx.jsp

Account对象含有要被编辑的数据。

SpringMVC的术语当中,Account被称作是表单模型对象。这个对象必须通过某个名称让表单标签(还有数据绑定机制)知道它的存在。下面是从JSP页面中截取的部分代码,引用了一个名为account的表单模型对象:

<form:form modelAttribute="account" method="post">

    AccountNumber: <form:input path="number"/><form:errorspath="number"/>

    ...

</form>


2.xxxController.java

即使我们没有在任何地方指定account的名称,这段JSP程序也会和上面所讲的方法签名协作的很好。这是因为@MVC返回对象类型名称作为默认值,因此一个Account类型的对象默认的就对应一个名为account的表单模型对象。如果默认的不合适,我们就可以用@ModelAttribute来改变它的名称,如下所示:

@RequestMapping(method=RequestMethod.GET)

public@ModelAttribute("account")SpecialAccount setupForm(){

    ...

}

@RequestMapping(method=RequestMethod.POST)

publicvoid update(@ModelAttribute("account")SpecialAccount account) {

    ...

}


此处setupForm()不是一个请求处理方法,而是任何请求处理方法被调用之前,用来准备表单项模型对象的一个方法。对那些熟悉SpringMVC的老用户来说,这和SimpleFormControllerformBackingObject()方法是非常相似的。

最初的GET方法中我们得到一次表单模型对象,在随后的POST方法中当我们依靠数据绑定机制用用户所做的改变覆盖已有的Account对象时,我们会第二次得到它,在这种表单处理场景中把@ModelAttribute放在方法上是很有用的。当然,作为一种两次获得对象的替换方案,我们也可以在两次请求过程中将它保存进HTTP的会话(session),这就是我们下面将要分析的情况。


7.2@SessionAttributes存储属性

@SessionAttributes注解可以用来指定请求过程中要放进session中的表单模型对象的名称或类型,例子:

@Controller

@SessionAttributes("account")

publicclass AccountFormController{

    ...

}

@Controller

@SessionAttributes(types= Account.class)

publicclass AccountFormController{

    ...

}


根据上面的注解,AccountFormController会在初始的GET方法和随后的POST方法之间,把名为account的表单模型对象(或者象第二个例子中的那样,把所有Account类型的表单模型对象)存入HTTP会话(session)中。不过,当有改变连续发生的时候,就应当把属性对象从会话中移除了。我们可以借助SessionStatus实例来做这件事,如果把它添加进onSubmit的方法签名中,@MVC会完成这个任务:

@RequestMapping(method=RequestMethod.POST)

publicvoid onSubmit(Accountaccount, SessionStatus sessionStatus) {

    ...

   sessionStatus.setComplete();//Clears @SessionAttributes

}


7.3雁联例子

1.效果图:

subProcess.jsp”页面,点击修改按钮,进入修改页面(modifyProcess.jsp)”,

“修改页面(modifyProcess.jsp)”上会显示该条记录的信息(根据ID从数据库读取记录,然后显示在页面上)



2.遇到的问题:

用户在修改页面(modifyProcess.jsp)修改了信息后,

用户再次点击修改按钮进入到修改页面(modifyProcess.jsp)时,修改页面(modifyProcess.jsp)上显示的不是修改后的信息,而还是修改前信息。

解决方案:此问题是由于浏览器的缓存引起的,在修改页面(modifyProcess.jsp)head加入如下语句:

<metahttp-equiv="pragma"content="no-cache">

<metahttp-equiv="cache-control"content="no-cache">

<metahttp-equiv="expires"content="0">


<basetarget="_self">

<scripttype="text/javascript"

         src="<spring:url

         value="/static/js/public.js"/>">

</script>

<linkhref="<spring:url

      value="/static/css/cssCn.css"/>"

      rel="stylesheet"

       type="text/css"/>


subProcess.jsp页面,关于修改按钮 代码如下:

<tdalign="center">

<inputtype="button" name="Submit"value="修改"

        onClick="modifyProecss(

  '<c:urlvalue="/procAdmin/subSysProc?method=modifyProcUI&id=${process.id}"/>');"class="button">

</td>


3.xxxController.java

subProcess.jsp页面 点击修改按钮,程序运行到xxxController.java.

@Controller

@RequestMapping("/procAdmin/subSysProc")

publicclassSubSysProController{

    privateValidator beanValidator;

   @RequestMapping(params= "method=modifyProcUI",method= RequestMethod.GET)

publicString modifyProcUI(Processprocess, BindingResult resultModelmodel) {

       beanValidator.validate(process,result);

if(result.hasErrors()) {

returnaddProcUI();

}

   

       //根据要修改记录ID,得到要修改的记录的信息

process= processService.getProcessById(process.getId());

System.out.println("1.prcsDescription="+process.getPrcsDescription());

//获得子系统列表

List<SubSys>subSysList = subSysService.getAllSubSysList();


model.addAttribute("process",process);

model.addAttribute("subSysList",subSysList);

return"processManage/processModify";

}

}


4.zfpt-servlet.xml

<beansxmlns="http://www.springframework.org/schema/beans"

      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

      xmlns:webflow="http://www.springframework.org/schema/webflow-config"

      xmlns:p="http://www.springframework.org/schema/p"

      xmlns:context="http://www.springframework.org/schema/context"

      xmlns:mvc="http://www.springframework.org/schema/mvc"     

      xsi:schemaLocation="

      http://www.springframework.org/schema/mvchttp://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd

      http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.0.xsd

      http://www.springframework.org/schema/webflow-confighttp://www.springframework.org/schema/webflow-config/spring-webflow-config-2.0.xsd

      http://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsd">

   <context:component-scanbase-package="com.ylink.zfpt.web.spring"/>

<beanclass="org.springframework.web.servlet.mvc.annotation.

AnnotationMethodHandlerAdapter">

<propertyname="webBindingInitializer">

<beanclass="com.ylink.zfpt.web.spring.ZfptBindingInitializer"/>

</property>

</bean>


<beanid="beanValidator"class="org.springmodules.validation.commons.DefaultBeanValidator">

<propertyname="validatorFactory"ref="validatorFactory"/>

</bean>

<beanid="validatorFactory"class="org.springmodules.validation.commons.DefaultValidatorFactory">

<propertyname="validationConfigLocations">

<list>

<value>/WEB-INF/validator-rules.xml</value>

<value>/WEB-INF/validator.xml</value>

</list>

</property>

</bean>


5.modifyProcess.jsp

<head>

   //禁止浏览器缓存,本例子中有用

   <metahttp-equiv="pragma"content="no-cache">

<metahttp-equiv="cache-control"content="no-cache">

<metahttp-equiv="expires"content="0">

   

    <basetarget="_self">

</head>


<body>

<form:formmodelAttribute="process"

                 action="<c:urlvalue='/procAdmin/subSysProc'/>"method="PUT">

       <tableclass=tb_inputcellspacing=1width="100%">

          <tr>

<tdwidth="15%"nowrapclass="td_title">

&nbsp;&nbsp;&nbsp;

<spanclass="fond_bSTYLE2">*</span>

     </td>

<td>

<form:inputpath="imageName"cssStyle="WIDTH:180px"maxlength="15"/>

<form:errorspath="imageName"cssClass="errors"/>

</td>

</tr>

         <tr>

<tdnowrapclass="td_title">

   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;

</td>

<td>

<form:inputpath="prcsDescription"

                                cssStyle="WIDTH:180px" maxlength="200"/>

</td>

     </tr>

         <tr>

<tdnowrapclass="td_title">

&nbsp;工作目录

</td>

<td>

<form:inputpath="workDirectory"

                              cssStyle="WIDTH:180px"maxlength="100"/>

</td>

</tr>

        <tr>

<tdnowrapclass="td_title">

&nbsp;&nbsp;&nbsp;

<spanclass="fond_bSTYLE2">*</span>

  </td>

  <td>

   <form:selectpath="subSys.id"cssStyle="WIDTH:180px">

<form:optionvalue=""></form:option>

   <form:optionsitems="${subSysList}"

                                         itemLabel="code"itemValue="id"/>

</form:select>

<form:errorspath="subSys.id"cssClass="errors"/>

</td>

</tr>

      </table>

      <inputtype="button"class="button"onclick="save();"value="修改进程"/>

<inputtype="button" value="取消"class="button"onclick="window.close();">

</form:form>


<script>

   functionsave(){    

          document.forms[0].action="<c:urlvalue='/procAdmin/subSysProc'/>";

          document.forms[0].submit();    

   }

</script>


8.定制数据绑定--@InitBinder注解

有时数据绑定需要定制,例如我们也许需要指定必需填写的域,或者需要为日期、货币金额等类似事情注册定制的PropertyEditors。用@MVC实现这些功能是非常容易的:

@InitBinder

publicvoid initDataBinder(WebDataBinderbinder){

   binder.setRequiredFields(newString[] {"number", "name"});

}

@InitBinder注解方法可以访问@MVC用来绑定请求参数DataBinder实例,它允许我们为每个控制器定制必须项


1.注册自己的属性编辑器

SpringMVC 有一套常用的属性编辑器,这包括基本数据类型及其包裹类的属性编辑器String属性编辑器JavaBean的属性编辑器等。但有时我们还需要向SpringMVC 框架注册一些自定义的属性编辑器,如特定时间格式的属性编辑器就是其中一例。

1)SpringMVC  允许向整个 Spring框架 注册属性编辑器,它们对所有Controller都有影响。

2)当然SpringMVC 也允许仅向某个Controller注册属性编辑器,对其它的Controller没有影响。

前者可以通过AnnotationMethodHandlerAdapter的配置做到,而后者则可以通过@InitBinder注解实现。


1:下面先看向整个SpringMVC 框架注册的自定义编辑器:

清单13.注册框架级的自定义属性编辑器

<bean  class="org.springframework.web.servlet.mvc.annotation.

AnnotationMethodHandlerAdapter">

       <propertyname="webBindingInitializer">

           <beanclass="com.baobaotao.web.MyBindingInitializer"/>

       </property>

</bean>


清单14.自定义属性编辑器--配置一个定制的WebBindingInitializer

为了外化数据绑定初始化的过程,可以提供一个WebBindingInitializer接口的自定义实现。通过为一个AnnotationMethodHandlerAdapter提供一个定制的bean配置可以使它启用,这样就覆盖了默认配置。


例子:MyBindingInitializer实现了WebBindingInitializer接口,在接口方法中通过binder注册多个自定义的属性编辑器.为所有的java.util.Date表单属性配置一个CustomDateEditor。其代码如下所示:

packageorg.springframework.samples.petclinic.web;


importjava.text.SimpleDateFormat;

importjava.util.Date;

importorg.springframework.beans.factory.annotation.Autowired;

importorg.springframework.beans.propertyeditors.CustomDateEditor;

importorg.springframework.beans.propertyeditors.StringTrimmerEditor;

importorg.springframework.samples.petclinic.Clinic;

importorg.springframework.samples.petclinic.PetType;

importorg.springframework.web.bind.WebDataBinder;

importorg.springframework.web.bind.support.WebBindingInitializer;

importorg.springframework.web.context.request.WebRequest;

publicclass MyBindingInitializerimplements WebBindingInitializer{

    publicvoid initBinder(WebDataBinderbinder,WebRequestrequest){

        SimpleDateFormatdateFormat= new SimpleDateFormat("yyyy-MM-dd");

       dateFormat.setLenient(false);


       binder.registerCustomEditor(

Date.class,new CustomDateEditor(dateFormat,false));

       binder.registerCustomEditor(

String.class,new StringTrimmerEditor(false));

    }

}


2:看特定的Controller注册的自定义编辑器:

如果希望 某个属性编辑器仅作用于特定的Controller,可以在Controller中定义一个标注@InitBinder注解的方法,可以在该方法中向Controller了注册若干属性编辑器.


使用@InitBinder 注解控制器方法,可以在控制器类内部直接配置Web数据绑定

@InitBinder指定初始化WebDataBinder的方法,后者被用于填充注解句柄方法命令表单对象参数


这个init-binder方法支持@RequestMapping支持的全部参数,除了命令/表单对象和对应的验证结果对象。Init-binder方法必须没有返回值。因此,它们常被声明为void典型的参数,包括WebDataBinder以及WebRequest或者java.util.Locale,允许代码注册上下文特定的编辑器。


下面的例子说明了@InitBinder的用法,来看下面的代码:

清单15.注册Controller级的自定义属性编辑器

注意:被标注@InitBinder注解方法必须拥有一个WebDataBinder类型入参,以便SpringMVC 框架注册 属性编辑器WebDataBinder对象传递进来。

@Controller

publicclass MyFormController{


   @InitBinder

    publicvoid initBinder(WebDataBinderbinder){

        SimpleDateFormatdateFormat= new SimpleDateFormat("yyyy-MM-dd");

       dateFormat.setLenient(false);


       binder.registerCustomEditor(

Date.class,new CustomDateEditor(dateFormat,false));

        //binder.setRequiredFields(newString[] {"number", "name"});

    }

    …

}



9.数据绑定结果和验证--BindingResult

数据绑定也许会导致类似于类型转换域缺失的错误。

不管发生什么错误,我们都希望能返回到编辑的表单,让用户自行更正。

要想实现这个目的,我们可直接在方法签名表单模型对象后面追加一个BindingResult对象(注意检验结果参数必须紧跟在命令/表单对象的后面),例如:


0)xxxController.java

@RequestMapping(method=RequestMethod.POST)

publicModelAndView onSubmit(Accountaccount, BindingResultbindingResult){

    if(bindingResult.hasErrors()){

       ModelAndViewmav = new ModelAndView();

      mav.getModel().putAll(bindingResult.getModel());

       returnmav;

    }

    //Save the changes and redirect to the next view...

}


发生错误时我们返回到出现问题的视图,并把从BindingResult得到的属性增加到模型上,这样特定域的错误就能够反馈给用户。要注意的是,我们并没有指定一个显式的视图名,而是允许DispatcherServlet依靠与入口URI路径信息匹配的默认视图名。

调用Validator对象并把BindingResult传给它,仅这一行代码就可实现验证操作。这允许我们在一个地方收集绑定和验证错误:


0)xxxController.java

@RequestMapping(method=RequestMethod.POST)

publicModelAndView onSubmit(Accountaccount, BindingResultbindingResult){

      newAccountValidator().validate(account, bindingResult);

      if(bindingResult.hasErrors()){

           ModelAndViewmav = new ModelAndView();

          mav.getModel().putAll(bindingResult.getModel());

           returnmav;

      }

     //Save the changes and redirect to the next view...

}


1)OwnerValidator.java

publicclassAccountValidator{

publicvoidvalidate(Ownerowner, Errors errors){

if(!StringUtils.hasLength(owner.getFirstName())){

errors.rejectValue("firstName","required","required");

}

if(!StringUtils.hasLength(owner.getLastName())){

errors.rejectValue("lastName","required","required");

}

if(!StringUtils.hasLength(owner.getAddress())){

errors.rejectValue("address","required","required");

}

if(!StringUtils.hasLength(owner.getCity())){

errors.rejectValue("city","required","required");

}


Stringtelephone = owner.getTelephone();

if(!StringUtils.hasLength(telephone)){

errors.rejectValue("telephone","required","required");

}else{

for(inti = 0; i < telephone.length(); ++i) {

if((Character.isDigit(telephone.charAt(i)))== false){

errors.rejectValue("telephone","nonNumeric","non-numeric");

break;

}

}

}

}

}


2)xxx.jsp

<td>

<form:inputpath="firstName"cssStyle="WIDTH:180px"maxlength="15"/>

<form:errorspath="firstName"cssClass="errors"/>

</td>


现在是时候结束我们的Spring2.5 Web层注解(非正式称法为@MVC)之旅了。


10.消除类级别的请求映射

Web层注解频遭诟病是有事实依据的,那就是嵌入源代码的URI路径。

这个问题很好矫正,URI路径和控制器类之间的匹配关系用XML配置文件去管理,只在方法级映射中使用@RequestMapping注解

我们将配置一个ControllerClassNameHandlerMapping,它使用依赖控制器类名字的惯例,将URI映射到控制器:

<beanclass="org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping"/>

现在/accounts/*这样的请求都被匹配到AccountsController上,它与方法级别上的@RequestMapping注解协作的很好,只要添加上方法名就能够完成上述映射。此外,既然我们的方法并不会返回视图名称,我们现在就可以依据惯例匹配类名、方法名、URI路径和视图名。


@Controller被完全转换为@MVC后,程序的写法如下:

@Controller

publicclass AccountsController{

      privateAccountRepository accountRepository;


     @Autowired

      publicAccountsController(AccountRepositoryaccountRepository) {

          this.accountRepository= accountRepository;

      }


    @RequestMapping(method=RequestMethod.GET)

publicvoid show(@RequestParam("number")Stringnumber, 

Map<String,Object> model) {

         model.put("account",accountRepository.findAccount(number));

     }

    ...


对应的XML配置文件如下:

<context:component-scanbase-package="com.abc.accounts"/>


       <beanclass="org.springframework.web.servlet.mvc.support.

ControllerClassNameHandlerMapping"/>


       <beanclass="org.springframework.web.servlet.view.

                                         InternalResourceViewResolver">

            <propertyname="prefix" value="/WEB-INF/views/" />

            <propertyname="suffix" value=".jsp" />

       </bean>

你可以看出这是一个最精减的XML。程序里注解中没有嵌入URI路径,也没有显式指定视图名,请求处理方法也只有很简单的一行,方法签名与我们的需求精准匹配,其它的请求处理方法也很容易添加。不需要基类,也不需要XML(至少也是没有直接配置控制器),我们就能获得上述所有优势。

也许接下来你就可以看到,这种程序设计模型是多么有效了。


11.@RequestMapping简介

11.1灵活的请求处理方法签名

我们曾经承诺过要提供灵活的方法签名,现在来看一下成果。

输入的参数中移除了响应对象,增加了一个代表模型的Map

返回的不再是ModelAndView,而是一个字符串,指明呈现响应时要用的视图名字:

@RequestMapping("/accounts/show")

publicString show(HttpServletRequestrequest, Map<String, Object> model)

throwsException {

      Stringnumber = ServletRequestUtils.getStringParameter(request,"number");

     model.put("account",accountRepository.findAccount(number));

      return"/WEB-INF/views/accounts/show.jsp";

}


Map输入参数是一个隐式的模型,对于我们来说在调用方法前创建它很方便,其中添加的键值对数据便于在视图中解析应用。本例视图为show.jsp页面。


11.2当方法没有指定视图时

有种令人感兴趣的情形是当方法没有指定视图时(例如返回类型为void)会有什么事情发生,按照惯例DispatcherServlet要再使用请求URI的路径信息,不过要移去前面的斜杠和扩展名。让我们把返回类型改为void

@RequestMapping("/accounts/show")

publicvoid show(HttpServletRequestrequest, Map<String, Object> model)

throwsException {

       Stringnumber = ServletRequestUtils.getStringParameter(request,"number");

      model.put("account",accountRepository.findAccount(number));

}

对于给定的请求处理方法和/accounts/show的请求映射,我们可以期望DispatcherServlet能够获得accounts/show的默认视图名称,当它与如下适当的视图解析器结合共同作用时,会产生与前面指明返回视图名同样的结果:

<beanclass="org.springframework.web.servlet.view.InternalResourceViewResolver">

       <propertyname="prefix" value="/WEB-INF/views/" />

       <propertyname="suffix" value=".jsp" />

</bean>

强烈推荐视图名称依赖惯例的方式,因为这样可以从控制器代码中消除硬编码的视图名称。如果你想定制DispatcherServlet获取默认视图名的方式,就在servlet上下文环境中配置一个你自己的RequestToViewNameTranslator实现,并为其beanid赋名为viewNameTranslator


11.3继续@RequestMapping的讨论

@RequestMapping放在类级别上是合法的,这可令它与方法级别上的@RequestMapping注解协同工作,取得缩小选择范围的效果,下面是一些例子:

11.1类级别:

RequestMapping("/accounts/*")


11.2方法级别:

@RequestMapping(value="delete",method=RequestMethod.POST)

@RequestMapping(value="index",method=RequestMethod.GET, params="type=checking")

@RequestMapping


第一个方法级的请求映射和类级别的映射结合,当HTTP方法是POST时与路径/accounts/delete匹配;

第二个添加了一个要求,就是名为type的请求参数和其值checking都需要在请求中出现;

第三个根本就没有指定路径,这个方法匹配所有的HTTP方法,如果有必要的话可以用它的方法名。

下面改写我们的方法,使它可以依靠方法名进行匹配,程序如下:

@Controller

@RequestMapping("/accounts/*")

publicclass AccountsController{


   @RequestMapping(method=RequestMethod.GET)

publicvoid show(@RequestParam("number")String number,

Map<String,Object> model){

          model.put("account",accountRepository.findAccount(number));

    }

    ...


方法匹配的请求是/accounts/show,依据的是类级别的@RequestMapping指定的匹配路径/accounts/*和方法名show


13.@PathVariable

@PathVariable是用来对指定请求的URL路径里面的变量

1:

@RequestMapping(value = "form/{id}/apply", 

                    method = {RequestMethod.PUT, RequestMethod.POST})  

{id}在这个请求的URL里就是个变量,可以使用@PathVariable来获取.

@PathVariable@RequestParam的区别就在于:@RequestParam用来获得静态的URL请求入参.


2:雁联

1.channelManage.jsp

<input  type="button"  name="Submit"  class="button"  value="启动渠道"

         onclick="window.showModalDialog('<spring:urlvalue="/channel/${channel.channelID}/start"/>',null,'dialogleft=200px;dialogtop=260px;dialogwidth=800px;dialogheight=400px');location.reload();">


2.ChannelManageController.java

@RequestMapping(value= "/channel/{channelId}/start",method = RequestMethod.GET)

publicString start(@PathVariableInteger channelId)

throwsIOException, MalformedObjectNameException, NullPointerException,

InstanceNotFoundException,MBeanException, ReflectionException,

BusinessException{

//前面要加上权限控制

}


  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值