java 注解式控制器详解(SpringMVC强大的数据绑定)

注解式控制器详解(SpringMVC强大的数据绑定)

到目前为止,请求已经能交给我们的处理器进行处理了,接下来的事情是要进行收集数据啦,接下来我们看看我们能从请求中收集到哪些数据,如图6-11:


图6-11

[email protected]

[email protected]

[email protected]

[email protected]

[email protected]

[email protected]

[email protected]型转换等。

[email protected]/data”数据,[email protected],还能绑定上传的文件等。

 

除了上边提到的注解,我们还可以通过如HttpServletRequest等API得到请求数据,但推荐使用注解方式,因为使用起来更简单。

 

接下来先看一下功能处理方法支持的参数类型吧。

6.6.1、功能处理方法支持的参数类型

在继续学习之前,我们需要首先看看功能处理方法支持哪些类型的形式参数,以及他们的具体含义。

一、ServletRequest/HttpServletRequest 和 ServletResponse/HttpServletResponse

Java代码
  1. public String requestOrResponse (
  2.        ServletRequest servletRequest, HttpServletRequest httpServletRequest,
  3.        ServletResponse servletResponse, HttpServletResponse httpServletResponse
  4.    )

 

Spring Web MVC框架会自动帮助我们把相应的Servlet请求/响应(Servlet API)作为参数传递过来。

 

二、InputStream/OutputStream 和 Reader/Writer

Java代码
  1. public void inputOrOutBody(InputStream requestBodyIn, OutputStream responseBodyOut)
  2.        throws IOException {
  3. responseBodyOut.write(“success”.getBytes());
  4. }

requestBodyIn:获取请求的内容区字节流,等价于request.getInputStream();

responseBodyOut:获取相应的内容区字节流,等价于response.getOutputStream()。

Java代码
  1. public void readerOrWriteBody(Reader reader, Writer writer)
  2.        throws IOException {
  3.    writer.write(“hello”);
  4. }

 

reader:获取请求的内容区字符流,等价于request.getReader();

writer:获取相应的内容区字符流,等价于response.getWriter()。

 

InputStream/OutputStream 和 Reader/Writer两组不能同时使用,只能使用其中的一组。

 

三、WebRequest/NativeWebRequest

WebRequest是Spring Web MVC提供的统一请求访问接口,不仅仅可以访问请求相关数据(如参数区数据、请求头数据,但访问不到Cookie区数据),还可以访问会话和上下文中的数 据;NativeWebRequest继承了WebRequest,并提供访问本地Servlet API的方法。

Java代码
  1. public String webRequest(WebRequest webRequest, NativeWebRequest nativeWebRequest) {
  2.    System.out.println(webRequest.getParameter(“test”));//①得到请求参数test的值
  3.    webRequest.setAttribute(“name”, “value”, WebRequest.SCOPE_REQUEST);//②
  4.    System.out.println(webRequest.getAttribute(“name”, WebRequest.SCOPE_REQUEST));
  5.    HttpServletRequest request =
  6.        nativeWebRequest.getNativeRequest(HttpServletRequest.class);//③
  7.    HttpServletResponse response =
  8.        nativeWebRequest.getNativeResponse(HttpServletResponse.class);
  9.        return “success”;
  10.    }

① webRequest.getParameter:访问请求参数区的数据,可以通过getHeader()访问请求头数据;

② webRequest.setAttribute/getAttribute:到指定的作用范围内取/放属性数据,Servlet定义的三个作用范围分别使用如下常量代表:

SCOPE_REQUEST :代表请求作用范围;

SCOPE_SESSION :代表会话作用范围;

SCOPE_GLOBAL_SESSION :代表全局会话作用范围,即ServletContext上下文作用范围。

③ nativeWebRequest.getNativeRequest/nativeWebRequest.getNativeResponse:得到本地的Servlet API。

 

四、HttpSession

Java代码
  1. public String session(HttpSession session) {
  2.    System.out.println(session);
  3.    return “success”;
  4. }

此处的session永远不为null。

 

注意:session访问不是线程安全的,如果需要线程安全,需要设置AnnotationMethodHandlerAdapter或 RequestMappingHandlerAdapter的synchronizeOnSession属性为true,即可线程安全的访问 session。

 

 

五、命令/表单对象

Spring Web MVC能够自动将请求参数绑定到功能处理方法的命令/表单对象上。

Java代码
  1. @RequestMapping(value = “/commandObject”, method = RequestMethod.GET)
  2. public String toCreateUser(HttpServletRequest request, UserModel user) {
  3.    return “customer/create”;
  4. }
  5. @RequestMapping(value = “/commandObject”, method = RequestMethod.POST)
  6. public String createUser(HttpServletRequest request, UserModel user) {
  7.    System.out.println(user);
  8.    return “success”;
  9. }

 

