一、以实例来看springmvc各种参数绑定方式
先定义个dto类:
public class RestInDto implements Serializable { private static final long serialVersionUID = -5461373449802431627L; private String userName; private BigDecimal salary; private boolean isVip; private int id; ...... }
1.基本数据类型
url:http://127.0.0.1:8080/springtry/rest/getdatabinder?userName=中国龙&salary=12&id=0&vip=false
@RequestMapping(value = "/getdatabinder", method = RequestMethod.GET) public RestInDto testDataBinder(RestInDto restInDto){ Map<String,Object> m=new HashMap<String,Object>(); return restInDto; }
2.基本复合对象类型
public class CusDto { private String userName; ... } public class RestInDto implements Serializable { private static final long serialVersionUID = -5461373449802431627L; private String userName; private BigDecimal salary; private boolean isVip; private int id; private CusDto anotherDto; ... }
url:http://127.0.0.1:8080/springtry/rest/getdatabinder?userName=中国龙&salary=12&id=0&vip=false&anotherDto.userName=中国风&vip=false
@RequestMapping(value = "/getdatabinder", method = RequestMethod.GET) public RestInDto testDataBinder(RestInDto restInDto){ Map<String,Object> m=new HashMap<String,Object>(); return restInDto; }
3.基本类型数组
标红部分相同就可以了
url:http://127.0.0.1:8080/springtry/rest/getdatabinderarr?restInDto=1&restInDto=2
@RequestMapping(value = "/getdatabinderarr", method = RequestMethod.GET) public String[] testDataBinder(String[] restInDto){ Map<String,Object> m=new HashMap<String,Object>(); return restInDto; }
另外:如果是ajax的话ajax,客户端 data:{restInDto:[]},服务端:
public String[] testDataBinder(@RequestParam(value="restInDto[]")String[] restInDto)
4.基本类型或由基本类型构成的自定义对象list
不能在controller方法中直接使用List<RestInDto>,而应该将List<RestInDto>作为另一个类的字段使用
public class RestInListDto { private List<RestInDto> restIns; ... }
url:http://127.0.0.1:8080/springtry/rest/getdatabinderlist?restIns[0].userName=中国&restIns[0].salary=12&restIns[0].id=0&restIns[0].vip=false
@RequestMapping(value = "/getdatabinderlist", method = RequestMethod.GET) public RestInListDto testDataBinder(RestInListDto restInListDto){ Map<String,Object> m=new HashMap<String,Object>(); return restInListDto; }
5.基本类型或由基本类型构成的自定义对象set
与list类似,只是要定义构造函数并在其中构建set
public class RestInSetDto { private Set<RestInDto> restIns=new HashSet<RestInDto>(); public RestInSetDto() { this.restIns.add(new RestInDto()); } ... }
url:http://127.0.0.1:8080/springtry/rest/getdatabinderset?restIns[0].userName=中国&restIns[0].salary=12&restIns[0].id=0&restIns[0].vip=false
@RequestMapping(value = "/getdatabinderset", method = RequestMethod.GET) public RestInSetDto testDataBinder(RestInSetDto restInSetDto){ Map<String,Object> m=new HashMap<String,Object>(); return restInListDto; }
ps:set有个限制,下标不能大于size()值
6.Map
public class RestInMapDto { private Map<String,RestInDto> restIns; ... }
url:http://127.0.0.1:8080/springtry/rest/getdatabindermap?
restIns[‘x‘].userName=中国龙&restIns[‘x‘].salary=12&restIns[‘x‘].id=0&restIns[‘x‘].vip=false
@RequestMapping(value = "/getdatabindermap", method = RequestMethod.GET) public RestInMapDto testDataBinder(RestInMapDto restInMapDto){ Map<String,Object> m=new HashMap<String,Object>(); return restInMapDto; }
二、再来看看参数绑定常用的注解
根据它们处理的Request的不同内容部分分为四类:
- 处理request uri 部分(这里指uri template中variable,不含queryString部分)的注解:@PathVariable;
- 处理request header部分的注解: @RequestHeader, @CookieValue;
- 处理request body部分的注解:@RequestParam, @RequestBody;
- 处理attribute类型的注解: @SessionAttributes, @ModelAttribute;
1. @PathVariable,当使用@RequestMapping URI template 样式映射时, 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
@Controller @RequestMapping("/owners/{ownerId}") public class RelativePathUriTemplateController { @RequestMapping("/pets/{petId}") public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) { // implementation omitted } }
上面代码把URI template 中变量 ownerId的值和petId的值,绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致,需要在@PathVariable("name")指定uri template中的名称
[email protected]、@CookieValue
@RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。
Host localhost:8080 Accept text/html,application/xhtml+xml,application/xml;q=0.9 Accept-Language fr,en-gb;q=0.7,en;q=0.3 Accept-Encoding gzip,deflate Accept-Charset ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive 300
@RequestMapping("/displayHeaderInfo.do") public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding, @RequestHeader("Keep-Alive") long keepAlive) { //... }
上面的代码,把request header部分的 Accept-Encoding的值,绑定到参数encoding上了, Keep-Alive header的值绑定到参数keepAlive上
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上
[email protected], @RequestBody
@RequestParam
- 常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况( String--> 简单类型的转换操作由ConversionService配置的转换器来完成);因为使用request.getParameter()方式获取参数,所以可以处理get 方式中queryString的值,也可以处理post方式中 body data的值;
- 用来处理Content-Type: 为
application/x-www-form-urlencoded
编码的内容,提交方式GET、POST; - 该注解有两个属性: value、required; value用来指定要传入值的id名称,required用来指示参数是否必须绑定
@RequestBody,用于读取Request请求的body部分数据,使用系统默认配置RequestMappingHandlerAdapter的HttpMessageConverter进行解析,再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上
- post方式,解常用来处理Content-Type: 不是
application/x-www-form-urlencoded
编码的内容,例如application/json, application/xml等;
因为配置有FormHttpMessageConverter,所以也可以用来处理 application/x-www-form-urlencoded
的内容,处理完的结果放在一个MultiValueMap<String, String>里,这种情况在某些特殊需求下使用;
不能处理multipart/form-data
- put方式,只能处理application/x-www-form-urlencoded或application/json, application/xml等,不能处理multipart/form-data
[email protected], @ModelAttribute
@SessionAttributes:
该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。
该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute 对象
@ModelAttribute
该注解有两个用法,一个是用于方法上,一个是用于参数上;
用于方法上时: 通常用来在处理@RequestMapping方法之前,为请求request对象绑定需要从后台查询的model;
用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上,要绑定的值来源于:
- @SessionAttributes 启用的attribute 对象上;
- @ModelAttribute 用于方法上时指定的model对象;
- 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中[email protected]
作用:
该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。
使用时机:返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;
从前面第一部分的绑定方式看, 并没有给定参数注解,但达到相同的效果,这是因为RequestMappingHandlerAdapter在方法的参数在不给定参数注解的情况下:
若要绑定的是简单类型: 调用@RequestParam来处理
若要绑定的是复杂对象类型: 调用@ModelAttribute来处理