码迷,mamicode.com
首页 > 编程语言 > 详细

SpringMvc之参数绑定注解详解

时间:2017-03-19 14:04:30      阅读:366      评论:0      收藏:0      [点我收藏+]

标签:ati   格式化   jaxb   code   服务器端   from   tin   UI   title   

引言:

前段时间项目中用到了REST风格来开发程序,但是当用POST、PUT模式提交数据时,发现服务器端接受不到提交的数据(服务器端参数绑定没有加任何注解),查看了提交方式为application/json, 而且服务器端通过request.getReader() 打出的数据里确实存在浏览器提交的数据。为了找出原因,便对参数绑定(@RequestParam、 @RequestBody、 @RequestHeader 、 @PathVariable)进行了研究,同时也看了一下HttpMessageConverter的相关内容,在此一并总结。

 

简介:

@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

RequestMapping注解有六个属性,下面我们把她分成三类进行说明。

1、 value, method;

value:     指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);

     当之设置value一个属性时,value可以省略不写,当有其他属性时则需要加上进行区分,如下图:

技术分享

 

method:  指定请求的method类型, GET、POST、PUT、DELETE等;

 

2、 consumes,produces;

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

 

3、 params,headers;

params: 指定request中必须包含某些参数值是,才让该方法处理。

headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

 

示例:

1、value  / method 示例

默认RequestMapping("....str...")即为value的值;

 1 @Controller  
 2 @RequestMapping("/appointments")  
 3 public class AppointmentsController {  
 4   
 5     private final AppointmentBook appointmentBook;  
 6       
 7     @Autowired  
 8     public AppointmentsController(AppointmentBook appointmentBook) {  
 9         this.appointmentBook = appointmentBook;  
10     }  
11   
12     @RequestMapping(method = RequestMethod.GET)  
13     public Map<String, Appointment> get() {  
14         return appointmentBook.getAppointmentsForToday();  
15     }  
16   
17     @RequestMapping(value="/{day}", method = RequestMethod.GET)  
18     public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {  
19         return appointmentBook.getAppointmentsForDay(day);  
20     }  
21   
22     @RequestMapping(value="/new", method = RequestMethod.GET)  
23     public AppointmentForm getNewForm() {  
24         return new AppointmentForm();  
25     }  
26   
27     @RequestMapping(method = RequestMethod.POST)  
28     public String add(@Valid AppointmentForm appointment, BindingResult result) {  
29         if (result.hasErrors()) {  
30             return "appointments/new";  
31         }  
32         appointmentBook.addAppointment(appointment);  
33         return "redirect:/appointments";  
34     }  
35 }  

value的uri值为以下三类:

A) 可以指定为普通的具体值;

B)  可以指定为含有某变量的一类值(URI Template Patterns with Path Variables);

C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);

 

example B)

1 @RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)  
2 public String findOwner(@PathVariable String ownerId, Model model) {  
3   Owner owner = ownerService.findOwner(ownerId);    
4   model.addAttribute("owner", owner);    
5   return "displayOwner";   
6 }  

example C)

1 @RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}")  
2   public void handle(@PathVariable String version, @PathVariable String extension) {      
3     // ...  
4   }  
5 }  

2 consumes、produces 示例

cousumes的样例:

1 @Controller  
2 @RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")  
3 public void addPet(@RequestBody Pet pet, Model model) {      
4     // implementation omitted  
5 }  

方法仅处理request Content-Type为“application/json”类型的请求。

 

produces的样例:

1 @Controller  
2 @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")  
3 @ResponseBody  
4 public Pet getPet(@PathVariable String petId, Model model) {      
5     // implementation omitted  
6 }  

方法仅处理request请求中Accept头中包含了"application/json"的请求,同时暗示了返回的内容类型为application/json;

 

3 params、headers 示例

params的样例:

1 @Controller  
2 @RequestMapping("/owners/{ownerId}")  
3 public class RelativePathUriTemplateController {  
4   
5   @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")  
6   public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
7     // implementation omitted  
8   }  
9 }  

仅处理请求中包含了名为“myParam”,值为“myValue”的请求;

 

headers的样例:

1 @Controller  
2 @RequestMapping("/owners/{ownerId}")  
3 public class RelativePathUriTemplateController {  
4   
5 @RequestMapping(value = "/pets", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")  
6   public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
7     // implementation omitted  
8   }  
9 }  

仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/”的请求;

 

简介:

handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类:(主要讲解常用类型)

A、处理requet uri 部分(这里指uri template中variable,不含queryString部分)的注解:   @PathVariable;

B、处理request header部分的注解:   @RequestHeader, @CookieValue;

C、处理request body部分的注解:@RequestParam,  @RequestBody;

D、处理attribute类型是注解: @SessionAttributes, @ModelAttribute;

 

1、 @PathVariable 

当使用@RequestMapping URI template 样式映射时, 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

示例代码:

[java] view plaincopy
 
  1. @Controller  
  2. @RequestMapping("/owners/{ownerId}")  
  3. public class RelativePathUriTemplateController {  
  4.   
  5.   @RequestMapping("/pets/{petId}")  
  6.   public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
  7.     // implementation omitted  
  8.   }  
  9. }  
技术分享

上面代码把URI template 中变量 ownerId的值和petId的值,绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致,需要在@PathVariable("name")指定uri template中的名称。

2、 @RequestHeader、@CookieValue

@RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。

示例代码:

这是一个Request 的header部分:

[plain] view plaincopy
 
  1. Host                    localhost:8080  
  2. Accept                  text/html,application/xhtml+xml,application/xml;q=0.9  
  3. Accept-Language         fr,en-gb;q=0.7,en;q=0.3  
  4. Accept-Encoding         gzip,deflate  
  5. Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7  
  6. Keep-Alive              300  
技术分享

 

[java] view plaincopy
 
  1. @RequestMapping("/displayHeaderInfo.do")  
  2. public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,  
  3.                               @RequestHeader("Keep-Alive") long keepAlive)  {  
  4.   
  5.   //...  
  6.   
  7. }  
技术分享

上面的代码,把request header部分的 Accept-Encoding的值,绑定到参数encoding上了, Keep-Alive header的值绑定到参数keepAlive上。

 

@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。

例如有如下Cookie值:

[java] view plaincopy
 
  1. JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  
技术分享

参数绑定的代码:

[java] view plaincopy
 
  1. @RequestMapping("/displayHeaderInfo.do")  
  2. public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {  
  3.   
  4.   //...  
  5.   
  6. }  
技术分享

即把JSESSIONID的值绑定到参数cookie上。

 

3、@RequestParam, @RequestBody

@RequestParam

A) 常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况( String--> 简单类型的转换操作由ConversionService配置的转换器来完成);因为使用request.getParameter()方式获取参数,所以可以处理get 方式中queryString的值,也可以处理post方式中 body data的值;

B)用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容,提交方式GET、POST;

C) 该注解有两个属性: value、required; value用来指定要传入值的id名称,required用来指示参数是否必须绑定;

示例代码:

[java] view plaincopy
 
  1. @Controller  
  2. @RequestMapping("/pets")  
  3. @SessionAttributes("pet")  
  4. public class EditPetForm {  
  5.   
  6.     // ...  
  7.   
  8.     @RequestMapping(method = RequestMethod.GET)  
  9.     public String setupForm(@RequestParam("petId") int petId, ModelMap model) {  
  10.         Pet pet = this.clinic.loadPet(petId);  
  11.         model.addAttribute("pet", pet);  
  12.         return "petForm";  
  13.     }  
  14.   
  15.     // ...  
技术分享



@RequestBody

该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容,例如application/json, application/xml等;

它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body,然后绑定到相应的bean上的。

因为配置有FormHttpMessageConverter,所以也可以用来处理 application/x-www-form-urlencoded的内容,处理完的结果放在一个MultiValueMap<String, String>里,这种情况在某些特殊需求下使用,详情查看FormHttpMessageConverter api;

示例代码:

[java] view plaincopy
 
  1. @RequestMapping(value = "/something", method = RequestMethod.PUT)  
  2. public void handle(@RequestBody String body, Writer writer) throws IOException {  
  3.   writer.write(body);  
  4. }  
技术分享

 

4、@SessionAttributes, @ModelAttribute

@SessionAttributes:

该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。

该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute 对象;

示例代码:

[java] view plaincopy
 
  1. @Controller  
  2. @RequestMapping("/editPet.do")  
  3. @SessionAttributes("pet")  
  4. public class EditPetForm {  
  5.     // ...  
  6. }  
技术分享



@ModelAttribute

该注解有两个用法,一个是用于方法上,一个是用于参数上;

用于方法上时:  通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;

用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:

A) @SessionAttributes 启用的attribute 对象上;