如果提交的表单(包含username和password文本域),将自动将请求参数绑定到命令对象user中去。

 

六、Model、Map、ModelMap

Spring Web MVC 提供Model、Map或ModelMap让我们能去暴露渲染视图需要的模型数据。

Java代码
  1. @RequestMapping(value = “/model”)
  2. public String createUser(Model model, Map model2, ModelMap model3) {
  3.    model.addAttribute(“a”, “a”);
  4.    model2.put(“b”, “b”);
  5.    model3.put(“c”, “c”);
  6.    System.out.println(model == model2);
  7.    System.out.println(model2 == model3);
  8.    return “success”;}

 

虽然此处注入的是三个不同的类型(Model model, Map model2, ModelMap model3),但三者是同一个对象,如图6-12所示:

图6-11

AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter将使用 BindingAwareModelMap作为模型对象的实现,即此处我们的形参(Model model, Map model2, ModelMap model3)都是同一个BindingAwareModelMap实例。

 

此处还有一点需要我们注意:

  1. @RequestMapping(value = “/mergeModel”)
  2. public ModelAndView mergeModel(Model model) {
  3.    model.addAttribute(“a”, “a”);//①添加模型数据
  4.    ModelAndView mv = new ModelAndView(“success”);
  5.    mv.addObject(“a”, “update”);//②在视图渲染之前更新③处同名模型数据
  6.    model.addAttribute(“a”, “new”);//③修改①处同名模型数据
  7.    //视图页面的a将显示为”update” 而不是”new”
  8.    return mv;
  9. }

从代码中我们可以总结出功能处理方法的返回值中的模型数据(如ModelAndView)会 合并 功能处理方法形式参数中的模型数据(如Model),但如果两者之间有同名的,返回值中的模型数据会覆盖形式参数中的模型数据。

 

七、Errors/BindingResult

Java代码
  1. @RequestMapping(value = “/error1”)
  2. public String error1(UserModel user, BindingResult result)
  1. @RequestMapping(value = “/error2”)
  2. public String error2(UserModel user, BindingResult result, Model model) {
  1. @RequestMapping(value = “/error3”)
  2. public String error3(UserModel user, Errors errors)

以上代码都能获取错误对象。

 

Spring3.1之前(使用AnnotationMethodHandlerAdapter)错误对象必须紧跟在命令对象/表单对象之后,如下定义是错误的:

Java代码
  1. @RequestMapping(value = “/error4”)
  2. public String error4(UserModel user, Model model, Errors errors)
  3.    }

如上代码从Spring3.1开始(使用RequestMappingHandlerAdapter)将能正常工作,但还是推荐“错误对象紧跟在命令对象/表单对象之后”,这样是万无一失的。

 

Errors及BindingResult的详细使用请参考4.16.2数据验证。

 

 

八、其他杂项

 

public String other(Locale locale, Principal principal)

java.util.Locale:得到当前请求的本地化信息,默认等价于ServletRequest.getLocale(),如果配置LocaleResolver解析器则由它决定Locale,后续介绍;

 

java.security.Principal:该主体对象包含了验证通过的用户信息,等价于HttpServletRequest.getUserPrincipal()。

 

[email protected]

@[email protected]法的参数上。

public String requestparam1(@RequestParam String username)

请求中包含username参数(如/requestparam1?username=zhang),则自动传入。

 

此处要特别注意:右击项目,选择“属性”,打开“属性对话框”,选择“Java Compiler”然后再打开的选项卡将“Add variable attributes to generated class files”取消勾选,意思是不将局部变量信息添加到类文件中,如图6-12所示:

图6-12

当你在浏览器输入URL,如“requestparam1?username=123”时会报如下错误

Name for argument type [java.lang.String] not available, and parameter name information not found in class file either,表示得不到功能处理方法的参数名,此时我们需要如下方法进行入参:

Java代码
  1. public String requestparam2(@RequestParam(“username”) String username)

[email protected](“username”)明确告诉Spring Web MVC使用username进行入参。

 

[email protected]

value:参数名字,即入参的请求参数名字,如username表示请求的参数区中的名字为username的参数的值将传入;

required:是否必须,默认是true,表示请求中一定要有相应的参数,否则将报404错误码;

defaultValue:默认值,表示如果请求中没有同名参数时的默认值,默认值可以是SpEL表达式,如“#{systemProperties[‘java.vm.version’]}”。

Java代码
  1. public String requestparam4(@RequestParam(value=”username”,required=false) String username)

表示请求中可以没有名字为username的参数,如果没有默认为null,此处需要注意如下几点:

 

原子类型:必须有值,否则抛出异常,如果允许空值请使用包装类代替。

Boolean包装类型类型:默认Boolean.FALSE,其他引用类型默认为null。

Java代码
  1. public String requestparam5(
  2. @RequestParam(value=”username”, required=true, defaultValue=”zhang”) String username)

表示如果请求中没有名字为username的参数,默认值为“zhang”。

 

如果请求中有多个同名的应该如何接收呢?如给用户授权时,可能授予多个权限,首先看下如下代码:

Java代码
  1. public String requestparam7(@RequestParam(value=”role”) String roleList)

如果请求参数类似于url?role=admin&rule=user,则实际roleList参数入参的数据为“admin,user”,即多个数据之间使用“,”分割;我们应该使用如下方式来接收多个请求参数:

Java代码
  1. public String requestparam7(@RequestParam(value=”role”) String[] roleList)

Java代码
  1. public String requestparam8(@RequestParam(value=”list”) List<String> list)

[email protected],以上测试代码在cn.javass.chapter6.web.controller. paramtype.RequestParamTypeController中。

 

[email protected]

@[email protected]理方法的参数上。

Java代码
  1. @RequestMapping(value=”/users/{userId}/topics/{topicId}”)
  2. public String test(
  3.     [email protected](value=”userId”) int userId,
  4.     [email protected](value=”topicId”) int topicId)

如请求的URL为“控制器URL/users/123/topics/456”,则自动将URL中模板变量{userId}和 [email protected],即入参后userId=123、topicId=456。代码在 PathVariableTypeController中。

 

[email protected]

@[email protected]法的参数上。

Java代码
  1. public String test(@CookieValue(value=”JSESSIONID”, defaultValue=””) String sessionId)

 

如上配置将自动将JSESSIONID值入参到sessionId参数上,defaultValue表示Cookie中没有JSESSIONID时默认为空。

Java代码
  1. public String test2(@CookieValue(value=”JSESSIONID”, defaultValue=””) Cookie sessionId)

传入参数类型也可以是javax.servlet.http.Cookie类型。

 

[email protected][email protected],含义一样。

[email protected]

@[email protected]理方法的参数上。

Java代码
  1. @RequestMapping(value=”/header”)
  2. public String test(
  3.     [email protected](“User-Agent”) String userAgent,
  4.     [email protected](value=”Accept”) String[] accepts)

如上配置将自动将请求头“User-Agent”值入参到userAgent参数上,并将“Accept”请求头值入参到accepts参数上。测试代码在HeaderValueTypeController中。

 

@[email protected],含义一样。

[email protected]

@ModelAttribute一个具有如下三个作用:

①绑定请求参数到命令对象:放在功能处理方法的入参上时,用于将多个请求参数绑定到一个命令对象,从而简化绑定流程,而且自动暴露为模型数据用于视图页面展示时使用;

②暴露表单引用对象为模型数据:放在处理器的一般方法(非功能处理方法)上时,是为表单准备要展示的表单引用对象,如注册时需要选择的所在城市等,而且在执行功能处理方法(@RequestMapping注解的方法)之前,自动添加到模型对象中,用于视图页面展示时使用;

[email protected]:放在功能处理方法的返回值上时,是暴露功能处理方法的返回值为模型数据,用于视图页面展示时使用。

 

一、绑定请求参数到命令对象

如用户登录,我们需要捕获用户登录的请求参数(用户名、密码)并封装为用户对象,[email protected]我们的命令对象。

Java代码
  1. public String test1(@ModelAttribute(“user”) UserModel user)

和6.6.1一节中的五、命令/表单对象功能一样。只是[email protected](“user”),它的作用是将该绑定 的命令对象以“user”为名称添加到模型对象中供视图页面展示使用。我们此时可以在视图页面使用${user.username}来获取绑定的命令对象 的属性。

 

绑定请求参数到命令对象支持对象图导航式的绑定,如请求参数包含“?username=zhang&password=123&workInfo.city=bj”自动绑定到user中的workInfo属性的city属性中。