B) @ModelAttribute 用于方法上时指定的model对象;

C) 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。

 

用到方法上@ModelAttribute的示例代码:

[java] view plaincopy
 
  1. // Add one attribute  
  2. // The return value of the method is added to the model under the name "account"  
  3. // You can customize the name via @ModelAttribute("myAccount")  
  4.   
  5. @ModelAttribute  
  6. public Account addAccount(@RequestParam String number) {  
  7.     return accountManager.findAccount(number);  
  8. }  
技术分享


这种方式实际的效果就是在调用@RequestMapping的方法之前,为request对象的model里put(“account”, Account);

 

用在参数上的@ModelAttribute示例代码:

[java] view plaincopy
 
  1. @RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)  
  2. public String processSubmit(@ModelAttribute Pet pet) {  
  3.      
  4. }  
技术分享

首先查询 @SessionAttributes有无绑定的Pet对象,若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象,若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。

 

简介:              

@RequestBody

作用:

      i) 该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上;

      ii) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机:

A) GET、POST方式提时, 根据request header Content-Type的值来判断:

  •     application/x-www-form-urlencoded, 可选(即非必须,因为这种情况的数据@RequestParam, @ModelAttribute也可以处理,当然@RequestBody也能处理);
  •     multipart/form-data, 不能处理(即使用@RequestBody不能处理这种格式的数据);
  •     其他格式, 必须(其他格式包括application/json, application/xml等。这些格式的数据,必须使用@RequestBody来处理);

B) PUT方式提交时, 根据request header Content-Type的值来判断:

  •     application/x-www-form-urlencoded, 必须;
  •     multipart/form-data, 不能处理;
  •     其他格式, 必须;

说明:request的body部分的数据编码格式由header部分的Content-Type指定;

@ResponseBody

作用:

      该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。

使用时机:

      返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;

 

 

HttpMessageConverter

[java] view plaincopy
 
  1. <span style="font-family:Microsoft YaHei;">/** 
  2.  * Strategy interface that specifies a converter that can convert from and to HTTP requests and responses. 
  3.  * 
  4.  * @author Arjen Poutsma 
  5.  * @author Juergen Hoeller 
  6.  * @since 3.0 
  7.  */  
  8. public interface HttpMessageConverter<T> {  
  9.   
  10.     /** 
  11.      * Indicates whether the given class can be read by this converter. 
  12.      * @param clazz the class to test for readability 
  13.      * @param mediaType the media type to read, can be {@code null} if not specified. 
  14.      * Typically the value of a {@code Content-Type} header. 
  15.      * @return {@code true} if readable; {@code false} otherwise 
  16.      */  
  17.     boolean canRead(Class<?> clazz, MediaType mediaType);  
  18.   
  19.     /** 
  20.      * Indicates whether the given class can be written by this converter. 
  21.      * @param clazz the class to test for writability 
  22.      * @param mediaType the media type to write, can be {@code null} if not specified. 
  23.      * Typically the value of an {@code Accept} header. 
  24.      * @return {@code true} if writable; {@code false} otherwise 
  25.      */  
  26.     boolean canWrite(Class<?> clazz, MediaType mediaType);  
  27.   
  28.     /** 
  29.      * Return the list of {@link MediaType} objects supported by this converter. 
  30.      * @return the list of supported media types 
  31.      */  
  32.     List<MediaType> getSupportedMediaTypes();  
  33.   
  34.     /** 
  35.      * Read an object of the given type form the given input message, and returns it. 
  36.      * @param clazz the type of object to return. This type must have previously been passed to the 
  37.      * {@link #canRead canRead} method of this interface, which must have returned {@code true}. 
  38.      * @param inputMessage the HTTP input message to read from 
  39.      * @return the converted object 
  40.      * @throws IOException in case of I/O errors 
  41.      * @throws HttpMessageNotReadableException in case of conversion errors 
  42.      */  
  43.     T read(Class<? extends T> clazz, HttpInputMessage inputMessage)  
  44.             throws IOException, HttpMessageNotReadableException;  
  45.   
  46.     /** 
  47.      * Write an given object to the given output message. 
  48.      * @param t the object to write to the output message. The type of this object must have previously been 
  49.      * passed to the {@link #canWrite canWrite} method of this interface, which must have returned {@code true}. 
  50.      * @param contentType the content type to use when writing. May be {@code null} to indicate that the 
  51.      * default content type of the converter must be used. If not {@code null}, this media type must have 
  52.      * previously been passed to the {@link #canWrite canWrite} method of this interface, which must have 
  53.      * returned {@code true}. 
  54.      * @param outputMessage the message to write to 
  55.      * @throws IOException in case of I/O errors 
  56.      * @throws HttpMessageNotWritableException in case of conversion errors 
  57.      */  
  58.     void write(T t, MediaType contentType, HttpOutputMessage outputMessage)  
  59.             throws IOException, HttpMessageNotWritableException;  
  60.   
  61. }  
  62. </span>  