Java代码
  1. @RequestMapping(value=”/model2/{username}”)
  2. public String test2(@ModelAttribute(“model”) DataBinderTestModel model) {

DataBinderTestModel相关模型请从第三章拷贝过来,请求参数到命令对象的绑定规则详见【4.16.1、数据绑定】一 节,URI模板变量也能自动绑定到命令对象中,当你请求的URL中包含“bool=yes& schooInfo.specialty=computer&hobbyList[0]=program& hobbyList[1]=music&map[key1]=value1&map[key2]=value2& state=blocked”会自动绑定到命令对象上。

 

当URI模板变量和请求参数同名时,URI模板变量具有高优先权。

 

二、暴露表单引用对象为模型数据

Java代码
  1. @ModelAttribute(“cityList”)
  2. public List<String> cityList() {
  3.    return Arrays.asList(“北京”, “山东”);
  4. }

如上代码会在执行功能处理方法之前执行,并将其自动添加到模型对象中,在功能处理方法中调用Model 入参的containsAttribute(“cityList”)将会返回true。

Java代码
  1. @ModelAttribute(“user”)  //①
  2. public UserModel getUser(@RequestParam(value=”username”, defaultValue=””) String username) {
  3. //TODO 去数据库根据用户名查找用户对象
  4. UserModel user = new UserModel();
  5. user.setRealname(“zhang”);
  6.     return user;
  7. }

如你要修改用户资料时一般需要根据用户的编号/用户名查找用户来进行编辑,此时可以通过如上代码查找要编辑的用户。

也可以进行一些默认值的处理。

Java代码
  1. @RequestMapping(value=”/model1″) //②
  2. public String test1(@ModelAttribute(“user”) UserModel user, Model model)

此处我们看到①和②有同名的命令对象,那Spring Web MVC内部如何处理的呢:

([email protected],准备视图展示时所需要的模型数据;@[email protected]则一样,[email protected]

[email protected][email protected]对象,如果有直接使用,如果没有通过反射创建一个,因此②处的user将使用①处返回的命令对象。即②处的user等于①处的user。

 

[email protected]

Java代码
  1. [email protected](“user2”) UserModel test3(@ModelAttribute(“user2”) UserModel user)

大家可以看到返回值类型是命令对象类型,[email protected](“user2”)注解,此时会暴露返回值到模型数据(名字为 user2)中供视图展示使用。那哪个视图应该展示呢?此时Spring Web MVC会根据RequestToViewNameTranslator进行逻辑视图名的翻译,详见【4.15.5、 RequestToViewNameTranslator】一节。

 

此时又有问题了,@RequestMapping注解方法的入参user暴露到模型数据中的名字也是user2,其实我们能猜到:

[email protected]@[email protected]令对象。

 

四、匿名绑定命令参数

Java代码
  1. public String test4(@ModelAttribute UserModel user, Model model)
  2. public String test5(UserModel user, Model model)

此时我们没有为命令对象提供暴露到模型数据中的名字,此时的名字是什么呢?Spring Web MVC自动将简单类名(首字母小写)作为名字暴露,如“cn.javass.chapter6.model.UserModel”暴露的名字为“userModel”。

Java代码
  1. [email protected]<String> test6()
  2. [email protected]<UserModel> test7()

对于集合类型(Collection接口的实现者们,包括数组),生成的模型对象属性名为“简单类名(首字母小写)”+“List”,如 List<String>生成的模型对象属性名为“stringList”,List<UserModel>生成的模型对象属性 名为“userModelList”。

 

其他情况一律都是使用简单类名(首字母小写)作为模型对象属性名,如Map<String, UserModel>类型的模型对象属性名为“map”。

[email protected]

有时候我们需要在多次请求之间保持数据,一般情况需要我们明确的调用HttpSession的API来存取会话数据,如多步骤提交的表单。Spring Web [email protected]数据。

Java代码
  1. [email protected]
  2. @SessionAttributes(value = {“user”})    //①
  3. public class SessionAttributeController
  4.  
  5. [email protected]
  6. @ModelAttribute(“user”)    //②
  7. public UserModel initUser()
  8.  
  9. [email protected]@ModelAttribute注解的参数进行命令对象的绑定
  10. @RequestMapping(“/session1”)   //③
  11. public String session1(@ModelAttribute(“user”) UserModel user)
  12.  
  13. //4、通过SessionStatus的setComplete()[email protected]
  14. @RequestMapping(“/session2”)   //③
  15. public String session(@ModelAttribute(“user”) UserModel user, SessionStatus status) {
  16.    if(true) { //④
  17.        status.setComplete();
  18.    }
  19.    return “success”;
  20. }

@SessionAttributes(value = {“user”})含义:

@SessionAttributes(value = {“user”}) 标识将模型数据中的名字为“user” 的对象存储到会话中(默认HttpSession),此处value指定将模型数据中的哪些 数据(名字进行匹配)存储到会话中,此外还有一个types属性表示模型数据中的哪些类型的对象存储到会话范围内,如果同时指定value和types属 性则那些名字和类型都匹配的对象才能存储到会话范围内。

 

[email protected]

[email protected]对象放入到模型数据中;

[email protected]:如果模型数据中包含同名的数据,[email protected] 表单引用数据,而是使用①步骤中的会话数据;如果模型数据中不包含同名的数据,[email protected]数据 中;

[email protected][email protected][email protected],如果有直接使用,否则通过反射创建一个;并将请求参数绑定到该命令对象;

此处需要注意:[email protected],③步骤一定是从模型对象中取得同名的命令对象,如果模型数据中 不存在将抛出HttpSessionRequiredException Expected session attribute ‘user’(Spring3.1)

或HttpSessionRequiredException Session attribute ‘user’ required – not found in session(Spring3.0)异常。

④ 如果会话可以销毁了,如多步骤提交表单的最后一步,此时可以调用SessionStatus对象的setComplete()标识当前会话 [email protected][email protected]理会话数据。

 

我们通过Spring Web MVC的源代码验证一下吧,此处我们分析的是Spring3.1的RequestMappingHandlerAdapter,读者可以自行验证 Spring3.0的AnnotationMethodHandlerAdapter,流程一样:

(1、RequestMappingHandlerAdapter.invokeHandlerMethod

Java代码
  1. //1、RequestMappingHandlerAdapter首先调用ModelFactory的initModel方法准备模型数据:
  2. modelFactory.initModel(webRequest, mavContainer, requestMappingMethod);
  3. [email protected]
  4. requestMappingMethod.invokeAndHandle(webRequest, mavContainer);
  5. //3、更新/合并模型数据
  6. modelFactory.updateModel(webRequest, mavContainer);

(2、ModelFactory.initModel

Java代码
  1. Map<String, ?> attributesInSession =this.sessionAttributesHandler.retrieveAttributes(request);
  2. [email protected]模型数据中
  3. mavContainer.mergeAttributes(attributesInSession);
  4. [email protected]
  5. invokeModelAttributeMethods(request, mavContainer);
  6. [email protected]相关的会话对象,不包含抛出异常
  7. for (String name : findSessionAttributeArguments(handlerMethod)) {
  8.    if (!mavContainer.containsAttribute(name)) {
  9.       [email protected]话对象
  10.       [email protected](“user”, new UserModel());
  11.        Object value = this.sessionAttributesHandler.retrieveAttribute(request, name);
  12.        if (value == null) {
  13.            throw new HttpSessionRequiredException(“Expected session attribute ‘” + name +”‘”);
  14.        }
  15.        mavContainer.addAttribute(name, value);
  16. }

(3、ModelFactory.invokeModelAttributeMethods

Java代码
  1. for (InvocableHandlerMethod attrMethod : this.attributeMethods) {
  2.    String modelName = attrMethod.getMethodAnnotation(ModelAttribute.class).value();
  3.    //1.2.1、如果模型数据中包含同名数据则不再添加
  4.    if (mavContainer.containsAttribute(modelName)) {
  5.        continue;
  6.    }
  7.   [email protected]到模型数据中,此处省略实现代码
  8. }

(4、requestMappingMethod.invokeAndHandle 调用功能处理方法,此处省略

(5、ModelFactory.updateMode 更新模型数据

Java代码
  1. //3.1、如果会话被标识为完成,[email protected]
  2. if (mavContainer.getSessionStatus().isComplete()){
  3.    this.sessionAttributesHandler.cleanupAttributes(request);
  4. }
  5. //3.2、如果会话没有完成,[email protected]到会话中
  6. else {
  7.    this.sessionAttributesHandler.storeAttributes(request, mavContainer.getModel());
  8. }
  9. //省略部分代码

[email protected][email protected]nAttributeController中。

 

另外cn.javass.chapter6.web.controller.paramtype.WizardFormController是 一个类似于【4.11、AbstractWizardFormController】中介绍的多步骤表单实现,此处不再贴代码,多步骤提交表单需要考虑会 话超时问题,这种方式可能对用户不太友好,我们可以采取隐藏表单(即当前步骤将其他步骤的表单隐藏)或表单数据存数据库(每步骤更新下数据库数据)等方案 解决。

[email protected]

@[email protected]法的参数上。

Java代码
  1. public String test(@Value(“#{systemProperties[‘java.vm.version’]}”) String jvmVersion)

到此数据绑定我们就介绍完了,对于没有介绍的方法参数和注解(包括自定义注解)在后续章节进行介绍。

Tagged: ,

Comments are closed.