技术分享

该接口定义了四个方法,分别是读取数据时的 canRead(), read() 和 写入数据时的canWrite(), write()方法。

在使用 <mvc:annotation-driven />标签配置时,默认配置了RequestMappingHandlerAdapter(注意是RequestMappingHandlerAdapter不是AnnotationMethodHandlerAdapter,详情查看spring 3.1 document “16.14 Configuring Spring MVC”章节),并为他配置了一下默认的HttpMessageConverter:

 

[java] view plaincopy
 
  1. ByteArrayHttpMessageConverter converts byte arrays.  
  2.   
  3. StringHttpMessageConverter converts strings.  
  4.   
  5. ResourceHttpMessageConverter converts to/from org.springframework.core.io.Resource for all media types.  
  6.   
  7. SourceHttpMessageConverter converts to/from a javax.xml.transform.Source.  
  8.   
  9. FormHttpMessageConverter converts form data to/from a MultiValueMap<String, String>.  
  10.   
  11. Jaxb2RootElementHttpMessageConverter converts Java objects to/from XML — added if JAXB2 is present on the classpath.  
  12.   
  13. MappingJacksonHttpMessageConverter converts to/from JSON — added if Jackson is present on the classpath.  
  14.   
  15. AtomFeedHttpMessageConverter converts Atom feeds — added if Rome is present on the classpath.  
  16.   
  17. RssChannelHttpMessageConverter converts RSS feeds — added if Rome is present on the classpath.  
技术分享

 

ByteArrayHttpMessageConverter: 负责读取二进制格式的数据和写出二进制格式的数据;

StringHttpMessageConverter:   负责读取字符串格式的数据和写出二进制格式的数据;

 

ResourceHttpMessageConverter:负责读取资源文件和写出资源文件数据; 

FormHttpMessageConverter:       负责读取form提交的数据(能读取的数据格式为 application/x-www-form-urlencoded,不能读取multipart/form-data格式数据);负责写入application/x-www-from-urlencoded和multipart/form-data格式的数据;

 

MappingJacksonHttpMessageConverter:  负责读取和写入json格式的数据;

 

SouceHttpMessageConverter:                   负责读取和写入 xml 中javax.xml.transform.Source定义的数据;

Jaxb2RootElementHttpMessageConverter:  负责读取和写入xml 标签格式的数据;

 

AtomFeedHttpMessageConverter:              负责读取和写入Atom格式的数据;

RssChannelHttpMessageConverter:           负责读取和写入RSS格式的数据;

 

当使用@RequestBody和@ResponseBody注解时,RequestMappingHandlerAdapter就使用它们来进行读取或者写入相应格式的数据。

 

HttpMessageConverter匹配过程:

@RequestBody注解时: 根据Request对象header部分的Content-Type类型,逐一匹配合适的HttpMessageConverter来读取数据;

spring 3.1源代码如下:

[java] view plaincopy
 
  1. <span style="font-family:Microsoft YaHei;">private Object readWithMessageConverters(MethodParameter methodParam, HttpInputMessage inputMessage, Class paramType)  
  2.             throws Exception {  
  3.   
  4.         MediaType contentType = inputMessage.getHeaders().getContentType();  
  5.         if (contentType == null) {  
  6.             StringBuilder builder = new StringBuilder(ClassUtils.getShortName(methodParam.getParameterType()));  
  7.             String paramName = methodParam.getParameterName();  
  8.             if (paramName != null) {  
  9.                 builder.append(‘ ‘);  
  10.                 builder.append(paramName);  
  11.             }  
  12.             throw new HttpMediaTypeNotSupportedException(  
  13.                     "Cannot extract parameter (" + builder.toString() + "): no Content-Type found");  
  14.         }  
  15.   
  16.         List<MediaType> allSupportedMediaTypes = new ArrayList<MediaType>();  
  17.         if (this.messageConverters != null) {  
  18.             for (HttpMessageConverter<?> messageConverter : this.messageConverters) {  
  19.                 allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes());  
  20.                 if (messageConverter.canRead(paramType, contentType)) {  
  21.                     if (logger.isDebugEnabled()) {  
  22.                         logger.debug("Reading [" + paramType.getName() + "] as \"" + contentType  
  23.                                 +"\" using [" + messageConverter + "]");  
  24.                     }  
  25.                     return messageConverter.read(paramType, inputMessage);  
  26.                 }  
  27.             }  
  28.         }  
  29.         throw new HttpMediaTypeNotSupportedException(contentType, allSupportedMediaTypes);  
  30.     }</span>  
技术分享

@ResponseBody注解时: 根据Request对象header部分的Accept属性(逗号分隔),逐一按accept中的类型,去遍历找到能处理的HttpMessageConverter;

源代码如下:

[java] view plaincopy
 
  1. <span style="font-family:Microsoft YaHei;">private void writeWithMessageConverters(Object returnValue,  
  2.                 HttpInputMessage inputMessage, HttpOutputMessage outputMessage)  
  3.                 throws IOException, HttpMediaTypeNotAcceptableException {  
  4.             List<MediaType> acceptedMediaTypes = inputMessage.getHeaders().getAccept();  
  5.             if (acceptedMediaTypes.isEmpty()) {  
  6.                 acceptedMediaTypes = Collections.singletonList(MediaType.ALL);  
  7.             }  
  8.             MediaType.sortByQualityValue(acceptedMediaTypes);  
  9.             Class<?> returnValueType = returnValue.getClass();  
  10.             List<MediaType> allSupportedMediaTypes = new ArrayList<MediaType>();  
  11.             if (getMessageConverters() != null) {  
  12.                 for (MediaType acceptedMediaType : acceptedMediaTypes) {  
  13.                     for (HttpMessageConverter messageConverter : getMessageConverters()) {  
  14.                         if (messageConverter.canWrite(returnValueType, acceptedMediaType)) {  
  15.                             messageConverter.write(returnValue, acceptedMediaType, outputMessage);  
  16.                             if (logger.isDebugEnabled()) {  
  17.                                 MediaType contentType = outputMessage.getHeaders().getContentType();  
  18.                                 if (contentType == null) {  
  19.                                     contentType = acceptedMediaType;  
  20.                                 }  
  21.                                 logger.debug("Written [" + returnValue + "] as \"" + contentType +  
  22.                                         "\" using [" + messageConverter + "]");  
  23.                             }  
  24.                             this.responseArgumentUsed = true;  
  25.                             return;  
  26.                         }  
  27.                     }  
  28.                 }  
  29.                 for (HttpMessageConverter messageConverter : messageConverters) {  
  30.                     allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes());  
  31.                 }  
  32.             }  
  33.             throw new HttpMediaTypeNotAcceptableException(allSupportedMediaTypes);  
  34.         }</span>  
技术分享

 

补充:

MappingJacksonHttpMessageConverter 调用了 objectMapper.writeValue(OutputStream stream, Object)方法,使用@ResponseBody注解返回的对象就传入Object参数内。若返回的对象为已经格式化好的json串时,不使用@RequestBody注解,而应该这样处理:
1、response.setContentType("application/json; charset=UTF-8");
2、response.getWriter().print(jsonStr);
直接输出到body区,然后的视图为void。

SpringMvc之参数绑定注解详解

标签:ati   格式化   jaxb   code   服务器端   from   tin   UI   title   

原文地址:http://www.cnblogs.com/FrankLei/p/6579843.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!